CosmosDBExtensions.PurgeAsync Method

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.6.0-beta.1

Source:: CosmosDBExtensions.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.

Permanently deletes (purges) a soft-deleted Azure Cosmos DB database account. <item> Mocking. To mock this method, please mock PurgeAsync(WaitUntil, AzureLocation, String, Nullable<SoftDeleteActionKind>, CancellationToken) instead. </item>

public static System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> PurgeAsync(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, Azure.WaitUntil waitUntil, Azure.Core.AzureLocation location, string accountName, Azure.ResourceManager.CosmosDB.Models.SoftDeleteActionKind? softDeleteActionKind = default, System.Threading.CancellationToken cancellationToken = default);

static member PurgeAsync : Azure.ResourceManager.Resources.ResourceGroupResource * Azure.WaitUntil * Azure.Core.AzureLocation * string * Nullable<Azure.ResourceManager.CosmosDB.Models.SoftDeleteActionKind> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>

<Extension()>
Public Function PurgeAsync (resourceGroupResource As ResourceGroupResource, waitUntil As WaitUntil, location As AzureLocation, accountName As String, Optional softDeleteActionKind As Nullable(Of SoftDeleteActionKind) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation)

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource the method will execute against.

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.