DocumentClient.ReadUserAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Documents.Client

Assemblys:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Paquets:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Surcharges

ReadUserAsync(Uri, RequestOptions)	Lit un User en tant qu’opération asynchrone à partir du service Azure Cosmos DB.
ReadUserAsync(String, RequestOptions)	Lit un User à partir du service Azure Cosmos DB en tant qu’opération asynchrone.

ReadUserAsync(Uri, RequestOptions)

Lit un User en tant qu’opération asynchrone à partir du service 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>>
override this.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))

Paramètres

userUri

Uri

URI de la ressource Utilisateur à lire.

options

RequestOptions

Options de demande pour la demande.

Retours

Task<ResourceResponse<User>>

System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un User contenant l’enregistrement de ressource de lecture.

Implémente

ReadUserAsync(Uri, RequestOptions)

Exceptions

ArgumentNullException

Si userUri n’est pas défini.

DocumentClientException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCode	Raison de l’exception
404	NotFound : cela signifie que la ressource que vous avez essayé de lire n’existait pas.
429	TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour voir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

//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);

Remarques

La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir du service. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.

Voir aussi

• ResourceResponse<TResource>
• Task
• User
• RequestOptions

ReadUserAsync(String, RequestOptions)

Lit un User à partir du service Azure Cosmos DB en tant qu’opération asynchrone.

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>>
override this.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))

Paramètres

userLink

String

Lien vers la ressource Utilisateur à lire.

options

RequestOptions

(Facultatif) Options de demande pour la demande.

Retours

Task<ResourceResponse<User>>

System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un User contenant l’enregistrement de ressource de lecture.

Implémente

ReadUserAsync(String, RequestOptions)

Exceptions

ArgumentNullException

Si userLink n’est pas défini.

DocumentClientException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCode	Raison de l’exception
404	NotFound : cela signifie que la ressource que vous avez essayé de lire n’existait pas.
429	TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour voir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

//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);

Remarques

La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir de la base de données. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.

L’exemple ci-dessous utilise des liens basés sur l’ID, où le lien est composé des propriétés d’ID utilisées lors de la création des ressources. Vous pouvez toujours utiliser la SelfLink propriété de l’utilisateur si vous le souhaitez. Un lien automatique est un URI pour une ressource constituée d’identificateurs de ressource (ou des propriétés _rid). Les liens basés sur l’ID et SelfLink fonctionnent tous deux. Le format pour userLink est toujours « /dbs/{db identifier}/users/{user identifier} », seules les valeurs dans le {...} changent en fonction de la méthode que vous souhaitez utiliser pour traiter la ressource.

Voir aussi

• ResourceResponse<TResource>
• Task
• Uri
• User
• RequestOptions