IDocumentClient.ReadDocumentCollectionAsync Method

Definition

Overloads

ReadDocumentCollectionAsync(String, RequestOptions)

Reads a DocumentCollection as an asynchronous operation in the Azure Cosmos DB service.

ReadDocumentCollectionAsync(Uri, RequestOptions)

Reads a DocumentCollection as an asynchronous operation in the Azure Cosmos DB service.

ReadDocumentCollectionAsync(String, RequestOptions)

Reads a DocumentCollection as an asynchronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionAsync (string documentCollectionLink, Microsoft.Azure.Documents.Client.RequestOptions options = null);
abstract member 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 = null) As Task(Of ResourceResponse(Of DocumentCollection))

Parameters

documentCollectionLink
String

The link for the DocumentCollection to be read.

options
RequestOptions

(Optional) The RequestOptionsfor this request.

Returns

Task<ResourceResponse<DocumentCollection>>

A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a DocumentCollection containing the read resource record.

Applies to

Product Introduced

ReadDocumentCollectionAsync(Uri, RequestOptions)

Reads a DocumentCollection as an asynchronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.RequestOptions options = null);
abstract member 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 = null) As Task(Of ResourceResponse(Of DocumentCollection))

Parameters

documentCollectionUri
Uri

A URI to the DocumentCollection resource to be read.

options
RequestOptions

(Optional) The RequestOptions for the request.

Returns

Task<ResourceResponse<DocumentCollection>>

A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a DocumentCollection containing the read resource record.

Applies to

Product Introduced