IDocumentClient.ReadAttachmentAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| ReadAttachmentAsync(String, RequestOptions, CancellationToken) |
Lee un Attachment elemento del servicio Azure Cosmos DB como una operación asincrónica. |
| ReadAttachmentAsync(Uri, RequestOptions, CancellationToken) |
Lee como Attachment una operación asincrónica desde el servicio Azure Cosmos DB. |
ReadAttachmentAsync(String, RequestOptions, CancellationToken)
Lee un Attachment elemento del servicio Azure Cosmos DB como una operación asincrónica.
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
Vínculo a los datos adjuntos que se van a leer.
- options
- RequestOptions
(Opcional) Opciones de solicitud para la solicitud.
- cancellationToken
- CancellationToken
(Opcional) que CancellationToken pueden ser utilizados por otros objetos o subprocesos para recibir aviso de cancelación.
Devoluciones
que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene Attachment el registro de recursos de lectura.
Excepciones
Si attachmentLink no se establece.
Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:
| StatusCode | Motivo de la excepción |
|---|---|
| 404 | NotFound: significa que el recurso que intentó leer no existía. |
| 429 | TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación. |
Ejemplos
//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);
Comentarios
Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso del servicio. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.
En el ejemplo que se muestra se usan vínculos basados en identificadores, donde el vínculo se compone de las propiedades de identificador usadas cuando se crearon los recursos. Si lo prefiere, puede usar la SelfLink propiedad de la base de datos. Un auto-vínculo es un URI para un recurso que se compone de identificadores de recursos (o las propiedades de _rid). Los vínculos basados en identificadores y SelfLink funcionarán. El formato de attachmentLink siempre es "/dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}/attachments/{attachments/{attachment identifier}" solo los valores dentro del {} cambio en función del método que desee usar para abordar el recurso.
Consulte también
Se aplica a
ReadAttachmentAsync(Uri, RequestOptions, CancellationToken)
Lee como Attachment una operación asincrónica desde el servicio 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
Un URI para el recurso Attachment que se va a leer.
- options
- RequestOptions
Opciones de solicitud para la solicitud.
- cancellationToken
- CancellationToken
(Opcional) que CancellationToken pueden ser utilizados por otros objetos o subprocesos para recibir aviso de cancelación.
Devoluciones
que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene Attachment el registro de recursos de lectura.
Excepciones
Si attachmentUri no se establece.
Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:
| StatusCode | Motivo de la excepción |
|---|---|
| 404 | NotFound: significa que el recurso que intentó leer no existía. |
| 429 | TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación. |
Ejemplos
//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);
Comentarios
Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso del servicio. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.
Consulte también
Se aplica a
Azure SDK for .NET
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de