IDocumentClient.DeleteUserAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents
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

DeleteUserAsync(String, RequestOptions)

Delete a User from the Azure Cosmos DB service as an asynchronous operation.
DeleteUserAsync(Uri, RequestOptions)

Delete a user as an asynchronous operation in the Azure Cosmos DB service.

DeleteUserAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> DeleteUserAsync (string userLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member DeleteUserAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>
Public Function DeleteUserAsync (userLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

Parameters

userLink
String

The link of the User to delete. E.g. dbs/db_rid/users/user_rid/

options
RequestOptions

(Optional) The request options for the request.

Returns

Task<ResourceResponse<User>>

A System.Threading.Tasks containing a ResourceResponse<TResource> which will contain information about the request issued.

Exceptions

ArgumentNullException

If userLink is not set.

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:

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

Examples

//Delete a user using its selfLink property.
//To get the userLink you would have to query for the User object, using CreateUserQuery(), and then refer to its .SelfLink property
await client.DeleteUserAsync(userLink);

See also

Applies to

DeleteUserAsync(Uri, RequestOptions)

Delete a user as an asynchronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> DeleteUserAsync (Uri userUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member DeleteUserAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>
Public Function DeleteUserAsync (userUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

Parameters

userUri
Uri

The URI of the user to delete.

options
RequestOptions

(Optional) The RequestOptions for the request.

Returns

Task<ResourceResponse<User>>

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

Applies to