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

DocumentClient.ReadStoredProcedureAsync 方法

定义

命名空间:

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

重载

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

ReadStoredProcedureAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>> ReadStoredProcedureAsync (string storedProcedureLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

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

Public Function ReadStoredProcedureAsync (storedProcedureLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of StoredProcedure))

参数

storedProcedureLink

String

要读取的存储过程的链接。

options

RequestOptions

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

返回

Task<ResourceResponse<StoredProcedure>>

包含 System.Threading.Tasks 的 ， ResourceResponse<TResource> 它包装 StoredProcedure 包含读取资源记录的 。

实现

ReadStoredProcedureAsync(String, RequestOptions)

例外

ArgumentNullException

如果未 storedProcedureLink 设置 。

DocumentClientException

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

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

示例

//Reads a StoredProcedure from a Database and DocumentCollection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - sproc_id is the ID of the stored procedure to be read
var sprocLink = "/dbs/sample_database/colls/sample_collection/sprocs/sproc_id";
StoredProcedure sproc = await client.ReadStoredProcedureAsync(sprocLink);

注解

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

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

另请参阅

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

ReadStoredProcedureAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>> ReadStoredProcedureAsync (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

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

Public Function ReadStoredProcedureAsync (storedProcedureUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of StoredProcedure))

参数

storedProcedureUri

Uri

要读取的 StoredProcedure 资源的 URI。

options

RequestOptions

请求的请求选项。

返回

Task<ResourceResponse<StoredProcedure>>

包含 System.Threading.Tasks 的 ， ResourceResponse<TResource> 它包装 StoredProcedure 包含读取资源记录的 。

实现

ReadStoredProcedureAsync(Uri, RequestOptions)

例外

ArgumentNullException

如果未 storedProcedureUri 设置 。

DocumentClientException

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

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

示例

//Reads a StoredProcedure resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection 
// - sproc_id is the ID property of the StoredProcedure you wish to read. 
var sprocLink = UriFactory.CreateStoredProcedureUri("db_id", "coll_id", "sproc_id");
StoredProcedure sproc = await client.ReadStoredProcedureAsync(sprocLink);

注解

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

另请参阅

• StoredProcedure
• RequestOptions
• ResourceResponse<TResource>
• Task