Container.ReadContainerStreamAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.39.0
Source:
Container.cs

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

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

Parameters

requestOptions
ContainerRequestOptions

(Optional) The options for the container request.

cancellationToken
CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<ResponseMessage>

A Task containing a ResponseMessage containing the read resource record.

Examples

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

Applies to