RequestOptions.PartitionKey Eigenschaft

Definition

Namespace:

Microsoft.Azure.Documents.Client

Assemblys:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Pakete:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Ruft die für die PartitionKey aktuelle Anforderung im Azure Cosmos DB-Dienst ab oder legt diese fest.

public Microsoft.Azure.Documents.PartitionKey PartitionKey { get; set; }

member this.PartitionKey : Microsoft.Azure.Documents.PartitionKey with get, set

Public Property PartitionKey As PartitionKey

Eigenschaftswert

PartitionKey

Beispiele

Das folgende Beispiel zeigt, wie ein Dokument in einer partitionierten Auflistung mit gelesen wird PartitionKey. Im Beispiel wird davon ausgegangen, dass die Auflistung mit einer PartitionKeyDefinition der Eigenschaft "id" in allen Dokumenten erstellt wird.

await client.ReadDocumentAsync(
    document.SelfLink,
    new RequestOptions { PartitionKey = new PartitionKey(document.Id) } );

Hinweise

Der Partitionsschlüssel wird verwendet, um die Zielpartition für diese Anforderung zu identifizieren. Sie muss für Lese- und Löschvorgänge für alle Dokumentanforderungen festgelegt werden. Erstellen, Lesen, Aktualisieren und Löschen von Vorgängen für alle Anforderungen an Dokumentanlagen; und führen Sie den Vorgang für gespeicherte Produktionen aus.

Für Erstellungs- und Aktualisierungsvorgänge für Dokumente ist der Partitionsschlüssel optional. Wenn sie nicht vorhanden ist, extrahiert die Clientbibliothek den Partitionsschlüssel aus dem Dokument, bevor die Anforderung an den Server gesendet wird.

Weitere Informationen

• DocumentCollection
• PartitionKeyDefinition