Share via

az dataprotection backup-instance restore

  • 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 restore command. Learn more about extensions.

Restore backed up instances from recovery points in a backup vault.

Commands

Name Description Type Status
az dataprotection backup-instance restore initialize-for-data-recovery

Initialize restore request object to recover all backed up data in a backup vault.

 Extension GA
az dataprotection backup-instance restore initialize-for-data-recovery-as-files

Initialize restore request object to recover all backed up data as files in a backup vault.

 Extension GA
az dataprotection backup-instance restore initialize-for-item-recovery

Initialize restore request object to recover specified items of backed up data in a backup vault.

 Extension GA
az dataprotection backup-instance restore trigger

Triggers restore for a BackupInstance.

 Extension GA

az dataprotection backup-instance restore initialize-for-data-recovery

Initialize restore request object to recover all backed up data in a backup vault.

az dataprotection backup-instance restore initialize-for-data-recovery --datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}
                                                                       --restore-location
                                                                       --source-datastore {ArchiveStore, OperationalStore, VaultStore}
                                                                       [--backup-instance-id]
                                                                       [--point-in-time]
                                                                       [--recovery-point-id]
                                                                       [--rehydration-duration]
                                                                       [--rehydration-priority {Standard}]
                                                                       [--restore-configuration]
                                                                       [--secret-store-type {AzureKeyVault}]
                                                                       [--secret-store-uri]
                                                                       [--target-resource-id]

Examples

initialize restore request for azure disk backup instance

az dataprotection backup-instance restore initialize-for-data-recovery --datasource-type AzureDisk --restore-location centraluseuap --source-datastore OperationalStore --target-resource-id {restore_disk_id} --recovery-point-id b7e6f082-b310-11eb-8f55-9cfce85d4fae

Required Parameters

--datasource-type

Specify the datasource type.

Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService
--restore-location

Specify the restore location.

--source-datastore

Specify the datastore type of the given recovery point or point in time.

Accepted values: ArchiveStore, OperationalStore, VaultStore

Optional Parameters

--backup-instance-id

Specify the backup instance ID.

--point-in-time

Specify the point in time which will be used for restoring the data in UTC (yyyy-mm-ddTHH:MM:SS).

--recovery-point-id

Specify the recovery point ID which will be used for restoring the data.

--rehydration-duration

Specify the rehydration duration for rehydrate restore.

Default value: 15
--rehydration-priority

Specify the rehydration priority for rehydrate restore.

Accepted values: Standard
--restore-configuration

Restore configuration for restore. Use this parameter to restore with AzureKubernetesService.

--secret-store-type

Specify the secret store type to use for authentication.

Accepted values: AzureKeyVault
--secret-store-uri

Specify the secret store uri to use for authentication.

--target-resource-id

Specify the resource ID to which the data will be restored.

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 restore initialize-for-data-recovery-as-files

Initialize restore request object to recover all backed up data as files in a backup vault.

az dataprotection backup-instance restore initialize-for-data-recovery-as-files --datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}
                                                                                --restore-location
                                                                                --source-datastore {ArchiveStore, OperationalStore, VaultStore}
                                                                                --target-blob-container-url
                                                                                --target-file-name
                                                                                [--point-in-time]
                                                                                [--recovery-point-id]
                                                                                [--rehydration-duration]
                                                                                [--rehydration-priority {Standard}]
                                                                                [--target-resource-id]

Examples

initialize restore request for azure database as files for postgresql server backup instance

az dataprotection backup-instance restore initialize-for-data-recovery-as-files --datasource-type AzureDatabaseForPostgreSQL --restore-location centraluseuap --source-datastore VaultStore --target-blob-container-url {target_blob_container_url} --target-file-name {target_file_name} --recovery-point-id 9a4ab128e2d441d6a575ecd85903bd81

Required Parameters

--datasource-type

Specify the datasource type.

Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService
--restore-location

Specify the restore location.

--source-datastore

Specify the datastore type of the given recovery point or point in time.

Accepted values: ArchiveStore, OperationalStore, VaultStore
--target-blob-container-url

