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

Scripts.ReadUserDefinedFunctionAsync 方法

定义

命名空间:

Microsoft.Azure.Cosmos.Scripts

程序集:

Microsoft.Azure.Cosmos.Client.dll

包:

Microsoft.Azure.Cosmos v3.45.0

Source:

Scripts.cs

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

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.UserDefinedFunctionResponse> ReadUserDefinedFunctionAsync(string id, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadUserDefinedFunctionAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.UserDefinedFunctionResponse>

Public MustOverride Function ReadUserDefinedFunctionAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of UserDefinedFunctionResponse)

参数

id

String

要读取的用户定义函数的 ID

requestOptions

RequestOptions

(可选) 用户定义的函数请求的选项。

cancellationToken

CancellationToken

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

返回

Task<UserDefinedFunctionResponse>

一个 TaskUserDefinedFunctionResponse ，它包含包装 UserDefinedFunctionProperties 包含读取资源记录的 。

例外

CosmosException

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

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

示例

这将读取现有的用户定义函数。

Scripts scripts = this.container.Scripts;
UserDefinedFunctionResponse response = await scripts.ReadUserDefinedFunctionAsync("ExistingId");
UserDefinedFunctionProperties udfProperties = response;