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

CosmosScripts.ReadStoredProcedureAsync 方法

  • 参考

定义

命名空间:
Azure.Cosmos.Scripts
程序集:
Azure.Cosmos.dll
包:
Azure.Cosmos v4.0.0-preview3

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

public abstract System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.StoredProcedureProperties>> ReadStoredProcedureAsync (string id, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadStoredProcedureAsync : string * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.StoredProcedureProperties>>
Public MustOverride Function ReadStoredProcedureAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of StoredProcedureProperties))

参数

id
String

要读取的存储过程的标识符。

requestOptions
RequestOptions

(可选) 存储过程请求的选项 StoredProcedureRequestOptions

cancellationToken
CancellationToken

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

返回

Task<Response<StoredProcedureProperties>>

包含 Task 的 StoredProcedureProperties。

例外

ArgumentNullException

如果未 id 设置 。

CosmosException

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

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

示例

这将读取现有存储过程。

CosmosScripts scripts = this.container.Scripts;
Response<StoredProcedureProperties> storedProcedure = await scripts.ReadStoredProcedureAsync("ExistingId");

适用于