FeedOptions.PartitionKey プロパティ

  • リファレンス

定義

名前空間:
Microsoft.Azure.Documents.Client
アセンブリ:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
パッケージ:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Azure Cosmos DB サービスの PartitionKey 現在の要求の を取得または設定します。

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

プロパティ値

PartitionKey

例

次の例は、 を使用してパーティション分割されたコレクション内のドキュメント フィードを読み取る方法を PartitionKey示しています。 この例では、すべてのドキュメントの 'country' プロパティに を使用 PartitionKeyDefinition してコレクションが作成されていることを前提としています。

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

注釈

パーティション キーは、パーティション分割されたコレクション内のドキュメントまたは添付ファイルフィードを読み取る場合に必要です。 具体的には、 にパーティション キーが必要です。 ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)ReadAttachmentFeedAsync(String, FeedOptions, CancellationToken)ReadConflictFeedAsync(String, FeedOptions) を含む PartitionKey パーティション内のドキュメントのみが結果に返されます。

適用対象

こちらもご覧ください