Share via

IChangeFeedDocumentClient.ReadPartitionKeyRangeFeedAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents.ChangeFeedProcessor.DataAccess
Assembly:
Microsoft.Azure.Documents.ChangeFeedProcessor.dll
Package:
Microsoft.Azure.DocumentDB.ChangeFeedProcessor v2.4.0

Reads the feed (sequence) of PartitionKeyRange for a database account from the Azure Cosmos DB service as an asynchronous operation.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.IFeedResponse<Microsoft.Azure.Documents.PartitionKeyRange>> ReadPartitionKeyRangeFeedAsync (string partitionKeyRangesOrCollectionLink, Microsoft.Azure.Documents.Client.FeedOptions options = default);
abstract member ReadPartitionKeyRangeFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.IFeedResponse<Microsoft.Azure.Documents.PartitionKeyRange>>
Public Function ReadPartitionKeyRangeFeedAsync (partitionKeyRangesOrCollectionLink As String, Optional options As FeedOptions = Nothing) As Task(Of IFeedResponse(Of PartitionKeyRange))

Parameters

partitionKeyRangesOrCollectionLink
String

The link of the resources to be read, or owner collection link, SelfLink or AltLink. E.g. /dbs/db_rid/colls/coll_rid/pkranges

options
FeedOptions

The request options for the request.

Returns

Task<IFeedResponse<PartitionKeyRange>>

A System.Threading.Tasks containing a IResourceResponse<TResource> which wraps a Database containing the read resource record.

Applies to