UniqueKey Class

Definition

Represents a unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

public sealed class UniqueKey : Microsoft.Azure.Documents.JsonSerializable
type UniqueKey = class
    inherit JsonSerializable
Public NotInheritable Class UniqueKey
Inherits JsonSerializable
Inheritance

Remarks

1) For partitioned collections, the value of partition key is implicitly a part of each unique key. 2) Uniqueness constraint is also enforced for missing values. For instance, if unique key policy defines a unique key with single property path, there could be only one document that has missing value for this property.

Constructors

UniqueKey()

Properties

Paths

Gets or sets the paths, a set of which must be unique for each document in the Azure Cosmos DB service.

Methods

Equals(Object)
GetHashCode()
LoadFrom(JsonReader)

Loads the object from the specified JSON reader in the Azure Cosmos DB service.

(Inherited from JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)

Loads the object from the specified JSON reader in the Azure Cosmos DB service.

(Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)

Saves the object to the specified stream in the Azure Cosmos DB service.

(Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)

Saves the object to the specified stream in the Azure Cosmos DB service.

(Inherited from JsonSerializable)
ToString()

Returns the string representation of the object in the Azure Cosmos DB service.

(Inherited from JsonSerializable)

Applies to

See also