CosmosUser.DeleteAsync(RequestOptions, CancellationToken) Método

Definição

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Pacote:

Azure.Cosmos v4.0.0-preview3

Exclua um UserProperties do serviço do Azure Cosmos DB como uma operação assíncrona.

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)

Parâmetros

requestOptions

RequestOptions

(Opcional) As opções para a solicitação do usuário RequestOptions

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<UserResponse>

Um Task que contém um UserResponse que conterá informações sobre a solicitação emitida.

Exceções

CosmosException

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um usuário são:

StatusCode	Motivo da exceção
404	NotFound - Isso significa que o recurso ou recurso pai que você tentou excluir não existia.

Exemplos

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