az dataprotection backup-instance deleted-backup-instance

Note

This reference is part of the dataprotection extension for the Azure CLI (version 2.67.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

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

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination 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.

--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 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 --name]
                                                               [--ids]
                                                               [--resource-group]
                                                               [--subscription]
                                                               [--vault-name]

Optional Parameters

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

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

The name of the deleted backup instance.

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

--resource-group -g

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

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

--vault-name -v

The name of the backup vault.

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 dataprotection backup-instance deleted-backup-instance undelete

Undelete soft-deleted backup instances.

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

Optional Parameters

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

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

The name of the deleted backup instance.

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

--no-wait

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

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

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

--vault-name -v

The name of the backup vault.

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