<Type Name="Container" FullName="Microsoft.Azure.Cosmos.Container">

<TypeSignature Language="C#" Value="public abstract class Container" />

<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Container extends System.Object" />

<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.Container" />

<TypeSignature Language="VB.NET" Value="Public MustInherit Class Container" />

<TypeSignature Language="F#" Value="type Container = 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>

</AssemblyInfo>

<Base>

<BaseTypeName>System.Object</BaseTypeName>

</Base>

<Interfaces />

<Docs>

<summary>

Operations for reading, replacing, or deleting a specific, existing container or item in a container by id.

There are two different types of operations.

1. The object operations where it serializes and deserializes the item on request/response

2. The stream response which takes a Stream containing a JSON serialized object and returns a response containing a Stream

See <see cref="T:Microsoft.Azure.Cosmos.Database" /> for creating new containers, and reading/querying all containers.

</summary>

<remarks>

Note: all these operations make calls against a fixed budget.

You should design your system such that these calls scale sub linearly with your application.

For instance, do not call `container.readAsync()` before every single `container.readItemAsync()` call to ensure the container exists;

do this once on application start up.

</remarks>

</Docs>

<Members>

<Member MemberName=".ctor">

<MemberSignature Language="C#" Value="protected Container ();" />

<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.#ctor" />

<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />

<MemberType>Constructor</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<Parameters />

<Docs>

<summary>To be added.</summary>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="Conflicts">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.Conflicts Conflicts { get; }" />

<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.Conflicts Conflicts" />

<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Container.Conflicts" />

<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Conflicts As Conflicts" />

<MemberSignature Language="F#" Value="member this.Conflicts : Microsoft.Azure.Cosmos.Conflicts" Usage="Microsoft.Azure.Cosmos.Container.Conflicts" />

<MemberType>Property</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.Conflicts</ReturnType>

</ReturnValue>

<Docs>

<summary>

Returns the conflicts

</summary>

<value>To be added.</value>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="CreateItemAsync&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ItemResponse&lt;T&gt;&gt; CreateItemAsync&lt;T&gt; (T item, Microsoft.Azure.Cosmos.PartitionKey? partitionKey = default, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Cosmos.ItemResponse`1&lt;!!T&gt;&gt; CreateItemAsync&lt;T&gt;(!!T item, valuetype System.Nullable`1&lt;valuetype Microsoft.Azure.Cosmos.PartitionKey&gt; partitionKey, class Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.CreateItemAsync``1(``0,System.Nullable{Microsoft.Azure.Cosmos.PartitionKey},Microsoft.Azure.Cosmos.ItemRequestOptions,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateItemAsync(Of T) (item As T, Optional partitionKey As Nullable(Of PartitionKey) = Nothing, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ItemResponse(Of T))" />

<MemberSignature Language="F#" Value="abstract member CreateItemAsync : 'T * Nullable&lt;Microsoft.Azure.Cosmos.PartitionKey&gt; * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ItemResponse&lt;'T&gt;&gt;" Usage="container.CreateItemAsync (item, partitionKey, requestOptions, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ItemResponse&lt;T&gt;&gt;</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="item" Type="T" />

<Parameter Name="partitionKey" Type="System.Nullable&lt;Microsoft.Azure.Cosmos.PartitionKey&gt;" />

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.ItemRequestOptions" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />

</Parameters>

<Docs>

<typeparam name="T">To be added.</typeparam>

<param name="item">A JSON serializable object that must contain an id property. <see cref="T:Microsoft.Azure.Cosmos.CosmosSerializer" /> to implement a custom serializer</param>

<param name="partitionKey">

<see cref="T:Microsoft.Azure.Cosmos.PartitionKey" /> for the item. If not specified will be populated by extracting from {T}</param>

<param name="requestOptions">(Optional) The options for the item request.</param>

<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>

<summary>

Creates a item as an asynchronous operation in the Azure Cosmos service.

</summary>

<returns>The <see cref="T:Microsoft.Azure.Cosmos.ItemResponse`1" /> that was created contained within a <see cref="T:System.Threading.Tasks.Task" /> object representing the service response for the asynchronous operation.</returns>

<remarks>To be added.</remarks>

<example>

<code language="c#"><![CDATA[

public class ToDoActivity{

public string id {get; set;}

public string status {get; set;}

}

ToDoActivity test = new ToDoActivity()

{

id = Guid.NewGuid().ToString(),

status = "InProgress"

};

ItemResponse item = await this.container.CreateItemAsync<ToDoActivity>(test, new PartitionKey(test.status));

]]></code>

</example>

</Docs>

</Member>

<Member MemberName="CreateItemStreamAsync">

