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

DocumentClient.ReadDocumentCollectionAsync 方法

定义

命名空间:

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

重载

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

ReadDocumentCollectionAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionAsync (string documentCollectionLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

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

Public Function ReadDocumentCollectionAsync (documentCollectionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

参数

documentCollectionLink

String

要读取的 DocumentCollection 的链接。

options

RequestOptions

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

返回

Task<ResourceResponse<DocumentCollection>>

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

实现

ReadDocumentCollectionAsync(String, RequestOptions)

例外

ArgumentNullException

如果未 documentCollectionLink 设置 。

DocumentClientException

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

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

示例

//This reads a DocumentCollection record from a database where
// - sample_database is the ID of the database
// - collection_id is the ID of the collection resource to be read
var collLink = "/dbs/sample_database/colls/collection_id";
DocumentCollection coll = await client.ReadDocumentCollectionAsync(collLink);

注解

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

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

另请参阅

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

ReadDocumentCollectionAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

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

Public Function ReadDocumentCollectionAsync (documentCollectionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

参数

documentCollectionUri

Uri

要读取的 DocumentCollection 资源的 URI。

options

RequestOptions

请求的请求选项。

返回

Task<ResourceResponse<DocumentCollection>>

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

实现

ReadDocumentCollectionAsync(Uri, RequestOptions)

例外

ArgumentNullException

如果未 documentCollectionUri 设置 。

DocumentClientException

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

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

示例

//Reads a Document resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection you wish to read. 
var collLink = UriFactory.CreateCollectionUri("db_id", "coll_id");
DocumentCollection coll = await client.ReadDocumentCollectionAsync(collLink);

注解

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

另请参阅

• DocumentCollection
• RequestOptions
• ResourceResponse<TResource>
• Task