CosmosDatabase.ReadAsync(RequestOptions, CancellationToken) Méthode

Référence

Définition

Espace de noms:: Azure.Cosmos

Assembly:: Azure.Cosmos.dll

Paquet:: Azure.Cosmos v4.0.0-preview3

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Lit un DatabaseProperties à partir du service Azure Cosmos en tant qu’opération asynchrone.

public abstract System.Threading.Tasks.Task<Azure.Cosmos.DatabaseResponse> ReadAsync (Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAsync : Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.DatabaseResponse>

Public MustOverride Function ReadAsync (Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DatabaseResponse)

Paramètres

requestOptions: RequestOptions

(Facultatif) Options de la demande de conteneur RequestOptions

cancellationToken: CancellationToken

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

Retours

Task<DatabaseResponse>

Task contenant un DatabaseResponse qui encapsule un DatabaseProperties contenant 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

Exemples

//Reads a Database resource where
// - database_id is the ID property of the Database resource you wish to read.
Database database = this.cosmosClient.GetDatabase(database_id);
DatabaseResponse response = await database.ReadAsync();

Remarques

La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir de la base de données. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.

S’applique à

Partager via