PartitionKey Class

Reference

Definition

Namespace:: Microsoft.Azure.Documents

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.

Represents a partition key value that identifies the target partition of a collection in the Azure Cosmos DB service.

public sealed class PartitionKey

type PartitionKey = class

Public NotInheritable Class PartitionKey

Inheritance: Object
PartitionKey

Constructors

PartitionKey(Object)

Instantiate a new instance of the PartitionKey object.

Fields

SystemKeyName	The tag name to use in the documents for specifying a partition key value when inserting such documents into a migrated collection
SystemKeyPath	The partition key path in the collection definition for migrated collections

Properties

None	Instantiates a new instance of the PartitionKey object.

Methods

Equals(Object)	Overrides the Equal operator for object comparisons between two instances of PartitionKey.
FromJsonString(String)	Instantiate a new instance of the PartitionKey object.
GetHashCode()	Hash function to return the hash code for the object.
ToString()	Override the base ToString method to output the value of each key component, separated by a space.

Applies to

Share via