CosmosDatabase.ReadStreamAsync(RequestOptions, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Cosmos

Assembly:: Azure.Cosmos.dll

Package:: Azure.Cosmos v4.0.0-preview3

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.Response> ReadStreamAsync (Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadStreamAsync : Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public MustOverride Function ReadStreamAsync (Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

requestOptions: RequestOptions

(Optional) The options for the container request RequestOptions

cancellationToken: CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<Response>

A Task containing a Response containing the read resource record.

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);
Response response = await database.ReadContainerStreamAsync();

Applies to

Share via