FeedOptions.PartitionKey Property


Gets or sets the PartitionKey for the current request in the Azure Cosmos DB service.

public Microsoft.Azure.Documents.PartitionKey PartitionKey { get; set; }
member this.PartitionKey : Microsoft.Azure.Documents.PartitionKey with get, set
Public Property PartitionKey As PartitionKey

Property Value


The following example shows how to read a document feed in a partitioned collection using PartitionKey. The example assumes the collection is created with a PartitionKeyDefinition on the 'country' property in all the documents.

await client.ReadDocumentFeedAsync(
    new RequestOptions { PartitionKey = new PartitionKey("USA") } );


Partition key is required when read documents or attachments feed in a partitioned collection. Specifically Partition key is required for : ReadDocumentFeedAsync(String, FeedOptions, CancellationToken), ReadAttachmentFeedAsync(String, FeedOptions, CancellationToken) and ReadConflictFeedAsync(String, FeedOptions). Only documents in partitions containing the PartitionKey is returned in the result.

Applies to

See also