Condividi tramite


CosmosPermission.DeleteAsync(RequestOptions, CancellationToken) Method

Definition

Delete a PermissionProperties from the Azure Cosmos DB service as an asynchronous operation. This will not revoke existing ResourceTokens.

public abstract System.Threading.Tasks.Task<Azure.Cosmos.PermissionResponse> DeleteAsync (Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.PermissionResponse>
Public MustOverride Function DeleteAsync (Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PermissionResponse)

Parameters

requestOptions
RequestOptions

(Optional) The options for the user request RequestOptions

cancellationToken
CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

A Task containing a PermissionResponse which will contain information about the request issued.

Exceptions

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 permission are:

StatusCodeReason for exception
404NotFound - This means the resource or parent resource you tried to delete did not exist.

Examples

CosmosUser user = this.database.GetUser("userId");
CosmosPermission permission = user.GetPermission("permissionId");
PermissionResponse response = await permission.DeleteAsync();

Applies to