CosmosUser.DeleteAsync(RequestOptions, CancellationToken) Méthode

Définition

Espace de noms:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Paquet:

Azure.Cosmos v4.0.0-preview3

Supprimez un UserProperties du service Azure Cosmos DB en tant qu’opération asynchrone.

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)

Paramètres

requestOptions

RequestOptions

(Facultatif) Options de la demande de l’utilisateur RequestOptions

cancellationToken

CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

Task<UserResponse>

Task contenant un qui contiendra des UserResponse informations sur la demande émise.

Exceptions

CosmosException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un utilisateur :

StatusCode	Raison de l’exception
404	NotFound : cela signifie que la ressource ou la ressource parente que vous avez tenté de supprimer n’existait pas.

Exemples

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