IDocumentClient.ReadUserAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| 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. |
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>>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
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un User contenant l’enregistrement de ressource de lecture.
Exceptions
Si userLink n’est pas défini.
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 tenté 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 savoir 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 présenté 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 préférez. Un lien automatique est un URI pour une ressource composée d’identificateurs de ressource (ou des propriétés _rid). Les liens basés sur l’ID et SelfLink fonctionnent tous les deux. Le format pour userLink est toujours « /dbs/{identificateur de base de données}/users/{identificateur d’utilisateur} » seules les valeurs dans le {...} changent en fonction de la méthode que vous souhaitez utiliser pour traiter la ressource.
Voir aussi
S’applique à
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>>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
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un User contenant l’enregistrement de ressource de lecture.
Exceptions
Si userUri n’est pas défini.
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 tenté 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 savoir 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 auprès du service. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.
Voir aussi
S’applique à
Azure SDK for .NET