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

DocumentClient.ReadUserDefinedFunctionAsync 方法

定义

命名空间:

Microsoft.Azure.Documents.Client

程序集:

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

包:

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

重载

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

ReadUserDefinedFunctionAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> ReadUserDefinedFunctionAsync (string functionLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member ReadUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
override this.ReadUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>

Public Function ReadUserDefinedFunctionAsync (functionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))

参数

functionLink

String

指向要读取的用户定义函数的链接。

options

RequestOptions

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

返回

Task<ResourceResponse<UserDefinedFunction>>

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

实现

ReadUserDefinedFunctionAsync(String, RequestOptions)

例外

ArgumentNullException

如果未 functionLink 设置 。

DocumentClientException

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

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

示例

//Reads a User Defined Function from a Database and DocumentCollection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - udf_id is the ID of the user-defined function to be read
var udfLink = "/dbs/sample_database/colls/sample_collection/udfs/udf_id";
UserDefinedFunction udf = await client.ReadUserDefinedFunctionAsync(udfLink);

注解

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

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

另请参阅

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

ReadUserDefinedFunctionAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> ReadUserDefinedFunctionAsync (Uri functionUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member ReadUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
override this.ReadUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>

Public Function ReadUserDefinedFunctionAsync (functionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))

参数

functionUri

Uri

要读取的用户定义函数资源的 URI。

options

RequestOptions

请求的请求选项。

返回

Task<ResourceResponse<UserDefinedFunction>>

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

实现

ReadUserDefinedFunctionAsync(Uri, RequestOptions)

例外

ArgumentNullException

如果未 functionUri 设置 。

DocumentClientException

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

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

示例

//Reads a UserDefinedFunction resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection 
// - udf_id is the ID property of the UserDefinedFunction you wish to read. 
var udfLink = UriFactory.CreateUserDefinedFunctionUri("db_id", "coll_id", "udf_id");
UserDefinedFunction udf = await client.ReadUserDefinedFunctionAsync(udfLink);

注解

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

另请参阅

• UserDefinedFunction
• RequestOptions
• ResourceResponse<TResource>
• Task