-
Notifications
You must be signed in to change notification settings - Fork 260
/
PermissionProperties.xml
341 lines (341 loc) · 20.7 KB
/
PermissionProperties.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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<Type Name="PermissionProperties" FullName="Microsoft.Azure.Cosmos.PermissionProperties">
<TypeSignature Language="C#" Value="public class PermissionProperties" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PermissionProperties extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.PermissionProperties" />
<TypeSignature Language="VB.NET" Value="Public Class PermissionProperties" />
<TypeSignature Language="F#" Value="type PermissionProperties = 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 a permission in the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PermissionProperties (string id, Microsoft.Azure.Cosmos.PermissionMode permissionMode, Microsoft.Azure.Cosmos.Container container, Microsoft.Azure.Cosmos.PartitionKey? resourcePartitionKey = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, valuetype Microsoft.Azure.Cosmos.PermissionMode permissionMode, class Microsoft.Azure.Cosmos.Container container, valuetype System.Nullable`1<valuetype Microsoft.Azure.Cosmos.PartitionKey> resourcePartitionKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.PermissionProperties.#ctor(System.String,Microsoft.Azure.Cosmos.PermissionMode,Microsoft.Azure.Cosmos.Container,System.Nullable{Microsoft.Azure.Cosmos.PartitionKey})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As String, permissionMode As PermissionMode, container As Container, Optional resourcePartitionKey As Nullable(Of PartitionKey) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.PermissionProperties : string * Microsoft.Azure.Cosmos.PermissionMode * Microsoft.Azure.Cosmos.Container * Nullable<Microsoft.Azure.Cosmos.PartitionKey> -> Microsoft.Azure.Cosmos.PermissionProperties" Usage="new Microsoft.Azure.Cosmos.PermissionProperties (id, permissionMode, container, resourcePartitionKey)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="permissionMode" Type="Microsoft.Azure.Cosmos.PermissionMode" />
<Parameter Name="container" Type="Microsoft.Azure.Cosmos.Container" />
<Parameter Name="resourcePartitionKey" Type="System.Nullable<Microsoft.Azure.Cosmos.PartitionKey>" />
</Parameters>
<Docs>
<param name="id">The permission id.</param>
<param name="permissionMode">The <see cref="P:Microsoft.Azure.Cosmos.PermissionProperties.PermissionMode" />.</param>
<param name="container">The <see cref="T:Microsoft.Azure.Cosmos.Container" /> object.</param>
<param name="resourcePartitionKey">(Optional) The partition key value for the permission in the Azure Cosmos DB service.</param>
<summary>
Initialize a new instance of the <see cref="T:Microsoft.Azure.Cosmos.PermissionProperties" /> with permission to <see cref="T:Microsoft.Azure.Cosmos.Container" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PermissionProperties (string id, Microsoft.Azure.Cosmos.PermissionMode permissionMode, Microsoft.Azure.Cosmos.Container container, Microsoft.Azure.Cosmos.PartitionKey resourcePartitionKey, string itemId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, valuetype Microsoft.Azure.Cosmos.PermissionMode permissionMode, class Microsoft.Azure.Cosmos.Container container, valuetype Microsoft.Azure.Cosmos.PartitionKey resourcePartitionKey, string itemId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.PermissionProperties.#ctor(System.String,Microsoft.Azure.Cosmos.PermissionMode,Microsoft.Azure.Cosmos.Container,Microsoft.Azure.Cosmos.PartitionKey,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As String, permissionMode As PermissionMode, container As Container, resourcePartitionKey As PartitionKey, itemId As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.PermissionProperties : string * Microsoft.Azure.Cosmos.PermissionMode * Microsoft.Azure.Cosmos.Container * Microsoft.Azure.Cosmos.PartitionKey * string -> Microsoft.Azure.Cosmos.PermissionProperties" Usage="new Microsoft.Azure.Cosmos.PermissionProperties (id, permissionMode, container, resourcePartitionKey, itemId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="permissionMode" Type="Microsoft.Azure.Cosmos.PermissionMode" />
<Parameter Name="container" Type="Microsoft.Azure.Cosmos.Container" />
<Parameter Name="resourcePartitionKey" Type="Microsoft.Azure.Cosmos.PartitionKey" />
<Parameter Name="itemId" Type="System.String" />
</Parameters>
<Docs>
<param name="id">The permission id.</param>
<param name="permissionMode">The <see cref="P:Microsoft.Azure.Cosmos.PermissionProperties.PermissionMode" />.</param>
<param name="container">The <see cref="T:Microsoft.Azure.Cosmos.Container" /> object.</param>
<param name="resourcePartitionKey">The <see cref="T:Microsoft.Azure.Cosmos.PartitionKey" /> of the resource in the Azure Cosmos service.</param>
<param name="itemId">The cosmos item id</param>
<summary>
Initialize a new instance of the <see cref="T:Microsoft.Azure.Cosmos.PermissionProperties" /> with permission to Cosmos item.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ETag">
<MemberSignature Language="C#" Value="public string ETag { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ETag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PermissionProperties.ETag" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ETag As String" />
<MemberSignature Language="F#" Value="member this.ETag : string" Usage="Microsoft.Azure.Cosmos.PermissionProperties.ETag" />
<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(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_etag")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_etag")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the entity tag associated with the resource from the Azure Cosmos DB service.
</summary>
<value>
The entity tag associated with the resource.
</value>
<remarks>
ETags are used for concurrency checking when updating resources.
</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PermissionProperties.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="Microsoft.Azure.Cosmos.PermissionProperties.Id" />
<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="id")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="id")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Id of the resource in the Azure Cosmos DB service.
</summary>
<value>The Id associated with the resource.</value>
<remarks>
<para>
Every resource within an Azure Cosmos DB database account needs to have a unique identifier.
</para>
<para>
The following characters are restricted and cannot be used in the Id property:
'/', '\\', '?', '#'
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="LastModified">
<MemberSignature Language="C#" Value="public DateTime? LastModified { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> LastModified" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PermissionProperties.LastModified" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastModified As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.LastModified : Nullable<DateTime>" Usage="Microsoft.Azure.Cosmos.PermissionProperties.LastModified" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.UnixDateTimeConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.UnixDateTimeConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_ts")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_ts")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the last modified time stamp associated with <see cref="T:Microsoft.Azure.Cosmos.PermissionProperties" /> from the Azure Cosmos DB service.
</summary>
<value>The last modified time stamp associated with the resource.</value>
<remarks>ResourceToken generation and reading does not apply.</remarks>
</Docs>
</Member>
<Member MemberName="PermissionMode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.PermissionMode PermissionMode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Cosmos.PermissionMode PermissionMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PermissionProperties.PermissionMode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PermissionMode As PermissionMode" />
<MemberSignature Language="F#" Value="member this.PermissionMode : Microsoft.Azure.Cosmos.PermissionMode" Usage="Microsoft.Azure.Cosmos.PermissionProperties.PermissionMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="permissionMode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="permissionMode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.PermissionMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the permission mode in the Azure Cosmos DB service.
</summary>
<value>
The <see cref="P:Microsoft.Azure.Cosmos.PermissionProperties.PermissionMode" /> mode: Read or All.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourcePartitionKey">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.PartitionKey? ResourcePartitionKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Cosmos.PartitionKey> ResourcePartitionKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PermissionProperties.ResourcePartitionKey" />
<MemberSignature Language="VB.NET" Value="Public Property ResourcePartitionKey As Nullable(Of PartitionKey)" />
<MemberSignature Language="F#" Value="member this.ResourcePartitionKey : Nullable<Microsoft.Azure.Cosmos.PartitionKey> with get, set" Usage="Microsoft.Azure.Cosmos.PermissionProperties.ResourcePartitionKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Cosmos.PartitionKey></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets optional partition key value for the permission in the Azure Cosmos DB service.
A permission applies to resources when two conditions are met:
1. <see cref="P:Microsoft.Azure.Cosmos.PermissionProperties.ResourceUri" /> is prefix of resource's link.
For example "/dbs/mydatabase/colls/mycollection" applies to "/dbs/mydatabase/colls/mycollection" and "/dbs/mydatabase/colls/mycollection/docs/mydocument"
2. <see cref="P:Microsoft.Azure.Cosmos.PermissionProperties.ResourcePartitionKey" /> is superset of resource's partition key.
For example absent/empty partition key is superset of all partition keys.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourceUri">
<MemberSignature Language="C#" Value="public string ResourceUri { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ResourceUri" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PermissionProperties.ResourceUri" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ResourceUri As String" />
<MemberSignature Language="F#" Value="member this.ResourceUri : string" Usage="Microsoft.Azure.Cosmos.PermissionProperties.ResourceUri" />
<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="resource")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="resource")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the self-uri of resource to which the permission applies in the Azure Cosmos DB service.
</summary>
<value>
The-uri of the resource to which the permission applies.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SelfLink">
<MemberSignature Language="C#" Value="public string SelfLink { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SelfLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PermissionProperties.SelfLink" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SelfLink As String" />
<MemberSignature Language="F#" Value="member this.SelfLink : string" Usage="Microsoft.Azure.Cosmos.PermissionProperties.SelfLink" />
<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(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_self")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_self")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the self-link associated with the resource from the Azure Cosmos DB service.
</summary>
<value>The self-link associated with the resource.</value>
<remarks>
A self-link is a static addressable Uri for each resource within a database account and follows the Azure Cosmos DB resource model.
E.g. a self-link for a document could be dbs/db_resourceid/colls/coll_resourceid/documents/doc_resourceid
</remarks>
</Docs>
</Member>
<Member MemberName="Token">
<MemberSignature Language="C#" Value="public string Token { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Token" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PermissionProperties.Token" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Token As String" />
<MemberSignature Language="F#" Value="member this.Token : string" Usage="Microsoft.Azure.Cosmos.PermissionProperties.Token" />
<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(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_token")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_token")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the access token granting the defined permission from the Azure Cosmos DB service.
</summary>
<value>
The access token granting the defined permission.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>