SoftDeletedDatabaseAccountGetResultResource.Purge Method
Definition
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 a soft-deleted Azure Cosmos DB SQL database.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/locations/{location}/softDeletedDatabaseAccounts/{accountName}/softDeletedSqlDatabases/{databaseName}?softDeleteActionKind=PermanentDeleteResource.
- Operation Id. : SoftDeletedSqlDatabases_Purge.
- Default Api Version. : 2026-04-01-preview.
- Resource. : SoftDeletedDatabaseAccountGetResultResource.
public virtual Azure.ResourceManager.ArmOperation Purge(Azure.WaitUntil waitUntil, string databaseName, Azure.ResourceManager.CosmosDB.Models.SoftDeleteActionKind? softDeleteActionKind = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Purge : Azure.WaitUntil * string * Nullable<Azure.ResourceManager.CosmosDB.Models.SoftDeleteActionKind> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.Purge : Azure.WaitUntil * string * Nullable<Azure.ResourceManager.CosmosDB.Models.SoftDeleteActionKind> * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
Public Overridable Function Purge (waitUntil As WaitUntil, databaseName As String, Optional softDeleteActionKind As Nullable(Of SoftDeleteActionKind) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation
Parameters
- 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.
- databaseName
- String
Cosmos DB SQL database name.
- softDeleteActionKind
- Nullable<SoftDeleteActionKind>
The kind of soft delete action to perform.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
databaseName is null.
databaseName is an empty string, and was expected to be non-empty.