Language

SoftDeletedSqlDatabaseGetResultResource.RestoreAsync Method

Definition

Restores a soft-deleted Azure Cosmos DB SQL container to active state.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/locations/{location}/softDeletedDatabaseAccounts/{accountName}/softDeletedSqlDatabases/{databaseName}/softDeletedSqlContainers/{containerName}?softDeleteActionKind=RestoreSoftDeletedResource.
  • Operation Id. : SoftDeletedSqlContainers_Restore.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : SoftDeletedSqlDatabaseGetResultResource.
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> RestoreAsync(Azure.WaitUntil waitUntil, string containerName, Azure.ResourceManager.CosmosDB.Models.SoftDeleteActionKind? softDeleteActionKind = default, System.Threading.CancellationToken cancellationToken = default);
abstract member RestoreAsync : Azure.WaitUntil * string * Nullable<Azure.ResourceManager.CosmosDB.Models.SoftDeleteActionKind> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.RestoreAsync : Azure.WaitUntil * string * Nullable<Azure.ResourceManager.CosmosDB.Models.SoftDeleteActionKind> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
Public Overridable Function RestoreAsync (waitUntil As WaitUntil, containerName As String, Optional softDeleteActionKind As Nullable(Of SoftDeleteActionKind) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.

containerName
String

Cosmos DB SQL container name.

softDeleteActionKind
Nullable<SoftDeleteActionKind>

The kind of soft delete action to perform.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

containerName is null.

containerName is an empty string, and was expected to be non-empty.

Applies to