CosmosPermission.DeleteAsync(RequestOptions, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Cosmos

Assembly:: Azure.Cosmos.dll

Package:: Azure.Cosmos v4.0.0-preview3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Task<PermissionResponse>

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

Exceptions

CosmosException

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:

StatusCode	Reason for exception
404	NotFound - 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

Share via