CosmosPrimitiveCollectionBuilderExtensions.xml

<Type Name="CosmosPrimitiveCollectionBuilderExtensions" FullName="Microsoft.EntityFrameworkCore.CosmosPrimitiveCollectionBuilderExtensions">
  <TypeSignature Language="C#" Value="public static class CosmosPrimitiveCollectionBuilderExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit CosmosPrimitiveCollectionBuilderExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.CosmosPrimitiveCollectionBuilderExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module CosmosPrimitiveCollectionBuilderExtensions" />
  <TypeSignature Language="F#" Value="type CosmosPrimitiveCollectionBuilderExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
                Cosmos-specific extension methods for <see cref="T:Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder" />.
            </summary>
    <remarks>
                See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see>, and
                <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName="ToJsonProperty">
      <MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder ToJsonProperty (this Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder primitiveCollectionBuilder, string name);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder ToJsonProperty(class Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder primitiveCollectionBuilder, string name) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.CosmosPrimitiveCollectionBuilderExtensions.ToJsonProperty(Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder,System.String)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function ToJsonProperty (primitiveCollectionBuilder As PrimitiveCollectionBuilder, name As String) As PrimitiveCollectionBuilder" />
      <MemberSignature Language="F#" Value="static member ToJsonProperty : Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder * string -&gt; Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder" Usage="Microsoft.EntityFrameworkCore.CosmosPrimitiveCollectionBuilderExtensions.ToJsonProperty (primitiveCollectionBuilder, name)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="primitiveCollectionBuilder" Type="Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder" RefType="this" />
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="primitiveCollectionBuilder">The builder for the property being configured.</param>
        <param name="name">The name of the property.</param>
        <summary>
                Configures the property name that the property is mapped to when targeting Azure Cosmos.
            </summary>
        <returns>The same builder instance so that multiple calls can be chained.</returns>
        <remarks>
          <para>
                    If an empty string is supplied, the property will not be persisted.
                </para>
          <para>
                    See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see>, and
                    <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
                </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ToJsonProperty&lt;TProperty&gt;">
      <MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder&lt;TProperty&gt; ToJsonProperty&lt;TProperty&gt; (this Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder&lt;TProperty&gt; primitiveCollectionBuilder, string name);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder`1&lt;!!TProperty&gt; ToJsonProperty&lt;TProperty&gt;(class Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder`1&lt;!!TProperty&gt; primitiveCollectionBuilder, string name) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.CosmosPrimitiveCollectionBuilderExtensions.ToJsonProperty``1(Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder{``0},System.String)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function ToJsonProperty(Of TProperty) (primitiveCollectionBuilder As PrimitiveCollectionBuilder(Of TProperty), name As String) As PrimitiveCollectionBuilder(Of TProperty)" />
      <MemberSignature Language="F#" Value="static member ToJsonProperty : Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder&lt;'Property&gt; * string -&gt; Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder&lt;'Property&gt;" Usage="Microsoft.EntityFrameworkCore.CosmosPrimitiveCollectionBuilderExtensions.ToJsonProperty (primitiveCollectionBuilder, name)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.EntityFrameworkCore.Cosmos</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder&lt;TProperty&gt;</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="TProperty" />
      </TypeParameters>
      <Parameters>
        <Parameter Name="primitiveCollectionBuilder" Type="Microsoft.EntityFrameworkCore.Metadata.Builders.PrimitiveCollectionBuilder&lt;TProperty&gt;" RefType="this" />
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <typeparam name="TProperty">The type of the property being configured.</typeparam>
        <param name="primitiveCollectionBuilder">The builder for the property being configured.</param>
        <param name="name">The name of the property.</param>
        <summary>
                Configures the property name that the property is mapped to when targeting Azure Cosmos.
            </summary>
        <returns>The same builder instance so that multiple calls can be chained.</returns>
        <remarks>
                See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see>, and
                <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information and examples.
            </remarks>
      </Docs>
    </Member>
  </Members>
</Type>