az dataprotection backup-instance restore
Note
This reference is part of the dataprotection extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az dataprotection backup-instance restore command. Learn more about extensions.
Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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 | Experimental |
| 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 | Experimental |
| 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 | Experimental |
| az dataprotection backup-instance restore trigger |
Triggers restore for a BackupInstance. |
Extension | Experimental |
az dataprotection backup-instance restore initialize-for-data-recovery
Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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-9cfce85d4faeRequired Parameters
Specify the datasource type.
Specify the restore location.
Specify the datastore type of the given recovery point or point in time.
Optional Parameters
Specify the backup instance ID.
Specify the point in time which will be used for restoring the data in UTC (yyyy-mm-ddTHH:MM:SS).
Specify the recovery point ID which will be used for restoring the data.
Specify the rehydration duration for rehydrate restore.
Specify the rehydration priority for rehydrate restore.
Restore configuration for restore. Use this parameter to restore with AzureKubernetesService.
Specify the secret store type to use for authentication.
Specify the secret store uri to use for authentication.
Specify the resource ID to which the data will be restored.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az dataprotection backup-instance restore initialize-for-data-recovery-as-files
Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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 9a4ab128e2d441d6a575ecd85903bd81Required Parameters
Specify the datasource type.
Specify the restore location.
Specify the datastore type of the given recovery point or point in time.
Specify the blob container url to which the data will be restored.
Specify the file name to which the data will be restored.
Optional Parameters
Specify the point in time which will be used for restoring the data in UTC (yyyy-mm-ddTHH:MM:SS).
Specify the recovery point ID which will be used for restoring the data.
Specify the rehydration duration for rehydrate restore.
Specify the rehydration priority for rehydrate restore.
Specify the target storage container ARM ID to which data will be restored, required for restoring as files to another subscription.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az dataprotection backup-instance restore initialize-for-item-recovery
Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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]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 container2Required Parameters
Specify the datasource type.
Specify the restore location.
Specify the datastore type of the given recovery point or point in time.
Optional Parameters
Specify the backup instance ID.
Specify the list of containers to restore.
Specify the prefix pattern for start range.
Specify the point in time which will be used for restoring the data in UTC (yyyy-mm-ddTHH:MM:SS).
Specify the recovery point ID which will be used for restoring the data.
Restore configuration for restore. Use this parameter to restore with AzureKubernetesService.
Specify the resource ID to which the data will be restored.
Specify the prefix pattern for end range.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az dataprotection backup-instance restore trigger
Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Triggers restore for a BackupInstance.
az dataprotection backup-instance restore trigger --backup-instance-name
--restore-request-object
[--ids]
[--no-wait]
[--resource-group]
[--subscription]
[--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.jsonTrigger 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-regionRequired Parameters
Backup instance name.
Request body for operation. Expected value: json-string/@json-file.
Optional Parameters
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Use this flag to restore from a recoverypoint in secondary region.
Name of the backup vault.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for