IDocumentClient.ReadDocumentAsync 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
| ReadDocumentAsync(String, RequestOptions, CancellationToken) |
Lee un Document elemento del servicio Azure Cosmos DB como una operación asincrónica. |
| ReadDocumentAsync(Uri, RequestOptions, CancellationToken) |
Lee como Document una operación asincrónica desde el servicio Azure Cosmos DB. |
| ReadDocumentAsync<T>(String, RequestOptions, CancellationToken) |
Lee como Document un tipo genérico T del servicio Azure Cosmos DB como una operación asincrónica. |
| ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken) |
Lee como Document un tipo genérico T del servicio Azure Cosmos DB como una operación asincrónica. |
ReadDocumentAsync(String, RequestOptions, CancellationToken)
Lee un Document 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.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>>Public Function ReadDocumentAsync (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Parámetros
- documentLink
- String
Vínculo del documento que se va 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 Document el registro de recursos de lectura.
Excepciones
Si documentLink 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
//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);
Comentarios
Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso de la base de datos. 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 del documento. 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 documentLink siempre es "dbs/{db identifier}/colls/{coll identifier}/docs/{doc 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
ReadDocumentAsync(Uri, RequestOptions, CancellationToken)
Lee como Document una operación asincrónica desde el servicio 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>>Public Function ReadDocumentAsync (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Parámetros
- documentUri
- Uri
Un URI para el recurso Document 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 Document el registro de recursos de lectura.
Excepciones
Si documentUri 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 leer 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 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);
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
ReadDocumentAsync<T>(String, RequestOptions, CancellationToken)
Lee como Document un tipo genérico T del servicio Azure Cosmos DB como una operación asincrónica.
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>>Public Function ReadDocumentAsync(Of T) (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))Parámetros de tipo
- T
Parámetros
- documentLink
- String
Vínculo del documento que se va 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 DocumentResponse<TDocument> objeto que contiene Document el registro de recursos de lectura.
Excepciones
Si documentLink 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
//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);
Comentarios
Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso de la base de datos. 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 del documento. 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 documentLink siempre es "dbs/{db identifier}/colls/{coll identifier}/docs/{doc 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
ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken)
Lee como Document un tipo genérico T del servicio Azure Cosmos DB como una operación asincrónica.
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>>Public Function ReadDocumentAsync(Of T) (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))Parámetros de tipo
- T
Parámetros
- documentUri
- Uri
Un URI para el recurso Document 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 DocumentResponse<TDocument> objeto que contiene Document el registro de recursos de lectura.
Excepciones
Si documentUri 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 leer 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 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);
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