az cosmosdb sql softdeleted-container

  • Preview

Note

This reference is part of the cosmosdb-preview extension for the Azure CLI (version 2.17.1 or higher). The extension will automatically install the first time you run an az cosmosdb sql softdeleted-container command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage soft-deleted containers for Azure Cosmos DB SQL API.

Commands

Name Description Type Status
az cosmosdb sql softdeleted-container delete

Permanently delete a soft-deleted container.

 Extension Preview
az cosmosdb sql softdeleted-container list

List all soft-deleted containers in a database.

 Extension Preview
az cosmosdb sql softdeleted-container recover

Recover a soft-deleted container.

 Extension Preview
az cosmosdb sql softdeleted-container show

Show details of a soft-deleted container.

 Extension Preview

az cosmosdb sql softdeleted-container delete

Preview

Command group 'cosmosdb sql softdeleted-container' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Permanently delete a soft-deleted container.

az cosmosdb sql softdeleted-container delete --database-name
                                             --location
                                             --name
                                             --resource-group
                                             [--account-name]
                                             [--acquire-policy-token]
                                             [--change-reference]
                                             [--ids]
                                             [--subscription]
                                             [--yes]

Examples

Permanently delete a soft-deleted container.

az cosmosdb sql softdeleted-container delete --location westus --account-name MyAccount --database-name MyDatabase --name MyContainer --resource-group MyResourceGroup

Required Parameters

--database-name -d

Name of the database.

--location -l

Location of the account.

--name -n

Name of the soft-deleted container to purge.

--resource-group -g

Name of the resource group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

Name of the Cosmos DB account.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cosmosdb sql softdeleted-container list

Preview

Command group 'cosmosdb sql softdeleted-container' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all soft-deleted containers in a database.

az cosmosdb sql softdeleted-container list --database-name
                                           --location
                                           --resource-group
                                           [--account-name]
                                           [--ids]
                                           [--subscription]

Examples

List all soft-deleted containers in a database.

az cosmosdb sql softdeleted-container list --location westus --account-name MyAccount --database-name MyDatabase --resource-group MyResourceGroup

Required Parameters

--database-name -d

Name of the database.

--location -l

Location of the account.

--resource-group -g

Name of the resource group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

Name of the Cosmos DB account.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cosmosdb sql softdeleted-container recover

Preview

Command group 'cosmosdb sql softdeleted-container' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Recover a soft-deleted container.

az cosmosdb sql softdeleted-container recover --database-name
                                              --location
                                              --name
                                              --resource-group
                                              [--account-name]
                                              [--acquire-policy-token]
                                              [--change-reference]
                                              [--ids]
                                              [--subscription]

Examples

Recover a soft-deleted container.

az cosmosdb sql softdeleted-container recover --location westus --account-name MyAccount --database-name MyDatabase --name MyContainer --resource-group MyResourceGroup

Required Parameters

--database-name -d

Name of the database.

--location -l

Location of the account.

--name -n

Name of the soft-deleted container to recover.

--resource-group -g

Name of the resource group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

Name of the Cosmos DB account.

Property Value
Parameter group: Resource Id Arguments
--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az cosmosdb sql softdeleted-container show

Preview

Command group 'cosmosdb sql softdeleted-container' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a soft-deleted container.

az cosmosdb sql softdeleted-container show --database-name
                                           --location
                                           --name
                                           --resource-group
                                           [--account-name]
                                           [--ids]
                                           [--subscription]

Examples

Show details of a soft-deleted container.

az cosmosdb sql softdeleted-container show --location westus --account-name MyAccount --database-name MyDatabase --name MyContainer --resource-group MyResourceGroup

Required Parameters

--database-name -d

Name of the database.

--location -l

Location of the account.

--name -n

Name of the soft-deleted container.

--resource-group -g

Name of the resource group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

Name of the Cosmos DB account.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False