Container.ReadItemAsync<T> Méthode

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.36.0

Lit un élément du service Azure Cosmos en tant qu’opération asynchrone.

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))

Paramètres de type

T

Paramètres

id

String

ID d’élément Cosmos

partitionKey

PartitionKey

Clé de partition de l’élément.

requestOptions

ItemRequestOptions

(Facultatif) Options de la demande d’élément.

cancellationToken

CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

Task<ItemResponse<T>>

Task contenant un ItemResponse<T> qui encapsule l’enregistrement de ressource de lecture.

Exceptions

CosmosException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCode	Raison de l’exception
429	TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde.

Exemples

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

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

Remarques

Les éléments contiennent des métadonnées qui peuvent être obtenues en mappant ces attributs de métadonnées aux propriétés dans T. * « _ts » : obtient l’horodatage de la dernière modification associée à l’élément à partir du service Azure Cosmos DB. * « _etag » : obtient la balise d’entité associée à l’élément à partir du service Azure Cosmos DB. * « ttl » : obtient le temps de vie en secondes de l’élément dans le service Azure Cosmos DB.