IPartitionResolver.GetPartitionKey(Object) Method

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Client

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

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Extracts the partition key from a document in the Azure Cosmos DB service.

public object GetPartitionKey (object document);

abstract member GetPartitionKey : obj -> obj

Public Function GetPartitionKey (document As Object) As Object

Parameters

document: Object

A document object.

Returns

Object

The partition key for the document.

Remarks

Typical implementations will get the value of a single property from the document (e.g., user ID) or extract a compound property, for e.g., version ID, device #) or implement custom logic based on the type of the document, for e.g., extract value of id for users but extract userId for userMessages.

Applies to