Container.DeleteContainerAsync(ContainerRequestOptions, CancellationToken) Method

Definition

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

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse> DeleteContainerAsync (Microsoft.Azure.Cosmos.ContainerRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteContainerAsync : Microsoft.Azure.Cosmos.ContainerRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ContainerResponse>
Public MustOverride Function DeleteContainerAsync (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

Task<ContainerResponse>

A Task containing a ContainerResponse which will contain information about the request issued.

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 delete did not exist.

Examples

Container container = this.database.GetContainer("containerId");
ContainerResponse response = await container.DeleteContainerAsync();

Applies to