IDocumentClient.ReadAttachmentAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| ReadAttachmentAsync(String, RequestOptions, CancellationToken) |
Lê um Attachment do serviço do Azure Cosmos DB como uma operação assíncrona. |
| ReadAttachmentAsync(Uri, RequestOptions, CancellationToken) |
Lê um Attachment como uma operação assíncrona do serviço do Azure Cosmos DB. |
ReadAttachmentAsync(String, RequestOptions, CancellationToken)
Lê um Attachment do serviço do Azure Cosmos DB como uma operação assíncrona.
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))Parâmetros
- attachmentLink
- String
O link para o anexo a ser lido.
- options
- RequestOptions
(Opcional) As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber notificação de cancelamento.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Attachment que contém o registro de recurso de leitura.
Exceções
Se attachmentLink não estiver definido.
Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:
| StatusCode | Motivo da exceção |
|---|---|
| 404 | NotFound - Isso significa que o recurso que você tentou ler não existia. |
| 429 | TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação. |
Exemplos
//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);
Comentários
Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do serviço. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.
O exemplo mostrado usa links baseados em ID, em que o link é composto pelas propriedades de ID usadas quando os recursos foram criados. Você ainda pode usar a SelfLink propriedade do Banco de Dados se preferir. Um auto-link é um URI para um recurso composto por Identificadores de Recursos (ou as propriedades _rid). Os links baseados em ID e o SelfLink funcionarão. O formato para attachmentLink é sempre "/dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}/attachments/{attachment identifier}" apenas os valores dentro da {} alteração, dependendo de qual método você deseja usar para abordar o recurso.
Confira também
Aplica-se a
ReadAttachmentAsync(Uri, RequestOptions, CancellationToken)
Lê um Attachment como uma operação assíncrona do serviço do 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))Parâmetros
- attachmentUri
- Uri
Um URI para o recurso Attachment a ser lido.
- options
- RequestOptions
As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber notificação de cancelamento.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Attachment que contém o registro de recurso de leitura.
Exceções
Se attachmentUri não estiver definido.
Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:
| StatusCode | Motivo da exceção |
|---|---|
| 404 | NotFound - Isso significa que o recurso que você tentou ler não existia. |
| 429 | TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação. |
Exemplos
//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);
Comentários
Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do serviço. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.
Confira também
Aplica-se a
Azure SDK for .NET