DocumentClient.ReadDocumentAsync 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
| ReadDocumentAsync(String, RequestOptions, CancellationToken) |
Lit un Document à partir du service Azure Cosmos DB en tant qu’opération asynchrone. |
| ReadDocumentAsync(Uri, RequestOptions, CancellationToken) |
Lit un Document en tant qu’opération asynchrone à partir du service Azure Cosmos DB. |
| ReadDocumentAsync<T>(String, RequestOptions, CancellationToken) |
Lit un Document en tant que type générique T à partir du service Azure Cosmos DB en tant qu’opération asynchrone. |
| ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken) |
Lit un Document en tant que type générique T à partir du service Azure Cosmos DB en tant qu’opération asynchrone. |
ReadDocumentAsync(String, RequestOptions, CancellationToken)
Lit un Document à 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.Document>> ReadDocumentAsync (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function ReadDocumentAsync (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Paramètres
- documentLink
- String
Lien du document à lire.
- options
- RequestOptions
(Facultatif) Options de demande pour la demande.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.
Retours
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Document contenant l’enregistrement de ressource de lecture.
Implémente
Exceptions
Si documentLink 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 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
//This reads a document record from a database & collection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - document_id is the ID of the document resource
var docLink = "dbs/sample_database/colls/sample_collection/docs/document_id";
Document doc = await client.ReadDocumentAsync(docLink);
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é du document si vous préférez. 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 documentLink est toujours « dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier} » uniquement les valeurs dans la modification en fonction de la {} méthode que vous souhaitez utiliser pour traiter la ressource.
Voir aussi
S’applique à
ReadDocumentAsync(Uri, RequestOptions, CancellationToken)
Lit un Document 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.Document>> ReadDocumentAsync (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function ReadDocumentAsync (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Paramètres
- documentUri
- Uri
URI de la ressource Document à lire.
- options
- RequestOptions
Options de demande pour la demande.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken représentant l’annulation de la demande.
Retours
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Document contenant l’enregistrement de ressource de lecture.
Implémente
Exceptions
Si documentUri 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 lecture 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 Document resource where
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - doc_id is the ID property of the Document you wish to read.
var docUri = UriFactory.CreateDocumentUri("db_id", "coll_id", "doc_id");
Document document = await client.ReadDocumentAsync(docUri);
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
S’applique à
ReadDocumentAsync<T>(String, RequestOptions, CancellationToken)
Lit un Document en tant que type générique T à partir du service Azure Cosmos DB en tant qu’opération asynchrone.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<T>> ReadDocumentAsync<T> (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>
override this.ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>Public Function ReadDocumentAsync(Of T) (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))Paramètres de type
- T
Paramètres
- documentLink
- String
Lien du document à lire.
- options
- RequestOptions
(Facultatif) Options de demande pour la demande.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.
Retours
System.Threading.Tasks contenant un DocumentResponse<TDocument> qui encapsule un Document contenant l’enregistrement de ressource de lecture.
Implémente
Exceptions
Si documentLink 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 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
//This reads a document record from a database & collection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - document_id is the ID of the document resource
var docLink = "dbs/sample_database/colls/sample_collection/docs/document_id";
Customer customer = await client.ReadDocumentAsync<Customer>(docLink);
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é du document si vous préférez. 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 documentLink est toujours « dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier} » uniquement les valeurs dans la modification en fonction de la {} méthode que vous souhaitez utiliser pour traiter la ressource.
Voir aussi
S’applique à
ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken)
Lit un Document en tant que type générique T à partir du service Azure Cosmos DB en tant qu’opération asynchrone.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<T>> ReadDocumentAsync<T> (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>
override this.ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>Public Function ReadDocumentAsync(Of T) (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))Paramètres de type
- T
Paramètres
- documentUri
- Uri
URI de la ressource Document à lire.
- options
- RequestOptions
Options de demande pour la demande.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken représentant l’annulation de la demande.
Retours
System.Threading.Tasks contenant un DocumentResponse<TDocument> qui encapsule un Document contenant l’enregistrement de ressource de lecture.
Implémente
Exceptions
Si documentUri 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 lecture 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 Document resource where
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - doc_id is the ID property of the Document you wish to read.
var docUri = UriFactory.CreateDocumentUri("db_id", "coll_id", "doc_id");
Customer customer = await client.ReadDocumentAsync<Customer>(docUri);
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
S’applique à
Azure SDK for .NET