PartitionKey Struct

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.39.0

Source:

PartitionKey.cs

Represents a partition key value in the Azure Cosmos DB service.

public readonly struct PartitionKey : IEquatable<Microsoft.Azure.Cosmos.PartitionKey>

type PartitionKey = struct

Public Structure PartitionKey
Implements IEquatable(Of PartitionKey)

Inheritance

ValueType

PartitionKey

Implements

IEquatable<PartitionKey>

Constructors

PartitionKey(Boolean)	Creates a new partition key value.
PartitionKey(Double)	Creates a new partition key value.
PartitionKey(String)	Creates a new partition key value.

Fields

None	The returned object represents a partition key value that allows creating and accessing items without a value for partition key.
Null	The returned object represents a partition key value that allows creating and accessing items with a null value for the partition key.
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

Methods

Equals(Object)	Determines whether the specified object is equal to the current object.
Equals(PartitionKey)	Returns a value indicating whether this instance is equal to a specified partition key.
GetHashCode()	Returns the hash code for this partition key.
ToString()	Gets the string representation of the partition key value.

Operators

Equality(PartitionKey, PartitionKey)	Determines whether two specified instances of the PartitionKey are equal.
Inequality(PartitionKey, PartitionKey)	Determines whether two specified instances of the PartitionKey are not equal.