Share via

UniqueKey Class

  • Reference

Definition

Namespace:
Azure.Cosmos
Assembly:
Azure.Cosmos.dll
Package:
Azure.Cosmos v4.0.0-preview3

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

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonUniqueKeyConverter))]
public sealed class UniqueKey
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonUniqueKeyConverter))>]
type UniqueKey = class
Public NotInheritable Class UniqueKey
Inheritance
Object
UniqueKey
Attributes
JsonConverterAttribute

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 the paths, a set of which must be unique for each document in the Azure Cosmos DB service.

Applies to

See also