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

Definición

Espacio de nombres:

Microsoft.Azure.Cosmos

Ensamblado:

Microsoft.Azure.Cosmos.Client.dll

Paquete:

Microsoft.Azure.Cosmos v3.36.0

Crea un usuario como una operación asincrónica en el servicio Azure Cosmos.

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

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

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

Parámetros

id

String

Identificador de usuario de Cosmos

requestOptions

RequestOptions

(Opcional) Las opciones de la solicitud de usuario.

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa la cancelación de la solicitud.

Devoluciones

Task<UserResponse>

que Task contiene un UserResponseUserProperties objeto que contiene el registro de recursos de lectura.

Excepciones

ArgumentNullException

Si id no se establece.

CosmosException

Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un usuario son:

StatusCode	Motivo de la excepción
400	BadRequest: esto significa que algo estaba mal con la solicitud proporcionada. Es probable que no se haya proporcionado un identificador para el nuevo usuario.
409	Conflicto: esto significa que un UserProperties elemento con un identificador que coincide con el identificador que proporcionó ya existía.

Ejemplos

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