Share via

az dataprotection backup-instance deleted-backup-instance

  • Reference

Note

This reference is part of the dataprotection extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az dataprotection backup-instance deleted-backup-instance command. Learn more about extensions.

Perform operations on soft-deleted backup instances.

Commands

Name Description Type Status
az dataprotection backup-instance deleted-backup-instance list

List deleted backup instances belonging to a backup vault.

 Extension GA
az dataprotection backup-instance deleted-backup-instance show

Get a deleted backup instance with name in a backup vault.

 Extension GA
az dataprotection backup-instance deleted-backup-instance undelete

Undelete soft-deleted backup instances.

 Extension GA

az dataprotection backup-instance deleted-backup-instance list

List deleted backup instances belonging to a backup vault.

az dataprotection backup-instance deleted-backup-instance list --resource-group
                                                               --vault-name
                                                               [--max-items]
                                                               [--next-token]

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vault-name -v

The name of the backup vault.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dataprotection backup-instance deleted-backup-instance show

Get a deleted backup instance with name in a backup vault.

az dataprotection backup-instance deleted-backup-instance show [--backup-instance-name]
                                                               [--ids]
                                                               [--resource-group]
                                                               [--subscription]
                                                               [--vault-name]

Optional Parameters

--backup-instance-name --name -n

The name of the deleted backup instance.

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

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--vault-name -v

The name of the backup vault.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az dataprotection backup-instance deleted-backup-instance undelete

Undelete soft-deleted backup instances.

az dataprotection backup-instance deleted-backup-instance undelete [--backup-instance-name]
                                                                   [--ids]
                                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                   [--resource-group]
                                                                   [--subscription]
                                                                   [--vault-name]

Optional Parameters

--backup-instance-name --name -n

The name of the deleted backup instance.

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

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--vault-name -v

The name of the backup vault.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.