<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt; CreateItemStreamAsync (System.IO.Stream streamPayload, Microsoft.Azure.Cosmos.PartitionKey partitionKey, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Cosmos.ResponseMessage&gt; CreateItemStreamAsync(class System.IO.Stream streamPayload, valuetype Microsoft.Azure.Cosmos.PartitionKey partitionKey, class Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.CreateItemStreamAsync(System.IO.Stream,Microsoft.Azure.Cosmos.PartitionKey,Microsoft.Azure.Cosmos.ItemRequestOptions,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateItemStreamAsync (streamPayload As Stream, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)" />

<MemberSignature Language="F#" Value="abstract member CreateItemStreamAsync : System.IO.Stream * Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt;" Usage="container.CreateItemStreamAsync (streamPayload, partitionKey, requestOptions, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt;</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="streamPayload" Type="System.IO.Stream" />

<Parameter Name="partitionKey" Type="Microsoft.Azure.Cosmos.PartitionKey" />

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.ItemRequestOptions" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />

</Parameters>

<Docs>

<param name="streamPayload">A <see cref="T:System.IO.Stream" /> containing the payload.</param>

<param name="partitionKey">The partition key for the item.</param>

<param name="requestOptions">(Optional) The options for the item request.</param>

<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>

<summary>

Creates a Item as an asynchronous operation in the Azure Cosmos service.

</summary>

<returns>The <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" /> that was created contained within a <see cref="T:System.Threading.Tasks.Task" /> object representing the service response for the asynchronous operation.</returns>

<remarks>

The Stream operation only throws on client side exceptions. This is to increase performance and prevent the overhead of throwing exceptions. Check the HTTP status code on the response to check if the operation failed.

</remarks>

<example>

This example creates an item in a Cosmos container.

<code language="c#"><![CDATA[

//Create the object in Cosmos

using (ResponseMessage response = await this.Container.CreateItemStreamAsync(partitionKey: new PartitionKey("streamPartitionKey"), streamPayload: stream))

{

if (!response.IsSuccessStatusCode)

{

//Handle and log exception

return;

}

//Read or do other operations with the stream

using (StreamReader streamReader = new StreamReader(response.Content))

{

string responseContentAsString = await streamReader.ReadToEndAsync();

}

}

]]></code></example>

</Docs>

</Member>

<Member MemberName="CreateTransactionalBatch">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.TransactionalBatch CreateTransactionalBatch (Microsoft.Azure.Cosmos.PartitionKey partitionKey);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.TransactionalBatch CreateTransactionalBatch(valuetype Microsoft.Azure.Cosmos.PartitionKey partitionKey) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.CreateTransactionalBatch(Microsoft.Azure.Cosmos.PartitionKey)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function CreateTransactionalBatch (partitionKey As PartitionKey) As TransactionalBatch" />

<MemberSignature Language="F#" Value="abstract member CreateTransactionalBatch : Microsoft.Azure.Cosmos.PartitionKey -&gt; Microsoft.Azure.Cosmos.TransactionalBatch" Usage="container.CreateTransactionalBatch partitionKey" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.TransactionalBatch</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="partitionKey" Type="Microsoft.Azure.Cosmos.PartitionKey" />

</Parameters>

<Docs>

<param name="partitionKey">The partition key for all items in the batch.</param>

<summary>

Initializes a new instance of <see cref="T:Microsoft.Azure.Cosmos.TransactionalBatch" />

that can be used to perform operations across multiple items

in the container with the provided partition key in a transactional manner.

</summary>

<returns>A new instance of <see cref="T:Microsoft.Azure.Cosmos.TransactionalBatch" />.</returns>

<remarks>

<seealso href="https://learn.microsoft.com/azure/cosmos-db/concepts-limits#per-request-limits">Limits on TransactionalBatch requests</seealso>

</remarks>

</Docs>

</Member>

<Member MemberName="Database">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.Database Database { get; }" />

<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Cosmos.Database Database" />

<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Container.Database" />

<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Database As Database" />

<MemberSignature Language="F#" Value="member this.Database : Microsoft.Azure.Cosmos.Database" Usage="Microsoft.Azure.Cosmos.Container.Database" />

<MemberType>Property</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.Database</ReturnType>

</ReturnValue>

<Docs>

<summary>

Returns the parent Database reference

</summary>

<value>To be added.</value>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="DeleteContainerAsync">

<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ContainerResponse&gt; DeleteContainerAsync (Microsoft.Azure.Cosmos.ContainerRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Cosmos.ContainerResponse&gt; DeleteContainerAsync(class Microsoft.Azure.Cosmos.ContainerRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.DeleteContainerAsync(Microsoft.Azure.Cosmos.ContainerRequestOptions,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function DeleteContainerAsync (Optional requestOptions As ContainerRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)" />

<MemberSignature Language="F#" Value="abstract member DeleteContainerAsync : Microsoft.Azure.Cosmos.ContainerRequestOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ContainerResponse&gt;" Usage="container.DeleteContainerAsync (requestOptions, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ContainerResponse&gt;</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.ContainerRequestOptions" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />

</Parameters>

<Docs>

<param name="requestOptions">(Optional) The options for the container request.</param>

<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>

<summary>

Delete a <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> from the Azure Cosmos DB service as an asynchronous operation.

</summary>

<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ContainerResponse" /> which will contain information about the request issued.</returns>

<remarks>To be added.</remarks>

<example>

<code language="c#"><![CDATA[

Container container = this.database.GetContainer("containerId");

ContainerResponse response = await container.DeleteContainerAsync();

]]></code>

</example>

</Docs>

</Member>

<Member MemberName="DeleteContainerStreamAsync">

<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt; DeleteContainerStreamAsync (Microsoft.Azure.Cosmos.ContainerRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Cosmos.ResponseMessage&gt; DeleteContainerStreamAsync(class Microsoft.Azure.Cosmos.ContainerRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.DeleteContainerStreamAsync(Microsoft.Azure.Cosmos.ContainerRequestOptions,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function DeleteContainerStreamAsync (Optional requestOptions As ContainerRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)" />

<MemberSignature Language="F#" Value="abstract member DeleteContainerStreamAsync : Microsoft.Azure.Cosmos.ContainerRequestOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt;" Usage="container.DeleteContainerStreamAsync (requestOptions, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt;</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.ContainerRequestOptions" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />

</Parameters>

<Docs>

<param name="requestOptions">(Optional) The options for the container request.</param>

<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>

<summary>

Delete a <see cref="T:Microsoft.Azure.Cosmos.ContainerProperties" /> from the Azure Cosmos DB service as an asynchronous operation.

</summary>

<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" /> which will contain information about the request issued.</returns>

<remarks>To be added.</remarks>

<example>

<code language="c#"><![CDATA[

Container container = this.database.GetContainer("containerId");

ResponseMessage response = await container.DeleteContainerStreamAsync();

]]></code>

</example>

</Docs>

</Member>

<Member MemberName="DeleteItemAsync&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ItemResponse&lt;T&gt;&gt; DeleteItemAsync&lt;T&gt; (string id, Microsoft.Azure.Cosmos.PartitionKey partitionKey, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Cosmos.ItemResponse`1&lt;!!T&gt;&gt; DeleteItemAsync&lt;T&gt;(string id, valuetype Microsoft.Azure.Cosmos.PartitionKey partitionKey, class Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.DeleteItemAsync``1(System.String,Microsoft.Azure.Cosmos.PartitionKey,Microsoft.Azure.Cosmos.ItemRequestOptions,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function DeleteItemAsync(Of T) (id As String, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ItemResponse(Of T))" />

<MemberSignature Language="F#" Value="abstract member DeleteItemAsync : string * Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ItemResponse&lt;'T&gt;&gt;" Usage="container.DeleteItemAsync (id, partitionKey, requestOptions, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ItemResponse&lt;T&gt;&gt;</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="id" Type="System.String" />

<Parameter Name="partitionKey" Type="Microsoft.Azure.Cosmos.PartitionKey" />

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.ItemRequestOptions" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />

</Parameters>

<Docs>

<typeparam name="T">To be added.</typeparam>

<param name="id">The Cosmos item id</param>

<param name="partitionKey">The partition key for the item.</param>

<param name="requestOptions">(Optional) The options for the item request.</param>

<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>

<summary>

Delete a item from the Azure Cosmos service as an asynchronous operation.

</summary>

<returns>A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ItemResponse`1" /> which will contain information about the request issued.</returns>

<remarks>

<see cref="P:Microsoft.Azure.Cosmos.ItemResponse`1.Resource" /> is <see href="https://docs.microsoft.com/rest/api/cosmos-db/delete-a-document#body">always null</see></remarks>

<see cref="P:Microsoft.Azure.Cosmos.ItemResponse`1.Resource" />

<example>

<code language="c#"><![CDATA[

public class ToDoActivity{

public string id {get; set;}

public string status {get; set;}

}

ItemResponse item = await this.container.DeleteItemAsync<ToDoActivity>("id", new PartitionKey("partitionKey"));

]]></code>

</example>

</Docs>

</Member>

<Member MemberName="DeleteItemStreamAsync">

<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt; DeleteItemStreamAsync (string id, Microsoft.Azure.Cosmos.PartitionKey partitionKey, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.Cosmos.ResponseMessage&gt; DeleteItemStreamAsync(string id, valuetype Microsoft.Azure.Cosmos.PartitionKey partitionKey, class Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.DeleteItemStreamAsync(System.String,Microsoft.Azure.Cosmos.PartitionKey,Microsoft.Azure.Cosmos.ItemRequestOptions,System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function DeleteItemStreamAsync (id As String, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResponseMessage)" />

<MemberSignature Language="F#" Value="abstract member DeleteItemStreamAsync : string * Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt;" Usage="container.DeleteItemStreamAsync (id, partitionKey, requestOptions, cancellationToken)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.Cosmos.ResponseMessage&gt;</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="id" Type="System.String" />

<Parameter Name="partitionKey" Type="Microsoft.Azure.Cosmos.PartitionKey" />

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.ItemRequestOptions" />

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />

</Parameters>

<Docs>

<param name="id">The Cosmos item id</param>

<param name="partitionKey">The partition key for the item.</param>

<param name="requestOptions">(Optional) The options for the item request.</param>

<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>

<summary>

Delete a item from the Azure Cosmos service as an asynchronous operation.

</summary>

<returns>

A <see cref="T:System.Threading.Tasks.Task" /> containing a <see cref="T:Microsoft.Azure.Cosmos.ResponseMessage" /> which wraps a <see cref="T:System.IO.Stream" /> containing the delete resource record.

</returns>

<remarks>

For delete operations, the <see cref="P:Microsoft.Azure.Cosmos.ResponseMessage.Content" /> will be null. Item content is not expected in the response.

The Stream operation only throws on client side exceptions. This is to increase performance and prevent the overhead of throwing exceptions. Check the HTTP status code on the response to check if the operation failed.

</remarks>

<example>

Delete an item from Cosmos

<code language="c#"><![CDATA[

using(ResponseMessage response = await this.container.DeleteItemStreamAsync("itemId", new PartitionKey("itemPartitionKey")))

{

if (!response.IsSuccessStatusCode)

{

//Handle and log exception

return;

}

}

]]></code></example>

</Docs>

</Member>

<Member MemberName="GetChangeFeedEstimator">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.ChangeFeedEstimator GetChangeFeedEstimator (string processorName, Microsoft.Azure.Cosmos.Container leaseContainer);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.ChangeFeedEstimator GetChangeFeedEstimator(string processorName, class Microsoft.Azure.Cosmos.Container leaseContainer) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedEstimator(System.String,Microsoft.Azure.Cosmos.Container)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedEstimator (processorName As String, leaseContainer As Container) As ChangeFeedEstimator" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedEstimator : string * Microsoft.Azure.Cosmos.Container -&gt; Microsoft.Azure.Cosmos.ChangeFeedEstimator" Usage="container.GetChangeFeedEstimator (processorName, leaseContainer)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.ChangeFeedEstimator</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="processorName" Type="System.String" />

<Parameter Name="leaseContainer" Type="Microsoft.Azure.Cosmos.Container" />

</Parameters>

<Docs>

<param name="processorName">The name of the Processor the Estimator is going to measure.</param>

<param name="leaseContainer">Instance of a Cosmos Container that holds the leases.</param>

<summary>

Gets a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedEstimator" /> for change feed monitoring.

</summary>

<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedEstimator" /></returns>

<remarks>

The goal of the Estimator is to measure progress of a particular processor. In order to do that, the <paramref name="processorName" /> and other parameters, like the leases container, need to match that of the Processor to measure.

</remarks>

</Docs>

</Member>

<Member MemberName="GetChangeFeedEstimatorBuilder">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedEstimatorBuilder (string processorName, Microsoft.Azure.Cosmos.Container.ChangesEstimationHandler estimationDelegate, TimeSpan? estimationPeriod = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedEstimatorBuilder(string processorName, class Microsoft.Azure.Cosmos.Container/ChangesEstimationHandler estimationDelegate, valuetype System.Nullable`1&lt;valuetype System.TimeSpan&gt; estimationPeriod) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedEstimatorBuilder(System.String,Microsoft.Azure.Cosmos.Container.ChangesEstimationHandler,System.Nullable{System.TimeSpan})" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedEstimatorBuilder (processorName As String, estimationDelegate As Container.ChangesEstimationHandler, Optional estimationPeriod As Nullable(Of TimeSpan) = Nothing) As ChangeFeedProcessorBuilder" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedEstimatorBuilder : string * Microsoft.Azure.Cosmos.Container.ChangesEstimationHandler * Nullable&lt;TimeSpan&gt; -&gt; Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" Usage="container.GetChangeFeedEstimatorBuilder (processorName, estimationDelegate, estimationPeriod)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="processorName" Type="System.String" />

<Parameter Name="estimationDelegate" Type="Microsoft.Azure.Cosmos.Container+ChangesEstimationHandler" />

<Parameter Name="estimationPeriod" Type="System.Nullable&lt;System.TimeSpan&gt;" />

</Parameters>

<Docs>

<param name="processorName">The name of the Processor the Estimator is going to measure.</param>

<param name="estimationDelegate">Delegate to receive estimation.</param>

<param name="estimationPeriod">Time interval on which to report the estimation. Default is 5 seconds.</param>

<summary>

Initializes a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /> for change feed monitoring.

</summary>

<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /></returns>

<remarks>

The goal of the Estimator is to measure progress of a particular processor. In order to do that, the <paramref name="processorName" /> and other parameters, like the leases container, need to match that of the Processor to measure.

</remarks>

</Docs>

</Member>

<Member MemberName="GetChangeFeedIterator&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator&lt;T&gt; GetChangeFeedIterator&lt;T&gt; (Microsoft.Azure.Cosmos.ChangeFeedStartFrom changeFeedStartFrom, Microsoft.Azure.Cosmos.ChangeFeedMode changeFeedMode, Microsoft.Azure.Cosmos.ChangeFeedRequestOptions changeFeedRequestOptions = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator`1&lt;!!T&gt; GetChangeFeedIterator&lt;T&gt;(class Microsoft.Azure.Cosmos.ChangeFeedStartFrom changeFeedStartFrom, class Microsoft.Azure.Cosmos.ChangeFeedMode changeFeedMode, class Microsoft.Azure.Cosmos.ChangeFeedRequestOptions changeFeedRequestOptions) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedIterator``1(Microsoft.Azure.Cosmos.ChangeFeedStartFrom,Microsoft.Azure.Cosmos.ChangeFeedMode,Microsoft.Azure.Cosmos.ChangeFeedRequestOptions)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedIterator(Of T) (changeFeedStartFrom As ChangeFeedStartFrom, changeFeedMode As ChangeFeedMode, Optional changeFeedRequestOptions As ChangeFeedRequestOptions = Nothing) As FeedIterator(Of T)" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedIterator : Microsoft.Azure.Cosmos.ChangeFeedStartFrom * Microsoft.Azure.Cosmos.ChangeFeedMode * Microsoft.Azure.Cosmos.ChangeFeedRequestOptions -&gt; Microsoft.Azure.Cosmos.FeedIterator&lt;'T&gt;" Usage="container.GetChangeFeedIterator (changeFeedStartFrom, changeFeedMode, changeFeedRequestOptions)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.FeedIterator&lt;T&gt;</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="changeFeedStartFrom" Type="Microsoft.Azure.Cosmos.ChangeFeedStartFrom" />

<Parameter Name="changeFeedMode" Type="Microsoft.Azure.Cosmos.ChangeFeedMode" />

<Parameter Name="changeFeedRequestOptions" Type="Microsoft.Azure.Cosmos.ChangeFeedRequestOptions" />

</Parameters>

<Docs>

<typeparam name="T">To be added.</typeparam>

<param name="changeFeedStartFrom">Where to start the changefeed from.</param>

<param name="changeFeedMode">Defines the mode on which to consume the change feed.</param>

<param name="changeFeedRequestOptions">(Optional) The options for the Change Feed consumption.</param>

<summary>

This method creates an iterator to consume a Change Feed.

</summary>

<returns>An iterator to go through the Change Feed.</returns>

<remarks>To be added.</remarks>

<altmember cref="M:Microsoft.Azure.Cosmos.Container.GetFeedRangesAsync(System.Threading.CancellationToken)" />

<example>

<code language="c#"><![CDATA[

ChangeFeedRequestOptions options = new ChangeFeedRequestOptions()

{

PageSizeHint = 10,

}

FeedIterator<MyItem> feedIterator = this.Container.GetChangeFeedIterator<MyItem>(

ChangeFeedStartFrom.Beginning(),

ChangeFeedMode.Incremental,

options);

while (feedIterator.HasMoreResults)

{

FeedResponse<MyItem> response = await feedIterator.ReadNextAsync();

if (response.StatusCode == NotModified)

{

// No new changes

// Capture response.ContinuationToken and break or sleep for some time

}

else

{

foreach (var item in response)

{

Console.WriteLine(item);

}

}

}

]]></code>

</example>

</Docs>

</Member>

<Member MemberName="GetChangeFeedProcessorBuilder">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder (string processorName, Microsoft.Azure.Cosmos.Container.ChangeFeedStreamHandler onChangesDelegate);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder(string processorName, class Microsoft.Azure.Cosmos.Container/ChangeFeedStreamHandler onChangesDelegate) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedProcessorBuilder(System.String,Microsoft.Azure.Cosmos.Container.ChangeFeedStreamHandler)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedProcessorBuilder (processorName As String, onChangesDelegate As Container.ChangeFeedStreamHandler) As ChangeFeedProcessorBuilder" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedProcessorBuilder : string * Microsoft.Azure.Cosmos.Container.ChangeFeedStreamHandler -&gt; Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" Usage="container.GetChangeFeedProcessorBuilder (processorName, onChangesDelegate)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="processorName" Type="System.String" />

<Parameter Name="onChangesDelegate" Type="Microsoft.Azure.Cosmos.Container+ChangeFeedStreamHandler" />

</Parameters>

<Docs>

<param name="processorName">A name that identifies the Processor and the particular work it will do.</param>

<param name="onChangesDelegate">Delegate to receive changes.</param>

<summary>

Initializes a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /> for change feed processing.

</summary>

<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /></returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="GetChangeFeedProcessorBuilder&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder&lt;T&gt; (string processorName, Microsoft.Azure.Cosmos.Container.ChangeFeedHandler&lt;T&gt; onChangesDelegate);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder&lt;T&gt;(string processorName, class Microsoft.Azure.Cosmos.Container/ChangeFeedHandler`1&lt;!!T&gt; onChangesDelegate) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedProcessorBuilder``1(System.String,Microsoft.Azure.Cosmos.Container.ChangeFeedHandler{``0})" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedProcessorBuilder(Of T) (processorName As String, onChangesDelegate As Container.ChangeFeedHandler(Of T)) As ChangeFeedProcessorBuilder" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedProcessorBuilder : string * Microsoft.Azure.Cosmos.Container.ChangeFeedHandler&lt;'T&gt; -&gt; Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" Usage="container.GetChangeFeedProcessorBuilder (processorName, onChangesDelegate)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="processorName" Type="System.String" />

<Parameter Name="onChangesDelegate" Type="Microsoft.Azure.Cosmos.Container+ChangeFeedHandler&lt;T&gt;" />

</Parameters>

<Docs>

<typeparam name="T">To be added.</typeparam>

<param name="processorName">A name that identifies the Processor and the particular work it will do.</param>

<param name="onChangesDelegate">Delegate to receive changes.</param>

<summary>

Initializes a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /> for change feed processing.

</summary>

<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /></returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="GetChangeFeedProcessorBuilder&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder&lt;T&gt; (string processorName, Microsoft.Azure.Cosmos.Container.ChangesHandler&lt;T&gt; onChangesDelegate);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilder&lt;T&gt;(string processorName, class Microsoft.Azure.Cosmos.Container/ChangesHandler`1&lt;!!T&gt; onChangesDelegate) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedProcessorBuilder``1(System.String,Microsoft.Azure.Cosmos.Container.ChangesHandler{``0})" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedProcessorBuilder(Of T) (processorName As String, onChangesDelegate As Container.ChangesHandler(Of T)) As ChangeFeedProcessorBuilder" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedProcessorBuilder : string * Microsoft.Azure.Cosmos.Container.ChangesHandler&lt;'T&gt; -&gt; Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" Usage="container.GetChangeFeedProcessorBuilder (processorName, onChangesDelegate)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="processorName" Type="System.String" />

<Parameter Name="onChangesDelegate" Type="Microsoft.Azure.Cosmos.Container+ChangesHandler&lt;T&gt;" />

</Parameters>

<Docs>

<typeparam name="T">To be added.</typeparam>

<param name="processorName">A name that identifies the Processor and the particular work it will do.</param>

<param name="onChangesDelegate">Delegate to receive changes.</param>

<summary>

Initializes a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /> for change feed processing.

</summary>

<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /></returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="GetChangeFeedProcessorBuilderWithManualCheckpoint">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilderWithManualCheckpoint (string processorName, Microsoft.Azure.Cosmos.Container.ChangeFeedStreamHandlerWithManualCheckpoint onChangesDelegate);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilderWithManualCheckpoint(string processorName, class Microsoft.Azure.Cosmos.Container/ChangeFeedStreamHandlerWithManualCheckpoint onChangesDelegate) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedProcessorBuilderWithManualCheckpoint(System.String,Microsoft.Azure.Cosmos.Container.ChangeFeedStreamHandlerWithManualCheckpoint)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedProcessorBuilderWithManualCheckpoint (processorName As String, onChangesDelegate As Container.ChangeFeedStreamHandlerWithManualCheckpoint) As ChangeFeedProcessorBuilder" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedProcessorBuilderWithManualCheckpoint : string * Microsoft.Azure.Cosmos.Container.ChangeFeedStreamHandlerWithManualCheckpoint -&gt; Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" Usage="container.GetChangeFeedProcessorBuilderWithManualCheckpoint (processorName, onChangesDelegate)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="processorName" Type="System.String" />

<Parameter Name="onChangesDelegate" Type="Microsoft.Azure.Cosmos.Container+ChangeFeedStreamHandlerWithManualCheckpoint" />

</Parameters>

<Docs>

<param name="processorName">A name that identifies the Processor and the particular work it will do.</param>

<param name="onChangesDelegate">Delegate to receive changes.</param>

<summary>

Initializes a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /> for change feed processing with manual checkpoint.

</summary>

<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /></returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="GetChangeFeedProcessorBuilderWithManualCheckpoint&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilderWithManualCheckpoint&lt;T&gt; (string processorName, Microsoft.Azure.Cosmos.Container.ChangeFeedHandlerWithManualCheckpoint&lt;T&gt; onChangesDelegate);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedProcessorBuilderWithManualCheckpoint&lt;T&gt;(string processorName, class Microsoft.Azure.Cosmos.Container/ChangeFeedHandlerWithManualCheckpoint`1&lt;!!T&gt; onChangesDelegate) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedProcessorBuilderWithManualCheckpoint``1(System.String,Microsoft.Azure.Cosmos.Container.ChangeFeedHandlerWithManualCheckpoint{``0})" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedProcessorBuilderWithManualCheckpoint(Of T) (processorName As String, onChangesDelegate As Container.ChangeFeedHandlerWithManualCheckpoint(Of T)) As ChangeFeedProcessorBuilder" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedProcessorBuilderWithManualCheckpoint : string * Microsoft.Azure.Cosmos.Container.ChangeFeedHandlerWithManualCheckpoint&lt;'T&gt; -&gt; Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" Usage="container.GetChangeFeedProcessorBuilderWithManualCheckpoint (processorName, onChangesDelegate)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="processorName" Type="System.String" />

<Parameter Name="onChangesDelegate" Type="Microsoft.Azure.Cosmos.Container+ChangeFeedHandlerWithManualCheckpoint&lt;T&gt;" />

</Parameters>

<Docs>

<typeparam name="T">To be added.</typeparam>

<param name="processorName">A name that identifies the Processor and the particular work it will do.</param>

<param name="onChangesDelegate">Delegate to receive changes.</param>

<summary>

Initializes a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /> for change feed processing with manual checkpoint.

</summary>

<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder" /></returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="GetChangeFeedStreamIterator">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator GetChangeFeedStreamIterator (Microsoft.Azure.Cosmos.ChangeFeedStartFrom changeFeedStartFrom, Microsoft.Azure.Cosmos.ChangeFeedMode changeFeedMode, Microsoft.Azure.Cosmos.ChangeFeedRequestOptions changeFeedRequestOptions = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator GetChangeFeedStreamIterator(class Microsoft.Azure.Cosmos.ChangeFeedStartFrom changeFeedStartFrom, class Microsoft.Azure.Cosmos.ChangeFeedMode changeFeedMode, class Microsoft.Azure.Cosmos.ChangeFeedRequestOptions changeFeedRequestOptions) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetChangeFeedStreamIterator(Microsoft.Azure.Cosmos.ChangeFeedStartFrom,Microsoft.Azure.Cosmos.ChangeFeedMode,Microsoft.Azure.Cosmos.ChangeFeedRequestOptions)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetChangeFeedStreamIterator (changeFeedStartFrom As ChangeFeedStartFrom, changeFeedMode As ChangeFeedMode, Optional changeFeedRequestOptions As ChangeFeedRequestOptions = Nothing) As FeedIterator" />

<MemberSignature Language="F#" Value="abstract member GetChangeFeedStreamIterator : Microsoft.Azure.Cosmos.ChangeFeedStartFrom * Microsoft.Azure.Cosmos.ChangeFeedMode * Microsoft.Azure.Cosmos.ChangeFeedRequestOptions -&gt; Microsoft.Azure.Cosmos.FeedIterator" Usage="container.GetChangeFeedStreamIterator (changeFeedStartFrom, changeFeedMode, changeFeedRequestOptions)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.FeedIterator</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="changeFeedStartFrom" Type="Microsoft.Azure.Cosmos.ChangeFeedStartFrom" />

<Parameter Name="changeFeedMode" Type="Microsoft.Azure.Cosmos.ChangeFeedMode" />

<Parameter Name="changeFeedRequestOptions" Type="Microsoft.Azure.Cosmos.ChangeFeedRequestOptions" />

</Parameters>

<Docs>

<param name="changeFeedStartFrom">Where to start the changefeed from.</param>

<param name="changeFeedMode">Defines the mode on which to consume the change feed.</param>

<param name="changeFeedRequestOptions">(Optional) The options for the Change Feed consumption.</param>

<summary>

This method creates an iterator to consume a Change Feed.

</summary>

<returns>An iterator to go through the Change Feed.</returns>

<remarks>To be added.</remarks>

<altmember cref="M:Microsoft.Azure.Cosmos.Container.GetFeedRangesAsync(System.Threading.CancellationToken)" />

<example>

<code language="c#"><![CDATA[

ChangeFeedRequestOptions options = new ChangeFeedRequestOptions()

{

PageSizeHint = 10,

}

FeedIterator feedIterator = this.Container.GetChangeFeedStreamIterator(

ChangeFeedStartFrom.Beginning(),

ChangeFeedMode.Incremental,

options);

while (feedIterator.HasMoreResults)

{

using (ResponseMessage response = await feedIterator.ReadNextAsync())

{

if (response.StatusCode == NotModified)

{

// No new changes

// Capture response.ContinuationToken and break or sleep for some time

}

else

{

using (StreamReader sr = new StreamReader(response.Content))

using (JsonTextReader jtr = new JsonTextReader(sr))

{

JObject result = JObject.Load(jtr);

}

}

}

}

]]></code>

</example>

</Docs>

</Member>

<Member MemberName="GetFeedRangesAsync">

<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task&lt;System.Collections.Generic.IReadOnlyList&lt;Microsoft.Azure.Cosmos.FeedRange&gt;&gt; GetFeedRangesAsync (System.Threading.CancellationToken cancellationToken = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class System.Collections.Generic.IReadOnlyList`1&lt;class Microsoft.Azure.Cosmos.FeedRange&gt;&gt; GetFeedRangesAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetFeedRangesAsync(System.Threading.CancellationToken)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetFeedRangesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of FeedRange))" />

<MemberSignature Language="F#" Value="abstract member GetFeedRangesAsync : System.Threading.CancellationToken -&gt; System.Threading.Tasks.Task&lt;System.Collections.Generic.IReadOnlyList&lt;Microsoft.Azure.Cosmos.FeedRange&gt;&gt;" Usage="container.GetFeedRangesAsync cancellationToken" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Threading.Tasks.Task&lt;System.Collections.Generic.IReadOnlyList&lt;Microsoft.Azure.Cosmos.FeedRange&gt;&gt;</ReturnType>

</ReturnValue>

<Parameters>

<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />

</Parameters>

<Docs>

<param name="cancellationToken">(Optional) <see cref="T:System.Threading.CancellationToken" /> representing request cancellation.</param>

<summary>

Obtains a list of <see cref="T:Microsoft.Azure.Cosmos.FeedRange" /> that can be used to parallelize Feed operations.

</summary>

<returns>A list of <see cref="T:Microsoft.Azure.Cosmos.FeedRange" />.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<Member MemberName="GetItemLinqQueryable&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract System.Linq.IOrderedQueryable&lt;T&gt; GetItemLinqQueryable&lt;T&gt; (bool allowSynchronousQueryExecution = false, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default, Microsoft.Azure.Cosmos.CosmosLinqSerializerOptions linqSerializerOptions = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Linq.IOrderedQueryable`1&lt;!!T&gt; GetItemLinqQueryable&lt;T&gt;(bool allowSynchronousQueryExecution, string continuationToken, class Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions, class Microsoft.Azure.Cosmos.CosmosLinqSerializerOptions linqSerializerOptions) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetItemLinqQueryable``1(System.Boolean,System.String,Microsoft.Azure.Cosmos.QueryRequestOptions,Microsoft.Azure.Cosmos.CosmosLinqSerializerOptions)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetItemLinqQueryable(Of T) (Optional allowSynchronousQueryExecution As Boolean = false, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional linqSerializerOptions As CosmosLinqSerializerOptions = Nothing) As IOrderedQueryable(Of T)" />

<MemberSignature Language="F#" Value="abstract member GetItemLinqQueryable : bool * string * Microsoft.Azure.Cosmos.QueryRequestOptions * Microsoft.Azure.Cosmos.CosmosLinqSerializerOptions -&gt; System.Linq.IOrderedQueryable&lt;'T&gt;" Usage="container.GetItemLinqQueryable (allowSynchronousQueryExecution, continuationToken, requestOptions, linqSerializerOptions)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>System.Linq.IOrderedQueryable&lt;T&gt;</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="allowSynchronousQueryExecution" Type="System.Boolean" />

<Parameter Name="continuationToken" Type="System.String" />

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.QueryRequestOptions" />

<Parameter Name="linqSerializerOptions" Type="Microsoft.Azure.Cosmos.CosmosLinqSerializerOptions" />

</Parameters>

<Docs>

<typeparam name="T">The type of object to query.</typeparam>

<param name="allowSynchronousQueryExecution">(Optional)the option which allows the query to be executed synchronously via IOrderedQueryable.</param>

<param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>

<param name="requestOptions">(Optional) The options for the item query request.</param>

<param name="linqSerializerOptions">(Optional) The options to configure Linq Serializer Properties. This overrides properties in CosmosSerializerOptions while creating client</param>

<summary>

This method creates a LINQ query for items under a container in an Azure Cosmos DB service.

IQueryable extension method ToFeedIterator() should be use for asynchronous execution with FeedIterator, please refer to example 2.

</summary>

<returns>(Optional) An IOrderedQueryable{T} that can evaluate the query.</returns>

<remarks>

LINQ execution is synchronous which will cause issues related to blocking calls.

It is recommended to always use ToFeedIterator(), and to do the asynchronous execution.

</remarks>

<remarks>

The Azure Cosmos DB LINQ provider compiles LINQ to SQL statements. Refer to https://docs.microsoft.com/azure/cosmos-db/sql-query-linq-to-sql for the list of expressions supported by the Azure Cosmos DB LINQ provider. ToString() on the generated IQueryable returns the translated SQL statement. The Azure Cosmos DB provider translates JSON.NET and DataContract serialization attributes for members to their JSON property names.

</remarks>

<example>

1. This example below shows LINQ query generation and blocked execution.

<code language="c#"><![CDATA[

public class Book

{

public string Title {get; set;}

public Author Author {get; set;}

public int Price {get; set;}

}

public class Author

{

public string FirstName {get; set;}

public string LastName {get; set;}

}

// Query by the Title property

Book book = container.GetItemLinqQueryable<Book>(true)

.Where(b => b.Title == "War and Peace")

.AsEnumerable()

.FirstOrDefault();

// Query a nested property

Book otherBook = container.GetItemLinqQueryable<Book>(true)

.Where(b => b.Author.FirstName == "Leo")

.AsEnumerable()

.FirstOrDefault();

// Perform iteration on books

foreach (Book matchingBook in container.GetItemLinqQueryable<Book>(true)

.Where(b => b.Price > 100))

{

// Iterate through books

}

]]></code></example>

<example>

2. This example below shows LINQ query generation and asynchronous execution with FeedIterator.

<code language="c#"><![CDATA[

// LINQ query generation

using (FeedIterator<Book> setIterator = container.GetItemLinqQueryable<Book>()

.Where(b => b.Title == "War and Peace")

.ToFeedIterator())

{

//Asynchronous query execution

while (setIterator.HasMoreResults)

{

foreach(var item in await setIterator.ReadNextAsync())

{

Console.WriteLine(item.Price);

}

}

}

]]></code></example>

<altmember cref="T:Microsoft.Azure.Cosmos.CosmosSerializationOptions" />

</Docs>

</Member>

<Member MemberName="GetItemQueryIterator&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator&lt;T&gt; GetItemQueryIterator&lt;T&gt; (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator`1&lt;!!T&gt; GetItemQueryIterator&lt;T&gt;(class Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken, class Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetItemQueryIterator``1(Microsoft.Azure.Cosmos.QueryDefinition,System.String,Microsoft.Azure.Cosmos.QueryRequestOptions)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetItemQueryIterator(Of T) (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator(Of T)" />

<MemberSignature Language="F#" Value="abstract member GetItemQueryIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -&gt; Microsoft.Azure.Cosmos.FeedIterator&lt;'T&gt;" Usage="container.GetItemQueryIterator (queryDefinition, continuationToken, requestOptions)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.FeedIterator&lt;T&gt;</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="queryDefinition" Type="Microsoft.Azure.Cosmos.QueryDefinition" />

<Parameter Name="continuationToken" Type="System.String" />

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.QueryRequestOptions" />

</Parameters>

<Docs>

<typeparam name="T">To be added.</typeparam>

<param name="queryDefinition">The Cosmos SQL query definition.</param>

<param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>

<param name="requestOptions">(Optional) The options for the item query request.</param>

<summary>

This method creates a query for items under a container in an Azure Cosmos database using a SQL statement with parameterized values. It returns a FeedIterator.

For more information on preparing SQL statements with parameterized values, please see <see cref="T:Microsoft.Azure.Cosmos.QueryDefinition" />.

</summary>

<returns>An iterator to go through the items.</returns>

<remarks>To be added.</remarks>

<example>

Create a query to get all the ToDoActivity that have a cost greater than 9000

<code language="c#"><![CDATA[

public class ToDoActivity{

public string id {get; set;}

public string status {get; set;}

public int cost {get; set;}

}

QueryDefinition queryDefinition = new QueryDefinition("select * from ToDos t where t.cost > @expensive")

.WithParameter("@expensive", 9000);

using (FeedIterator<ToDoActivity> feedIterator = this.Container.GetItemQueryIterator<ToDoActivity>(

queryDefinition,

null,

new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))

{

while (feedIterator.HasMoreResults)

{

foreach(var item in await feedIterator.ReadNextAsync())

{

Console.WriteLine(item.cost);

}

}

}

]]></code></example>

</Docs>

</Member>

<Member MemberName="GetItemQueryIterator&lt;T&gt;">

<MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator&lt;T&gt; GetItemQueryIterator&lt;T&gt; (string queryText = default, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);" />

<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator`1&lt;!!T&gt; GetItemQueryIterator&lt;T&gt;(string queryText, string continuationToken, class Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions) cil managed" />

<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Container.GetItemQueryIterator``1(System.String,System.String,Microsoft.Azure.Cosmos.QueryRequestOptions)" />

<MemberSignature Language="VB.NET" Value="Public MustOverride Function GetItemQueryIterator(Of T) (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator(Of T)" />

<MemberSignature Language="F#" Value="abstract member GetItemQueryIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -&gt; Microsoft.Azure.Cosmos.FeedIterator&lt;'T&gt;" Usage="container.GetItemQueryIterator (queryText, continuationToken, requestOptions)" />

<MemberType>Method</MemberType>

<AssemblyInfo>

<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>

<AssemblyVersion>3.39.0.0</AssemblyVersion>

</AssemblyInfo>

<ReturnValue>

<ReturnType>Microsoft.Azure.Cosmos.FeedIterator&lt;T&gt;</ReturnType>

</ReturnValue>

<TypeParameters>

<TypeParameter Name="T" />

</TypeParameters>

<Parameters>

<Parameter Name="queryText" Type="System.String" />

<Parameter Name="continuationToken" Type="System.String" />

<Parameter Name="requestOptions" Type="Microsoft.Azure.Cosmos.QueryRequestOptions" />

</Parameters>

<Docs>

<typeparam name="T">To be added.</typeparam>

<param name="queryText">The Cosmos SQL query text.</param>

<param name="continuationToken">(Optional) The continuation token in the Azure Cosmos DB service.</param>

<param name="requestOptions">(Optional) The options for the item query request.</param>

<summary>

This method creates a query for items under a container in an Azure Cosmos database using a SQL statement. It returns a FeedIterator.

</summary>

<returns>An iterator to go through the items.</returns>

<remarks>To be added.</remarks>

<example>

1. Create a query to get all the ToDoActivity that have a cost greater than 9000

<code language="c#"><![CDATA[

public class ToDoActivity{

public string id {get; set;}

public string status {get; set;}

public int cost {get; set;}

}

using (FeedIterator<ToDoActivity> feedIterator = this.Container.GetItemQueryIterator<ToDoActivity>(

"select * from ToDos t where t.cost > 9000",

null,

new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))

{

while (feedIterator.HasMoreResults)

{

foreach(var item in await feedIterator.ReadNextAsync())

{

Console.WriteLine(item.cost);

}

}

}

]]></code></example>

<example>

2. Create a FeedIterator to get all the ToDoActivity.

<code language="c#"><![CDATA[

public class ToDoActivity{

public string id {get; set;}

public string status {get; set;}

public int cost {get; set;}

}

using (FeedIterator<ToDoActivity> feedIterator = this.Container.GetItemQueryIterator<ToDoActivity>(

null,

null,

new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))

{

while (feedIterator.HasMoreResults)

{

foreach(var item in await feedIterator.ReadNextAsync())

{

Console.WriteLine(item.cost);

}

}