Share via


User.DeleteAsync(RequestOptions, CancellationToken) Method

Definition

Delete a UserProperties from the Azure Cosmos DB service as an asynchronous operation.

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

Parameters

requestOptions
RequestOptions

(Optional) The options for the user request.

cancellationToken
CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

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

Examples

User user = this.database.GetUser("userId");
UserResponse response = await user.DeleteUserAsync();

Applies to