Database.UpsertUserAsync(String, RequestOptions, CancellationToken) Método

Definição

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Pacote:

Microsoft.Azure.Cosmos v3.36.0

Upserts um usuário como uma operação assíncrona no serviço do Azure Cosmos.

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse> UpsertUserAsync (string id, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpsertUserAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.UserResponse>

Public MustOverride Function UpsertUserAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UserResponse)

Parâmetros

id

String

A ID de usuário do Cosmos.

requestOptions

RequestOptions

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

cancellationToken

CancellationToken

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

Retornos

Task<UserResponse>

Um Task que contém um UserResponse que encapsula um UserProperties que contém o registro de recurso de leitura.

Exceções

ArgumentNullException

Se id não estiver definido.

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
400	BadRequest - Isso significa que algo estava errado com a solicitação fornecida. É provável que uma ID não tenha sido fornecida para o novo usuário.

Exemplos

UserResponse response = await this.cosmosDatabase.UpsertUserAsync(Guid.NewGuid().ToString());