IDocumentClient.ReadUserAsync Método

Definición

Sobrecargas

ReadUserAsync(String, RequestOptions)

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

ReadUserAsync(Uri, RequestOptions)

Lee como User una operación asincrónica desde el servicio Azure Cosmos DB.

ReadUserAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> ReadUserAsync (string userLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadUserAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>
Public Function ReadUserAsync (userLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

Parámetros

userLink
String

Vínculo al recurso Usuario que se va a leer.

options
RequestOptions

(Opcional) Opciones de solicitud para la solicitud.

Devoluciones

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene User el registro de recursos de lectura.

Excepciones

Si userLink no se establece.

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 documento son:

StatusCodeMotivo de la excepción
404NotFound: significa que el recurso que intentó leer no existía.
429TooManyRequests: 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

//Reads a User resource from a Database
// - sample_database is the ID of the database
// - user_id is the ID of the user to be read
var userLink = "/dbs/sample_database/users/user_id";
User user = await client.ReadUserAsync(userLink);

Comentarios

Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso de la base de datos. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.

En el ejemplo que se muestra se usan vínculos basados en identificadores, donde el vínculo se compone de las propiedades de identificador usadas cuando se crearon los recursos. Si lo prefiere, puede usar la SelfLink propiedad del usuario. Un auto-vínculo es un URI para un recurso que se compone de identificadores de recursos (o las propiedades de _rid). Los vínculos basados en identificadores y SelfLink funcionarán. El formato de userLink siempre es "/dbs/{db identifier}/users/{user identifier}" solo los valores del {...} cambian en función del método que desee usar para abordar el recurso.

Consulte también

Se aplica a

ReadUserAsync(Uri, RequestOptions)

Lee como User una operación asincrónica desde el servicio Azure Cosmos DB.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> ReadUserAsync (Uri userUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadUserAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>
Public Function ReadUserAsync (userUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

Parámetros

userUri
Uri

Un URI para el recurso usuario que se va a leer.

options
RequestOptions

Opciones de solicitud para la solicitud.

Devoluciones

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene User el registro de recursos de lectura.

Excepciones

Si userUri no se establece.

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 documento son:

StatusCodeMotivo de la excepción
404NotFound: significa que el recurso que intentó leer no existía.
429TooManyRequests: 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

//Reads a User resource where 
// - db_id is the ID property of the Database
// - user_id is the ID property of the User you wish to read. 
var userLink = UriFactory.CreateUserUri("db_id", "user_id");
User user = await client.ReadUserAsync(userLink);

Comentarios

Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso del servicio. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.

Consulte también

Se aplica a