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

Container.ReadItemAsync<T> 方法

定义

命名空间:

Microsoft.Azure.Cosmos

程序集:

Microsoft.Azure.Cosmos.Client.dll

包:

Microsoft.Azure.Cosmos v3.36.0

以异步操作的形式从 Azure Cosmos 服务读取项。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ItemResponse<T>> ReadItemAsync<T> (string id, Microsoft.Azure.Cosmos.PartitionKey partitionKey, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadItemAsync : string * Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ItemResponse<'T>>

Public MustOverride Function ReadItemAsync(Of T) (id As String, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ItemResponse(Of T))

类型参数

T

参数

id

String

Cosmos 项 ID

partitionKey

PartitionKey

项的分区键。

requestOptions

ItemRequestOptions

(可选) 项请求的选项。

cancellationToken

CancellationToken

(表示请求取消的可选) CancellationToken 。

返回

Task<ItemResponse<T>>

一个 TaskItemResponse<T> ，其中包含包装读取资源记录的 。

例外

CosmosException

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

StatusCode	异常原因
429	TooManyRequests - 这意味着已超出每秒请求单位数。

示例

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
}

ToDoActivity toDoActivity = await this.container.ReadItemAsync<ToDoActivity>("id", new PartitionKey("partitionKey"));

注解

项包含可通过将这些元数据属性映射到 中的 T属性来获取的元数据。 * “_ts”：从 Azure Cosmos DB 服务获取与项关联的上次修改时间戳。 * “_etag”：从 Azure Cosmos DB 服务获取与项关联的实体标记。 * “ttl”：获取 Azure Cosmos DB 服务中项的生存时间（以秒为单位）。