/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents/Permission.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
186 lines (186 sloc) 8.46 KB
<Type Name="Permission" FullName="Microsoft.Azure.Documents.Permission">
<TypeSignature Language="C#" Value="public class Permission : Microsoft.Azure.Documents.Resource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Permission extends Microsoft.Azure.Documents.Resource" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Permission" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Documents.Resource</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a per-User permission to access a specific resource in the Azure DocumentDB database service, for example Document or Collection.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Permission ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Permission.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PermissionMode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.PermissionMode PermissionMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Documents.PermissionMode PermissionMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Permission.PermissionMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))</AttributeName>
</Attribute>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="permissionMode")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.PermissionMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the permission mode in the Azure DocumentDB database service.
</summary>
<value>
The <see cref="P:Microsoft.Azure.Documents.Permission.PermissionMode" /> mode: Read or All.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourceLink">
<MemberSignature Language="C#" Value="public string ResourceLink { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ResourceLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Permission.ResourceLink" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="resource")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the self-link of resource to which the permission applies in the Azure DocumentDB database service.
</summary>
<value>
The self-link of the resource to which the permission applies.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourcePartitionKey">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Documents.PartitionKey ResourcePartitionKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Documents.PartitionKey ResourcePartitionKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Permission.ResourcePartitionKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="resourcePartitionKey")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.PartitionKey</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets optional partition key value for the permission in the Azure DocumentDB database service.
A permission applies to resources when two conditions are met:
1. <see cref="P:Microsoft.Azure.Documents.Permission.ResourceLink" /> 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.Documents.Permission.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="Token">
<MemberSignature Language="C#" Value="public string Token { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Token" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Permission.Token" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="_token")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the access token granting the defined permission from the Azure DocumentDB database service.
</summary>
<value>
The access token granting the defined permission.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>