Container.ReadItemAsync<T> Método

Definición

Espacio de nombres:

Microsoft.Azure.Cosmos

Ensamblado:

Microsoft.Azure.Cosmos.Client.dll

Paquete:

Microsoft.Azure.Cosmos v3.36.0

Lee un elemento del servicio Azure Cosmos como una operación asincrónica.

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ItemResponse<T>> ReadItemAsync<T> (string id, Microsoft.Azure.Cosmos.PartitionKey partitionKey, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadItemAsync : string * Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ItemResponse<'T>>

Public MustOverride Function ReadItemAsync(Of T) (id As String, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ItemResponse(Of T))

Parámetros de tipo

T

Parámetros

id

String

El identificador del elemento de Cosmos

partitionKey

PartitionKey

Clave de partición del elemento.

requestOptions

ItemRequestOptions

(Opcional) Las opciones de la solicitud de elemento.

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa la cancelación de la solicitud.

Devoluciones

Task<ItemResponse<T>>

que Task contiene un ItemResponse<T> objeto que encapsula el registro de recursos de lectura.

Excepciones

CosmosException

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
429	TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo.

Ejemplos

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
}

ToDoActivity toDoActivity = await this.container.ReadItemAsync<ToDoActivity>("id", new PartitionKey("partitionKey"));

Comentarios

Los elementos contienen metadatos que se pueden obtener mediante la asignación de estos atributos de metadatos a las propiedades de T. * "_ts": obtiene la marca de tiempo de la última modificación asociada al elemento del servicio Azure Cosmos DB. * "_etag": obtiene la etiqueta de entidad asociada al elemento del servicio Azure Cosmos DB. * "ttl": obtiene el período de vida en segundos del elemento en el servicio Azure Cosmos DB.