CosmosContainer.ReadContainerStreamAsync(ContainerRequestOptions, CancellationToken) Method

Definition

Reads a ContainerProperties from the Azure Cosmos service as an asynchronous operation.

public abstract System.Threading.Tasks.Task<Azure.Response> ReadContainerStreamAsync (Azure.Cosmos.ContainerRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadContainerStreamAsync : Azure.Cosmos.ContainerRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public MustOverride Function ReadContainerStreamAsync (Optional requestOptions As ContainerRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

requestOptions
ContainerRequestOptions

(Optional) The options for the container request RequestOptions

cancellationToken
System.Threading.CancellationToken

(Optional) System.Threading.CancellationToken representing request cancellation.

Returns

System.Threading.Tasks.Task<Response>

A System.Threading.Tasks.Task containing a Response containing the read resource record.

Examples

Container container = this.database.GetContainer("containerId");
Response response = await container.ReadContainerStreamAsync();

Applies to