RangePartitionResolver<T>.GetPartitionKey(Object) Method

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Partitioning

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 the specified document using the specified PartitionKeyPropertyName property or PartitionKeyExtractor function in order of preference in the Azure Cosmos DB service.

public virtual object GetPartitionKey (object document);

abstract member GetPartitionKey : obj -> obj
override this.GetPartitionKey : obj -> obj

Public Overridable Function GetPartitionKey (document As Object) As Object

Parameters

document: Object

A document object

Returns

Object

object used as the partition key.

Implements

GetPartitionKey(Object)

Exceptions

InvalidOperationException

Thrown if unable to extract the partition key.

Applies to