Container.ReadContainerAsync メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.36.0

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

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> ReadContainerAsync (Microsoft.Azure.Cosmos.ContainerRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadContainerAsync : Microsoft.Azure.Cosmos.ContainerRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>

Public MustOverride Function ReadContainerAsync (Optional requestOptions As ContainerRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)

パラメーター

requestOptions

ContainerRequestOptions

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

cancellationToken

CancellationToken

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

戻り値

Task<ContainerResponse>

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

例外

CosmosException

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

StatusCode	例外の理由
404	NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。
429	TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter 値を調べ、この操作を再試行するまでの待機時間を確認します。

例

Container container = this.database.GetContainer("containerId");
ContainerProperties containerProperties = await container.ReadContainerAsync();