CosmosContainer.ReplaceContainerAsync(ContainerProperties, ContainerRequestOptions, CancellationToken) Method

Definition

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

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

Parameters

containerProperties
ContainerProperties

The ContainerProperties object.

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<ContainerResponse>

A System.Threading.Tasks.Task containing a Response which wraps a ContainerProperties containing the replace 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:

StatusCodeReason for exception
404NotFound - This means the resource you tried to read did not exist.
429TooManyRequests - This means you have exceeded the number of request units per second. Consult the DocumentClientException.RetryAfter value to see how long you should wait before retrying this operation.

Examples

Update the container to disable automatic indexing

ContainerProperties containerProperties = containerReadResponse;
containerProperties.IndexingPolicy.Automatic = false;
ContainerResponse response = await container.ReplaceContainerAsync(containerProperties);
ContainerProperties replacedProperties = response;

Applies to