-
Notifications
You must be signed in to change notification settings - Fork 256
/
UniqueKeyPolicy.xml
75 lines (75 loc) · 4.02 KB
/
UniqueKeyPolicy.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<Type Name="UniqueKeyPolicy" FullName="Microsoft.Azure.Cosmos.UniqueKeyPolicy">
<TypeSignature Language="C#" Value="public sealed class UniqueKeyPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit UniqueKeyPolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.UniqueKeyPolicy" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class UniqueKeyPolicy" />
<TypeSignature Language="F#" Value="type UniqueKeyPolicy = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
</summary>
<remarks>
Unique key policies add a layer of data integrity to an Azure Cosmos container. They cannot be modified once the container is created.
<para>
Refer to <see>https://docs.microsoft.com/en-us/azure/cosmos-db/unique-keys</see> for additional information on how to specify
unique key policies.
</para></remarks>
<altmember cref="T:Microsoft.Azure.Cosmos.ContainerProperties" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public UniqueKeyPolicy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.UniqueKeyPolicy.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UniqueKeys">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<Microsoft.Azure.Cosmos.UniqueKey> UniqueKeys { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<class Microsoft.Azure.Cosmos.UniqueKey> UniqueKeys" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.UniqueKeyPolicy.UniqueKeys" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UniqueKeys As Collection(Of UniqueKey)" />
<MemberSignature Language="F#" Value="member this.UniqueKeys : System.Collections.ObjectModel.Collection<Microsoft.Azure.Cosmos.UniqueKey>" Usage="Microsoft.Azure.Cosmos.UniqueKeyPolicy.UniqueKeys" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="uniqueKeys")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="uniqueKeys")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<Microsoft.Azure.Cosmos.UniqueKey></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets collection of <see cref="T:Microsoft.Azure.Cosmos.UniqueKey" /> that guarantee uniqueness of documents in collection in the Azure Cosmos DB service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>