CosmosDatabase.ReadAsync(RequestOptions, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Reads a DatabaseProperties from the Azure Cosmos service as an asynchronous operation.
public abstract System.Threading.Tasks.Task<Azure.Cosmos.DatabaseResponse> ReadAsync (Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadAsync : Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.DatabaseResponse>Public MustOverride Function ReadAsync (Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DatabaseResponse)Parameters
- requestOptions
- RequestOptions
(Optional) The options for the container request RequestOptions
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
A Task containing a DatabaseResponse which wraps a DatabaseProperties containing the read resource record.
Exceptions
This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:
StatusCode-Reason for exception
Examples
//Reads a Database resource where
// - database_id is the ID property of the Database resource you wish to read.
Database database = this.cosmosClient.GetDatabase(database_id);
DatabaseResponse response = await database.ReadAsync();
Remarks
Doing a read of a resource is the most efficient way to get a resource from the Database. If you know the resource's ID, do a read instead of a query by ID.
Applies to
Azure SDK for .NET