Database.DeleteAsync(RequestOptions, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: Database.cs

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.

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.

Examples

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

Applies to

Share via