IDocumentClient.ReadAttachmentAsync 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
| ReadAttachmentAsync(String, RequestOptions, CancellationToken) |
Lit un Attachment à partir du service Azure Cosmos DB en tant qu’opération asynchrone. |
| ReadAttachmentAsync(Uri, RequestOptions, CancellationToken) |
Lit une Attachment en tant qu’opération asynchrone à partir du service Azure Cosmos DB. |
ReadAttachmentAsync(String, RequestOptions, CancellationToken)
Lit un Attachment à 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.Attachment>> ReadAttachmentAsync (string attachmentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadAttachmentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>>Public Function ReadAttachmentAsync (attachmentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Attachment))Paramètres
- attachmentLink
- String
Lien vers la pièce jointe à 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 Attachment contenant l’enregistrement de ressource de lecture.
Exceptions
Si attachmentLink 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
//Reads an Attachment resource where
// - sample_db is the ID property of the Database
// - sample_coll is the ID property of the DocumentCollection
// - sample_doc is the ID property of the Document
// - attachment_id is the ID property of the Attachment resource you wish to read.
var attachLink = "/dbs/sample_db/colls/sample_coll/docs/sample_doc/attachments/attachment_id/";
Attachment attachment = await client.ReadAttachmentAsync(attachLink);
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.
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 la base de données 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 attachmentLink est toujours « /dbs/{identificateur de base de données}/colls/{identificateur coll}/docs/{identificateur doc}/attachments/{attachment identifier} » uniquement les valeurs dans le changement en fonction de la {} méthode que vous souhaitez utiliser pour traiter la ressource.
Voir aussi
S’applique à
ReadAttachmentAsync(Uri, RequestOptions, CancellationToken)
Lit une Attachment 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.Attachment>> ReadAttachmentAsync (Uri attachmentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadAttachmentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>>Public Function ReadAttachmentAsync (attachmentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Attachment))Paramètres
- attachmentUri
- Uri
URI de la ressource Attachment à lire.
- options
- RequestOptions
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 Attachment contenant l’enregistrement de ressource de lecture.
Exceptions
Si attachmentUri 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
//Reads an Attachment 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
// - attachment_id is the ID property of the Attachment resource you wish to read.
var attachLink = UriFactory.CreateAttachmentUri("db_id", "coll_id", "doc_id", "attachment_id");
Attachment attachment = await client.ReadAttachmentAsync(attachLink);
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