Container.ReadContainerAsync 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 ContainerProperties from the Azure Cosmos service as an asynchronous operation.
public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> ReadContainerAsync (Microsoft.Azure.Cosmos.ContainerRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadContainerAsync : Microsoft.Azure.Cosmos.ContainerRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>Public MustOverride Function ReadContainerAsync (Optional requestOptions As ContainerRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)Parameters
- requestOptions
- ContainerRequestOptions
(Optional) The options for the container request.
- cancellationToken
- CancellationToken
(Optional) CancellationToken representing request cancellation.
Returns
A Task containing a ContainerResponse which wraps a ContainerProperties containing the read resource record.
Examples
Container container = this.database.GetContainer("containerId");
ContainerProperties containerProperties = await container.ReadContainerAsync();
