xml/Microsoft.Azure.Cosmos/ContainerProperties.xml

<Type Name="ContainerProperties" FullName="Microsoft.Azure.Cosmos.ContainerProperties">
  <TypeSignature Language="C#" Value="public class ContainerProperties" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ContainerProperties extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.ContainerProperties" />
  <TypeSignature Language="VB.NET" Value="Public Class ContainerProperties" />
  <TypeSignature Language="F#" Value="type ContainerProperties = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
    <AssemblyVersion>3.36.0.0</AssemblyVersion>
    <AssemblyVersion>3.38.1.0</AssemblyVersion>
    <AssemblyVersion>3.39.0.0</AssemblyVersion>
    <AssemblyVersion>3.45.0.0</AssemblyVersion>
    <AssemblyVersion>3.47.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
             Represents a document container in the Azure Cosmos DB service. A container is a named logical container for documents.
             </summary>
    <remarks>
             A database may contain zero or more named containers and each container consists of zero or more JSON documents.
             Being schema-free, the documents in a container do not need to share the same structure or fields. Since containers are application resources,
             they can be authorized using either the master key or resource keys.
             </remarks>
    <altmember cref="T:Microsoft.Azure.Cosmos.UniqueKeyPolicy" />
    <example>
             The example below creates a new partitioned container with 50000 Request-per-Unit throughput.
             The partition key is the first level 'country' property in all the documents within this container.
             <code language="c#"><![CDATA[
                 Container container = await client.GetDatabase("dbName").Containers.CreateAsync("MyCollection", "/country", 50000);
                 ContainerProperties containerProperties = container.Resource;
             ]]></code></example>
    <example>
             The example below creates a new container with a custom indexing policy.
             <code language="c#"><![CDATA[
                 ContainerProperties containerProperties = new ContainerProperties("MyCollection", "/country");
                 containerProperties.IndexingPolicy.Automatic = true;
                 containerProperties.IndexingPolicy.IndexingMode = IndexingMode.Consistent;
            
                 CosmosContainerResponse containerCreateResponse = await client.GetDatabase("dbName").CreateContainerAsync(containerProperties, 50000);
                 ContainerProperties createdContainerProperties = containerCreateResponse.Container;
             ]]></code></example>
    <example>
             The example below deletes this container.
             <code language="c#"><![CDATA[
                 Container container = client.GetDatabase("dbName").Containers["MyCollection"];
                 await container.DeleteAsync();
             ]]></code></example>
    <altmember cref="T:Microsoft.Azure.Cosmos.IndexingPolicy" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ContainerProperties ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ContainerProperties.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Initializes a new instance of the <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> class for the Azure Cosmos DB service.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ContainerProperties (string id, System.Collections.Generic.IReadOnlyList&lt;string&gt; partitionKeyPaths);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, class System.Collections.Generic.IReadOnlyList`1&lt;string&gt; partitionKeyPaths) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ContainerProperties.#ctor(System.String,System.Collections.Generic.IReadOnlyList{System.String})" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (id As String, partitionKeyPaths As IReadOnlyList(Of String))" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.ContainerProperties : string * System.Collections.Generic.IReadOnlyList&lt;string&gt; -&gt; Microsoft.Azure.Cosmos.ContainerProperties" Usage="new Microsoft.Azure.Cosmos.ContainerProperties (id, partitionKeyPaths)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="id" Type="System.String" />
        <Parameter Name="partitionKeyPaths" Type="System.Collections.Generic.IReadOnlyList&lt;System.String&gt;" />
      </Parameters>
      <Docs>
        <param name="id">The Id of the resource in the Azure Cosmos service.</param>
        <param name="partitionKeyPaths">The paths of the hierarchical partition keys. Example: ["/tenantId", "/userId"]</param>
        <summary>
            Initializes a new instance of the <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> class for the Azure Cosmos DB service.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ContainerProperties (string id, string partitionKeyPath);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, string partitionKeyPath) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ContainerProperties.#ctor(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (id As String, partitionKeyPath As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.ContainerProperties : string * string -&gt; Microsoft.Azure.Cosmos.ContainerProperties" Usage="new Microsoft.Azure.Cosmos.ContainerProperties (id, partitionKeyPath)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="id" Type="System.String" />
        <Parameter Name="partitionKeyPath" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="id">The Id of the resource in the Azure Cosmos service.</param>
        <param name="partitionKeyPath">The path to the partition key. Example: /location</param>
        <summary>
            Initializes a new instance of the <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> class for the Azure Cosmos DB service.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AnalyticalStoreTimeToLiveInSeconds">
      <MemberSignature Language="C#" Value="public int? AnalyticalStoreTimeToLiveInSeconds { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; AnalyticalStoreTimeToLiveInSeconds" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.AnalyticalStoreTimeToLiveInSeconds" />
      <MemberSignature Language="VB.NET" Value="Public Property AnalyticalStoreTimeToLiveInSeconds As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.AnalyticalStoreTimeToLiveInSeconds : Nullable&lt;int&gt; with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.AnalyticalStoreTimeToLiveInSeconds" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="analyticalStorageTtl")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="analyticalStorageTtl")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
             Gets or sets the time to live for analytical store in seconds at container scope for the Azure Cosmos service.
            
             Analytical store when enabled captures all the item changes in the container. AnalyticalStoreTimeToLiveInSeconds
             defines the time to live for the changes in analytical store.
             </summary>
        <value>
             It is an optional property.
            
             The unit of measurement is seconds. The maximum allowed value is 2147483647.
             When updating this property, a valid value must be either a positive integer or '-1'.
            
             By default, AnalyticalStoreTimeToLiveInSeconds is <c>null</c> meaning analytical store is turned-off.
             </value>
        <remarks>
          <para>
             The <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.AnalyticalStoreTimeToLiveInSeconds" /> is applicable to all the item changes in the container.
             It cannot be overriden or customizable per item.
             </para>
          <para>
             When the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.AnalyticalStoreTimeToLiveInSeconds" /> is 0 analytical store is turned-off.
             It means all the item changes in the container are disregarded.
             </para>
          <para>
             When the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.AnalyticalStoreTimeToLiveInSeconds" /> is '-1', all the items changes will be captured
             by analytical store and will never expire.
             </para>
          <para>
             When the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.AnalyticalStoreTimeToLiveInSeconds" /> is a nonzero positive integer, all the items
             changes will be captured by analytical store and expired after the specified time to live.
             </para>
        </remarks>
        <example>
             The example below disables analytical store on a container if previously enabled.
             <code language="c#"><![CDATA[
                 container.AnalyticalStoreTimeToLiveInSeconds = 0;
             ]]></code></example>
        <example>
             The example below enables analytical store on container capturing all changes and never expire.
             <code language="c#"><![CDATA[
                 container.AnalyticalStoreTimeToLiveInSeconds = -1;
             ]]></code></example>
        <example>
             The example below enables analytical store on container capturing all changes and expire after 180days.
             <code language="c#"><![CDATA[
                 container.AnalyticalStoreTimeToLiveInSeconds = (int)TimeSpan.FromDays(6 * 30).TotalSeconds;
             ]]></code></example>
      </Docs>
    </Member>
    <Member MemberName="ClientEncryptionPolicy">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.ClientEncryptionPolicy ClientEncryptionPolicy { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.ClientEncryptionPolicy ClientEncryptionPolicy" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.ClientEncryptionPolicy" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientEncryptionPolicy As ClientEncryptionPolicy" />
      <MemberSignature Language="F#" Value="member this.ClientEncryptionPolicy : Microsoft.Azure.Cosmos.ClientEncryptionPolicy with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.ClientEncryptionPolicy" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.ClientEncryptionPolicy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the client encryption policy information for storing items in a container from the Azure Cosmos service.
            </summary>
        <value>
            It is an optional property.
            By default, ClientEncryptionPolicy is set to null meaning the feature is turned off for the container.
            </value>
        <remarks>
          <para>
            The <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.ClientEncryptionPolicy" /> will be applied to all the items in the container as the default policy.
            </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ComputedProperties">
      <MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection&lt;Microsoft.Azure.Cosmos.ComputedProperty&gt; ComputedProperties { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1&lt;class Microsoft.Azure.Cosmos.ComputedProperty&gt; ComputedProperties" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.ComputedProperties" />
      <MemberSignature Language="VB.NET" Value="Public Property ComputedProperties As Collection(Of ComputedProperty)" />
      <MemberSignature Language="F#" Value="member this.ComputedProperties : System.Collections.ObjectModel.Collection&lt;Microsoft.Azure.Cosmos.ComputedProperty&gt; with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.ComputedProperties" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.ObjectModel.Collection&lt;Microsoft.Azure.Cosmos.ComputedProperty&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the collection containing <see cref="T:Microsoft.Azure.Cosmos.ComputedProperty" /> objects in the container.
            </summary>
        <value>
            The collection containing <see cref="T:Microsoft.Azure.Cosmos.ComputedProperty" /> objects associated with the container.
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ConflictResolutionPolicy">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.ConflictResolutionPolicy ConflictResolutionPolicy { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.ConflictResolutionPolicy ConflictResolutionPolicy" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.ConflictResolutionPolicy" />
      <MemberSignature Language="VB.NET" Value="Public Property ConflictResolutionPolicy As ConflictResolutionPolicy" />
      <MemberSignature Language="F#" Value="member this.ConflictResolutionPolicy : Microsoft.Azure.Cosmos.ConflictResolutionPolicy with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.ConflictResolutionPolicy" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.ConflictResolutionPolicy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.ConflictResolutionPolicy" /></summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DefaultTimeToLive">
      <MemberSignature Language="C#" Value="public int? DefaultTimeToLive { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; DefaultTimeToLive" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.DefaultTimeToLive" />
      <MemberSignature Language="VB.NET" Value="Public Property DefaultTimeToLive As Nullable(Of Integer)" />
      <MemberSignature Language="F#" Value="member this.DefaultTimeToLive : Nullable&lt;int&gt; with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.DefaultTimeToLive" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="defaultTtl")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="defaultTtl")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
             Gets or sets the default time to live in seconds for item in a container from the Azure Cosmos service.
             </summary>
        <value>
             It is an optional property.
            
             The unit of measurement is seconds. The maximum allowed value is 2147483647.
             A valid value must be either a nonzero positive integer, '-1' or <c>null</c>.
            
             By default, DefaultTimeToLive is set to null meaning the time to live is turned off for the container.
             </value>
        <remarks>
          <para>
             The <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.DefaultTimeToLive" /> will be applied to all the items in the container as the default time-to-live policy.
             The individual item could override the default time-to-live policy by setting its time to live.
             </para>
          <para>
             When the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.DefaultTimeToLive" /> is <c>null</c>, the time-to-live will be turned off for the container.
             It means all the items will never expire. The individual item's  time to live will be disregarded.
             </para>
          <para>
             When the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.DefaultTimeToLive" /> is '-1', the time-to-live will be turned on for the container.
             By default, all the items will never expire. The individual item could be given a specific time-to-live value by setting its
             time to live. The item's time to live will be honored, and the expired items
             will be deleted in background.
             </para>
          <para>
             When the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.DefaultTimeToLive" /> is a nonzero positive integer, the time-to-live will be turned on for the container.
             And a default time-to-live in seconds will be applied to all the items. A item will be expired after the
             specified <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.DefaultTimeToLive" /> value in seconds since its last write time.
             </para>
        </remarks>
        <example>
             The example below disables time-to-live on a container.
             <code language="c#"><![CDATA[
                 container.DefaultTimeToLive = null;
             ]]></code></example>
        <example>
             The example below enables time-to-live on a container. By default, all the items never expire.
             <code language="c#"><![CDATA[
                 container.DefaultTimeToLive = -1;
             ]]></code></example>
        <example>
             The example below enables time-to-live on a container. By default, the item will expire after 1000 seconds
             since its last write time.
             <code language="c#"><![CDATA[
                 container.DefaultTimeToLive = 1000;
             ]]></code></example>
      </Docs>
    </Member>
    <Member MemberName="ETag">
      <MemberSignature Language="C#" Value="public string ETag { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ETag" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.ETag" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ETag As String" />
      <MemberSignature Language="F#" Value="member this.ETag : string" Usage="Microsoft.Azure.Cosmos.ContainerProperties.ETag" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_etag")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_etag")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the entity tag associated with the resource from the Azure Cosmos DB service.
            </summary>
        <value>
            The entity tag associated with the resource.
            </value>
        <remarks>
            ETags are used for concurrency checking when updating resources.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="GeospatialConfig">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.GeospatialConfig GeospatialConfig { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.GeospatialConfig GeospatialConfig" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.GeospatialConfig" />
      <MemberSignature Language="VB.NET" Value="Public Property GeospatialConfig As GeospatialConfig" />
      <MemberSignature Language="F#" Value="member this.GeospatialConfig : Microsoft.Azure.Cosmos.GeospatialConfig with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.GeospatialConfig" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.GeospatialConfig</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.GeospatialConfig" /> associated with the collection from the Azure Cosmos DB service.
            </summary>
        <value>
            Geospatial type of collection i.e. geography or geometry
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Id">
      <MemberSignature Language="C#" Value="public string Id { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Id" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.Id" />
      <MemberSignature Language="VB.NET" Value="Public Property Id As String" />
      <MemberSignature Language="F#" Value="member this.Id : string with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.Id" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="id")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="id")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the Id of the resource in the Azure Cosmos DB service.
            </summary>
        <value>The Id associated with the resource.</value>
        <remarks>
          <para>
            Every resource within an Azure Cosmos DB database account needs to have a unique identifier.
            Unlike <see cref="P:Microsoft.Azure.Documents.Resource.ResourceId" />, which is set internally, this Id is settable by the user and is not immutable.
            </para>
          <para>
            The following characters are restricted and cannot be used in the Id property:
             '/', '\\', '?', '#'
            </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="IndexingPolicy">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.IndexingPolicy IndexingPolicy { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.IndexingPolicy IndexingPolicy" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.IndexingPolicy" />
      <MemberSignature Language="VB.NET" Value="Public Property IndexingPolicy As IndexingPolicy" />
      <MemberSignature Language="F#" Value="member this.IndexingPolicy : Microsoft.Azure.Cosmos.IndexingPolicy with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.IndexingPolicy" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.IndexingPolicy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.IndexingPolicy" /> associated with the container from the Azure Cosmos DB service.
            </summary>
        <value>
            The indexing policy associated with the container.
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LastModified">
      <MemberSignature Language="C#" Value="public DateTime? LastModified { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.DateTime&gt; LastModified" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.LastModified" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastModified As Nullable(Of DateTime)" />
      <MemberSignature Language="F#" Value="member this.LastModified : Nullable&lt;DateTime&gt;" Usage="Microsoft.Azure.Cosmos.ContainerProperties.LastModified" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.UnixDateTimeConverter))]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.UnixDateTimeConverter))&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_ts")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_ts")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.DateTime&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the last modified time stamp associated with <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> from the Azure Cosmos DB service.
            </summary>
        <value>The last modified time stamp associated with the resource.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PartitionKeyDefinitionVersion">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion? PartitionKeyDefinitionVersion { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion&gt; PartitionKeyDefinitionVersion" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.PartitionKeyDefinitionVersion" />
      <MemberSignature Language="VB.NET" Value="Public Property PartitionKeyDefinitionVersion As Nullable(Of PartitionKeyDefinitionVersion)" />
      <MemberSignature Language="F#" Value="member this.PartitionKeyDefinitionVersion : Nullable&lt;Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion&gt; with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.PartitionKeyDefinitionVersion" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
             Gets or sets the <see cref="T:Microsoft.Azure.Cosmos.PartitionKeyDefinitionVersion" />
            
             The partition key definition version 1 uses a hash function that computes
             hash based on the first 100 bytes of the partition key. This can cause
             conflicts for documents with partition keys greater than 100 bytes.
            
             The partition key definition version 2 uses a hash function that computes
             hash based on the first 2 KB of the partition key.
             </summary>
        <value>The Partition Key Definition Version of the container</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PartitionKeyPath">
      <MemberSignature Language="C#" Value="public string PartitionKeyPath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string PartitionKeyPath" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.PartitionKeyPath" />
      <MemberSignature Language="VB.NET" Value="Public Property PartitionKeyPath As String" />
      <MemberSignature Language="F#" Value="member this.PartitionKeyPath : string with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.PartitionKeyPath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            JSON path used for containers partitioning
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PartitionKeyPaths">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList&lt;string&gt; PartitionKeyPaths { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1&lt;string&gt; PartitionKeyPaths" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.PartitionKeyPaths" />
      <MemberSignature Language="VB.NET" Value="Public Property PartitionKeyPaths As IReadOnlyList(Of String)" />
      <MemberSignature Language="F#" Value="member this.PartitionKeyPaths : System.Collections.Generic.IReadOnlyList&lt;string&gt; with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.PartitionKeyPaths" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IReadOnlyList&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            List of JSON paths used for containers with hierarchical partition keys
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SelfLink">
      <MemberSignature Language="C#" Value="public string SelfLink { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string SelfLink" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.SelfLink" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SelfLink As String" />
      <MemberSignature Language="F#" Value="member this.SelfLink : string" Usage="Microsoft.Azure.Cosmos.ContainerProperties.SelfLink" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_self")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_self")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the self-link associated with the resource from the Azure Cosmos DB service.
            </summary>
        <value>The self-link associated with the resource.</value>
        <remarks>
            A self-link is a static addressable Uri for each resource within a database account and follows the Azure Cosmos DB resource model.
            E.g. a self-link for a document could be dbs/db_resourceid/colls/coll_resourceid/documents/doc_resourceid
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="TimeToLivePropertyPath">
      <MemberSignature Language="C#" Value="public string TimeToLivePropertyPath { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TimeToLivePropertyPath" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.TimeToLivePropertyPath" />
      <MemberSignature Language="VB.NET" Value="Public Property TimeToLivePropertyPath As String" />
      <MemberSignature Language="F#" Value="member this.TimeToLivePropertyPath : string with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.TimeToLivePropertyPath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="ttlPropertyPath")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="ttlPropertyPath")&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Obsolete]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Obsolete&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the time to live base time stamp property path.
            </summary>
        <value>
            It is an optional property.
            This property should be only present when DefaultTimeToLive is set. When this property is present, time to live
            for a item is decided based on the value of this property in item.
            By default, TimeToLivePropertyPath is set to null meaning the time to live is based on the _ts property in item.
            </value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UniqueKeyPolicy">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.UniqueKeyPolicy UniqueKeyPolicy { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.UniqueKeyPolicy UniqueKeyPolicy" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.UniqueKeyPolicy" />
      <MemberSignature Language="VB.NET" Value="Public Property UniqueKeyPolicy As UniqueKeyPolicy" />
      <MemberSignature Language="F#" Value="member this.UniqueKeyPolicy : Microsoft.Azure.Cosmos.UniqueKeyPolicy with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.UniqueKeyPolicy" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.UniqueKeyPolicy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the <see cref="P:Microsoft.Azure.Cosmos.ContainerProperties.UniqueKeyPolicy" /> that guarantees uniqueness of documents in container in the Azure Cosmos DB service.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="VectorEmbeddingPolicy">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.VectorEmbeddingPolicy VectorEmbeddingPolicy { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.VectorEmbeddingPolicy VectorEmbeddingPolicy" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ContainerProperties.VectorEmbeddingPolicy" />
      <MemberSignature Language="VB.NET" Value="Public Property VectorEmbeddingPolicy As VectorEmbeddingPolicy" />
      <MemberSignature Language="F#" Value="member this.VectorEmbeddingPolicy : Microsoft.Azure.Cosmos.VectorEmbeddingPolicy with get, set" Usage="Microsoft.Azure.Cosmos.ContainerProperties.VectorEmbeddingPolicy" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.47.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonIgnore&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.VectorEmbeddingPolicy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the vector embedding policy containing paths for embeddings along with path-specific settings for the item
            used in performing vector search on the items in a collection in the Azure CosmosDB database service.
            </summary>
        <value>
            It is an optional property.
            By default, VectorEmbeddingPolicy is set to null meaning the feature is turned off for the container.
            </value>
        <remarks>
          <para>
            The <see cref="T:Microsoft.Azure.Cosmos.VectorEmbeddingPolicy" /> will be applied to all the items in the container as the default policy.
            </para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>