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

IDocumentClient.ReadUserAsync 方法

定义

命名空间:

Microsoft.Azure.Documents

程序集:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

包:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

重载

ReadUserAsync(String, RequestOptions)	User以异步操作的形式从 Azure Cosmos DB 服务读取 。
ReadUserAsync(Uri, RequestOptions)	User以异步操作的形式从 Azure Cosmos DB 服务读取 。

ReadUserAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> ReadUserAsync (string userLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member ReadUserAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>

Public Function ReadUserAsync (userLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

参数

userLink

String

指向要读取的用户资源的链接。

options

RequestOptions

(可选) 请求的请求选项。

返回

Task<ResourceResponse<User>>

一个 System.Threading.TasksResourceResponse<TResource> ，它包含包装 User 包含读取资源记录的 。

例外

ArgumentNullException

如果未 userLink 设置 。

DocumentClientException

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

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

示例

//Reads a User resource from a Database
// - sample_database is the ID of the database
// - user_id is the ID of the user to be read
var userLink = "/dbs/sample_database/users/user_id";
User user = await client.ReadUserAsync(userLink);

注解

读取资源是从数据库获取资源的最有效方法。 如果知道资源的 ID，请执行读取而不是按 ID 进行查询。

显示的示例使用基于 ID 的链接，其中链接由创建资源时使用的 ID 属性组成。 如果愿意， SelfLink 仍然可以使用 User 的 属性。 自链接是资源的 URI，由资源标识符 (或_rid属性) 组成。 基于 ID 的链接和 SelfLink 都将正常工作。 的格式 userLink 始终为“/dbs/{db identifier}/users/{user identifier}”，仅 {...} 中的值会根据要用于寻址资源的方法而更改。

另请参阅

• User
• RequestOptions
• ResourceResponse<TResource>
• Task
• Uri

ReadUserAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> ReadUserAsync (Uri userUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member ReadUserAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>

Public Function ReadUserAsync (userUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

参数

userUri

Uri

要读取的用户资源的 URI。

options

RequestOptions

请求的请求选项。

返回

Task<ResourceResponse<User>>

一个 System.Threading.TasksResourceResponse<TResource> ，它包含包装 User 包含读取资源记录的 。

例外

ArgumentNullException

如果未 userUri 设置 。

DocumentClientException

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

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

示例

//Reads a User resource where 
// - db_id is the ID property of the Database
// - user_id is the ID property of the User you wish to read. 
var userLink = UriFactory.CreateUserUri("db_id", "user_id");
User user = await client.ReadUserAsync(userLink);

注解

读取资源是从服务获取资源的最有效方法。 如果知道资源的 ID，请执行读取而不是按 ID 进行查询。

另请参阅

• User
• RequestOptions
• ResourceResponse<TResource>
• Task