az cosmosdb softdeleted-account

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 softdeleted-account 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 Azure Cosmos DB accounts.

Commands

Name	Description	Type	Status
az cosmosdb softdeleted-account delete	Permanently delete a soft-deleted Azure Cosmos DB account.	Extension	Preview
az cosmosdb softdeleted-account list	List soft-deleted Azure Cosmos DB accounts.	Extension	Preview
az cosmosdb softdeleted-account recover	Recover a soft-deleted Azure Cosmos DB account.	Extension	Preview
az cosmosdb softdeleted-account show	Show details of a soft-deleted Azure Cosmos DB account.	Extension	Preview

az cosmosdb softdeleted-account delete

Preview

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

Permanently delete a soft-deleted Azure Cosmos DB account.

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

Examples

Permanently delete a soft-deleted Azure Cosmos DB account.

az cosmosdb softdeleted-account delete --location westus --name MyAccount --resource-group MyResourceGroup

Required Parameters

--location -l

Location of the soft-deleted 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.

--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

--name -n

Name of the soft-deleted Cosmos DB account to purge.

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 softdeleted-account list

Preview

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

List soft-deleted Azure Cosmos DB accounts.

az cosmosdb softdeleted-account list --location
                                     [--resource-group]

Examples

List soft-deleted Azure Cosmos DB accounts in a specific location.

az cosmosdb softdeleted-account list --location westus

Required Parameters

--location -l

Location of the soft-deleted accounts.

Optional Parameters

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

--resource-group -g

Name of the resource group. If provided, lists only soft-deleted accounts in that resource group.

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.

--subscription

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

--verbose

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

Property	Value
Default value:	False

az cosmosdb softdeleted-account recover

Preview

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

Recover a soft-deleted Azure Cosmos DB account.

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

Examples

Recover a soft-deleted Azure Cosmos DB account.

az cosmosdb softdeleted-account recover --location westus --name MyAccount --resource-group MyResourceGroup

Required Parameters

--location -l

Location of the soft-deleted 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.

--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

--name -n

Name of the soft-deleted Cosmos DB account to recover.

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 softdeleted-account show

Preview

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

Show details of a soft-deleted Azure Cosmos DB account.

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

Examples

Show details of a soft-deleted Azure Cosmos DB account.

az cosmosdb softdeleted-account show --location westus --name MyAccount --resource-group MyResourceGroup

Required Parameters

--location -l

Location of the soft-deleted 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.

--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

--name -n

Name of the soft-deleted Cosmos DB account.

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