-
Notifications
You must be signed in to change notification settings - Fork 260
/
AccessCondition.xml
137 lines (137 loc) · 6.6 KB
/
AccessCondition.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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<Type Name="AccessCondition" FullName="Microsoft.Azure.Documents.Client.AccessCondition">
<TypeSignature Language="C#" Value="public sealed class AccessCondition" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AccessCondition extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Client.AccessCondition" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class AccessCondition" />
<TypeSignature Language="F#" Value="type AccessCondition = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a set of access conditions to be used for operations in the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
<altmember cref="T:Microsoft.Azure.Documents.Client.RequestOptions" />
<altmember cref="T:Microsoft.Azure.Documents.Resource" />
<altmember cref="T:Microsoft.Azure.Documents.Client.AccessConditionType" />
<example>
The following example shows how to use AccessCondition with DocumentClient.
<code language="c#"><![CDATA[
// If ETag is current, then this will succeed. Otherwise the request will fail with HTTP 412 Precondition Failure
await client.ReplaceDocumentAsync(
readCopyOfBook.SelfLink,
new Book { Title = "Moby Dick", Price = 14.99 },
new RequestOptions
{
AccessCondition = new AccessCondition
{
Condition = readCopyOfBook.ETag,
Type = AccessConditionType.IfMatch
}
});
]]></code></example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AccessCondition ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.AccessCondition.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Condition">
<MemberSignature Language="C#" Value="public string Condition { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Condition" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.AccessCondition.Condition" />
<MemberSignature Language="VB.NET" Value="Public Property Condition As String" />
<MemberSignature Language="F#" Value="member this.Condition : string with get, set" Usage="Microsoft.Azure.Documents.Client.AccessCondition.Condition" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the value of the condition in the Azure Cosmos DB service.
</summary>
<value>
The value of the condition. For <see cref="T:Microsoft.Azure.Documents.Client.AccessConditionType" /> IfMatch and IfNotMatch, this is the ETag that has to be compared to.
</value>
<remarks>To be added.</remarks>
<altmember cref="T:Microsoft.Azure.Documents.Resource" />
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.Client.AccessConditionType Type { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Documents.Client.AccessConditionType Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.AccessCondition.Type" />
<MemberSignature Language="VB.NET" Value="Public Property Type As AccessConditionType" />
<MemberSignature Language="F#" Value="member this.Type : Microsoft.Azure.Documents.Client.AccessConditionType with get, set" Usage="Microsoft.Azure.Documents.Client.AccessCondition.Type" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.Client.AccessConditionType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the condition type in the Azure Cosmos DB service.
</summary>
<value>
The condition type. Can be IfMatch or IfNoneMatch.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>