IDocumentClient.ReadAttachmentAsync Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Überlädt
| ReadAttachmentAsync(String, RequestOptions, CancellationToken) |
Liest einen Attachment aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang. |
| ReadAttachmentAsync(Uri, RequestOptions, CancellationToken) |
Liest einen Attachment als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst. |
ReadAttachmentAsync(String, RequestOptions, CancellationToken)
Liest einen Attachment aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.
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))Parameter
- attachmentLink
- String
Der Link zur zu lesenden Anlage.
- options
- RequestOptions
(Optional) Die Anforderungsoptionen für die Anforderung.
- cancellationToken
- CancellationToken
(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.
Gibt zurück
Eine System.Threading.Tasks , die einen ResourceResponse<TResource> enthält, der einen Attachment umschließt, der den Leseressourcendatensatz enthält.
Ausnahmen
Wenn attachmentLink nicht festgelegt ist.
Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten, sind:
| StatusCode | Ausnahmegrund |
|---|---|
| 404 | NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war. |
| 429 | TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen. |
Beispiele
//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);
Hinweise
Das Lesen einer Ressource ist die effizienteste Möglichkeit, eine Ressource aus dem Dienst abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie anstelle einer Abfrage nach ID einen Lesevorgang durch.
Das gezeigte Beispiel verwendet ID-basierte Links, wobei der Link aus den ID-Eigenschaften besteht, die beim Erstellen der Ressourcen verwendet wurden. Sie können weiterhin die SelfLink -Eigenschaft der Datenbank verwenden, wenn Sie möchten. Eine Selbstverknüpfung ist ein URI für eine Ressource, die aus Ressourcenbezeichnern (oder den _rid Eigenschaften) besteht. ID-basierte Links und SelfLink funktionieren beide. Das Format für attachmentLink ist immer "/dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}/attachments/{attachment identifier}" nur die Werte innerhalb der {} Änderung, je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.
Weitere Informationen
Gilt für:
ReadAttachmentAsync(Uri, RequestOptions, CancellationToken)
Liest einen Attachment als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst.
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))Parameter
- attachmentUri
- Uri
Ein URI der zu lesenden Anlageressource.
- options
- RequestOptions
Die Anforderungsoptionen für die Anforderung.
- cancellationToken
- CancellationToken
(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.
Gibt zurück
Eine System.Threading.Tasks , die einen ResourceResponse<TResource> enthält, der einen Attachment umschließt, der den Leseressourcendatensatz enthält.
Ausnahmen
Wenn attachmentUri nicht festgelegt ist.
Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten, sind:
| StatusCode | Ausnahmegrund |
|---|---|
| 404 | NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war. |
| 429 | TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen. |
Beispiele
//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);
Hinweise
Das Lesen einer Ressource ist die effizienteste Möglichkeit, eine Ressource aus dem Dienst abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie anstelle einer Abfrage nach ID einen Lesevorgang durch.
Weitere Informationen
Gilt für:
Azure SDK for .NET