DocumentClient.CreatePermissionAsync Method

Definition

Namespace:

Microsoft.Azure.Documents.Client

Assemblies:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Overloads

CreatePermissionAsync(String, Permission, RequestOptions)	Creates a permission on a user object as an asychronous operation in the Azure Cosmos DB service.
CreatePermissionAsync(Uri, Permission, RequestOptions)	Creates a permission as an asychronous operation in the Azure Cosmos DB service.

CreatePermissionAsync(String, Permission, RequestOptions)

Creates a permission on a user object as an asychronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>> CreatePermissionAsync (string userLink, Microsoft.Azure.Documents.Permission permission, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member CreatePermissionAsync : string * Microsoft.Azure.Documents.Permission * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>>
override this.CreatePermissionAsync : string * Microsoft.Azure.Documents.Permission * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>>

Public Function CreatePermissionAsync (userLink As String, permission As Permission, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Permission))

Parameters

userLink

String

The link of the user to create the permission for. E.g. dbs/db_rid/users/user_rid/

permission

Permission

The Permission object.

options

RequestOptions

(Optional) The request options for the request.

Returns

Task<ResourceResponse<Permission>>

A task object representing the service response for the asynchronous operation which contains the created Permission object.

Implements

CreatePermissionAsync(String, Permission, RequestOptions)

Exceptions

ArgumentNullException

If either userLink or permission is not set.

AggregateException

Represents a consolidation of failures that occured during async processing. Look within InnerExceptions to find the actual exception(s)

DocumentClientException

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:

StatusCode	Reason for exception
400	BadRequest - This means something was wrong with the request supplied.
403	Forbidden - You have reached your quota of permission objects. Contact support to have this quota increased.
409	Conflict - This means a Permission with an id matching the id you supplied already existed.

Examples

//Create a read-only permission object for a specific user
Permission p = await client.CreatePermissionAsync(userLink, new Permission { Id = "ReadPermission", PermissionMode = PermissionMode.Read });

See also

• Permission
• RequestOptions
• ResourceResponse<TResource>
• Task

CreatePermissionAsync(Uri, Permission, RequestOptions)

Creates a permission as an asychronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>> CreatePermissionAsync (Uri userUri, Microsoft.Azure.Documents.Permission permission, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member CreatePermissionAsync : Uri * Microsoft.Azure.Documents.Permission * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>>
override this.CreatePermissionAsync : Uri * Microsoft.Azure.Documents.Permission * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Permission>>

Public Function CreatePermissionAsync (userUri As Uri, permission As Permission, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Permission))

Parameters

userUri

Uri

the URI of the user to create the permission for.

permission

Permission

the Microsoft.Azure.Documents.Permission object.

options

RequestOptions

The request options for the request.

Returns

Task<ResourceResponse<Permission>>

The task object representing the service response for the asynchronous operation.

Implements

CreatePermissionAsync(Uri, Permission, RequestOptions)