CosmosDatabase.ReadAsync(RequestOptions, CancellationToken) メソッド

定義

名前空間:

Azure.Cosmos

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

DatabaseProperties非同期操作として Azure Cosmos サービスから を読み取ります。

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)

パラメーター

requestOptions

RequestOptions

(省略可能)コンテナー要求のオプション RequestOptions

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<DatabaseResponse>

Task読み取りリソース レコードをDatabaseResponse含む をDatabasePropertiesラップする を含む 。

例外

CosmosException

この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。

StatusCode-Reason for exception

例

//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();

注釈

リソースの読み取りを行うことは、データベースからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。