Specify the blob container url to which the data will be restored.

--target-file-name

Specify the file name to which the data will be restored.

Optional Parameters

--point-in-time

Specify the point in time which will be used for restoring the data in UTC (yyyy-mm-ddTHH:MM:SS).

--recovery-point-id

Specify the recovery point ID which will be used for restoring the data.

--rehydration-duration

Specify the rehydration duration for rehydrate restore.

Default value: 15
--rehydration-priority

Specify the rehydration priority for rehydrate restore.

Accepted values: Standard
--target-resource-id

Specify the target storage container ARM ID to which data will be restored, required for restoring as files to another subscription.

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 restore initialize-for-item-recovery

Initialize restore request object to recover specified items of backed up data in a backup vault.

az dataprotection backup-instance restore initialize-for-item-recovery --datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}
                                                                       --restore-location
                                                                       --source-datastore {ArchiveStore, OperationalStore, VaultStore}
                                                                       [--backup-instance-id]
                                                                       [--container-list]
                                                                       [--from-prefix-pattern]
                                                                       [--point-in-time]
                                                                       [--recovery-point-id]
                                                                       [--restore-configuration]
                                                                       [--target-resource-id]
                                                                       [--to-prefix-pattern]
                                                                       [--vaulted-blob-prefix]

Examples

initialize restore request for azure blob backup instance

az dataprotection backup-instance restore initialize-for-item-recovery --datasource-type AzureBlob --restore-location centraluseuap --source-datastore OperationalStore --backup-instance-id {backup_instance_id}  --point-in-time 2021-05-26T15:00:00 --container-list container1 container2

Required Parameters

--datasource-type

Specify the datasource type.

Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService
--restore-location

Specify the restore location.

--source-datastore

Specify the datastore type of the given recovery point or point in time.

Accepted values: ArchiveStore, OperationalStore, VaultStore

Optional Parameters

--backup-instance-id

Specify the backup instance ID.

--container-list

Specify the list of containers to restore.

--from-prefix-pattern

Specify the prefix pattern for start range.

--point-in-time

Specify the point in time which will be used for restoring the data in UTC (yyyy-mm-ddTHH:MM:SS).

--recovery-point-id

Specify the recovery point ID which will be used for restoring the data.

--restore-configuration

Restore configuration for restore. Use this parameter to restore with AzureKubernetesService.

--target-resource-id

Specify the resource ID to which the data will be restored.

--to-prefix-pattern

Specify the prefix pattern for end range.

--vaulted-blob-prefix --vaulted-blob-prefix-pattern

Specify the prefix pattern for vaulted blobs.

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

Triggers restore for a BackupInstance.

az dataprotection backup-instance restore trigger --backup-instance-name
                                                  --restore-request-object
                                                  [--ids]
                                                  [--no-wait]
                                                  [--operation-requests]
                                                  [--resource-group]
                                                  [--subscription]
                                                  [--tenant-id]
                                                  [--use-secondary-region {false, true}]
                                                  [--vault-name]

Examples

Trigger a restore operation

az dataprotection backup-instance restore trigger -g sample_rg --vault-name sample_backupvault --backup-instance-name sample_biname-fd53a211-3f3e-4c7e-ba45-81050e27c0be  --restore-request-object restorerequestobject.json

Trigger a cross-region-restore operation

az dataprotection backup-instance restore trigger -g sample_rg --vault-name sample_backupvault --backup-instance-name sample_biname-fd53a211-3f3e-4c7e-ba45-81050e27c0be  --restore-request-object restorerequestobject.json --use-secondary-region

Required Parameters

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

Backup instance name.

--restore-request-object

Request body for operation. Expected value: json-string/@json-file.

Optional Parameters

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

Default value: False
--operation-requests --resource-guard-operation-requests

Critical operation request which is protected by the resourceGuard.

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

--tenant-id

ID of the tenant if the Resource Guard protecting the vault exists in a different tenant.

--use-secondary-region

Use this flag to restore from a recoverypoint in secondary region.

Accepted values: false, true
--vault-name -v

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.