你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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>

一个 TaskContainerResponse ，它包含包装 ContainerProperties 包含读取资源记录的 。

例外

CosmosException

此异常可以封装许多不同类型的错误。 若要确定特定错误，请始终查看 StatusCode 属性。 创建文档时可能会获取的一些常见代码包括：

StatusCode	异常原因
404	NotFound - 这意味着你尝试读取的资源不存在。
429	TooManyRequests - 这意味着已超出每秒请求单位数。 请参阅 DocumentClientException.RetryAfter 值，了解在重试此操作之前应等待多长时间。

示例

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