CosmosUser.ReadAsync(RequestOptions, CancellationToken) Método

Definición

Espacio de nombres:

Azure.Cosmos

Ensamblado:

Azure.Cosmos.dll

Paquete:

Azure.Cosmos v4.0.0-preview3

Lee un UserProperties elemento del servicio Azure Cosmos como una operación asincrónica.

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

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

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

Parámetros

requestOptions

RequestOptions

(Opcional) Las opciones de la solicitud de usuario RequestOptions

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

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
404	NotFound: significa que el recurso o el recurso primario que intentó leer no existían.
429	TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación.

Ejemplos

CosmosUser user = this.database.GetUser("userId");
UserProperties userProperties = await user.ReadUserAsync();