CosmosUser.DeleteAsync(RequestOptions, CancellationToken) Method
Definition
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 UserProperties from the Azure Cosmos DB service as an asynchronous operation.
public abstract System.Threading.Tasks.Task<Azure.Cosmos.UserResponse> 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.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 RequestOptions
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
A Task containing a UserResponse 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 user 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");
UserResponse response = await user.DeleteUserAsync();
