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

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.36.0

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

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

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

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

パラメーター

requestOptions

RequestOptions

(省略可能)要求のオプション。

cancellationToken

CancellationToken

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

戻り値

Task<DatabaseResponse>

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

例外

CosmosException

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

StatusCode	例外の理由
404	NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。
429	TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。

例

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

注釈

Resource には、 DatabaseProperties リソース情報を含む が含まれます。