Database.DeleteAsync(RequestOptions, CancellationToken) Method

Definition

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

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

Parameters

requestOptions
RequestOptions

(Optional) The options for the request.

cancellationToken
CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<DatabaseResponse>

A Task containing a DatabaseResponse 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

// Delete a Cosmos database
Database database = cosmosClient.GetDatabase("myDbId");
DatabaseResponse response = await database.DeleteAsync();

Applies to