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 restore command. Learn more about extensions.
Restore backed up instances from recovery points in a backup vault.
Commands az dataprotection backup-instance restore initialize-for-data-recoveryInitialize 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]
[--mi-system-assigned --use-system-assigned-identity --use-system-identity {false, true}]
[--mi-user-assigned --uami --user-assigned-identity-arm-url]
[--point-in-time]
[--recovery-point-id]
[--rehydration-duration]
[--rehydration-priority {Standard}]
[--restore-configuration]
[--secret-store-type {AzureKeyVault}]
[--secret-store-uri]
[--target-resource-id]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-9cfce85d4faeSpecify the datasource type.
Property Value Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesServiceSpecify the restore location.
Specify the datastore type of the given recovery point or point in time.
Property Value Accepted values: ArchiveStore, OperationalStore, VaultStore Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Specify the backup instance ID.
--mi-system-assigned --use-system-assigned-identity --use-system-identity
Use system assigned identity.
Property Value Accepted values: false, true--mi-user-assigned --uami --user-assigned-identity-arm-url
ARM ID of the User Assigned Managed Identity.
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.
Property Value Default value: 15Specify the rehydration priority for rehydrate restore.
Property Value Accepted values: StandardRestore configuration for restore. Use this parameter to restore with AzureKubernetesService.
Specify the secret store type to use for authentication.
Property Value Accepted values: AzureKeyVaultSpecify the secret store uri to use for authentication.
Specify the resource ID to which the data will be restored.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath 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.
Property Value Default value: False az dataprotection backup-instance restore initialize-for-data-recovery-as-filesInitialize 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
[--mi-system-assigned --use-system-assigned-identity --use-system-identity {false, true}]
[--mi-user-assigned --uami --user-assigned-identity-arm-url]
[--point-in-time]
[--recovery-point-id]
[--rehydration-duration]
[--rehydration-priority {Standard}]
[--target-resource-id]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 9a4ab128e2d441d6a575ecd85903bd81Specify the datasource type.
Property Value Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesServiceSpecify the restore location.
Specify the datastore type of the given recovery point or point in time.
Property Value Accepted values: ArchiveStore, OperationalStore, VaultStore--target-blob-container-url
Specify the blob container url to which the data will be restored.
Specify the file name to which the data will be restored.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
--mi-system-assigned --use-system-assigned-identity --use-system-identity
Use system assigned identity.
Property Value Accepted values: false, true--mi-user-assigned --uami --user-assigned-identity-arm-url
ARM ID of the User Assigned Managed Identity.
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.
Property Value Default value: 15Specify the rehydration priority for rehydrate restore.
Property Value Accepted values: StandardSpecify the target storage container ARM ID to which data will be restored, required for restoring as files to another subscription.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath 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.
Property Value Default value: False az dataprotection backup-instance restore initialize-for-item-recoveryInitialize 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]
[--mi-system-assigned --use-system-assigned-identity --use-system-identity {false, true}]
[--mi-user-assigned --uami --user-assigned-identity-arm-url]
[--point-in-time]
[--recovery-point-id]
[--restore-configuration]
[--target-resource-id]
[--to-prefix-pattern]
[--vaulted-blob-prefix --vaulted-blob-prefix-pattern]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 container2Specify the datasource type.
Property Value Accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesServiceSpecify the restore location.
Specify the datastore type of the given recovery point or point in time.
Property Value Accepted values: ArchiveStore, OperationalStore, VaultStore Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Specify the backup instance ID.
Specify the list of containers to restore.
Specify the prefix pattern for start range.
--mi-system-assigned --use-system-assigned-identity --use-system-identity
Use system assigned identity.
Property Value Accepted values: false, true--mi-user-assigned --uami --user-assigned-identity-arm-url
ARM ID of the User Assigned Managed Identity.
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.
--vaulted-blob-prefix --vaulted-blob-prefix-pattern
Specify the prefix pattern for vaulted blobs.
Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath 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.
Property Value Default value: False az dataprotection backup-instance restore triggerTriggers restore for a BackupInstance.
az dataprotection backup-instance restore trigger --backup-instance-name --name
--restore-request-object
[--ids]
[--no-wait]
[--operation-requests --resource-guard-operation-requests]
[--resource-group]
[--subscription]
[--tenant-id]
[--use-secondary-region {false, true}]
[--vault-name]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-region--backup-instance-name --name -n
Backup instance name.
Request body for operation. Expected value: json-string/@json-file.
Optional ParametersThe following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 ArgumentsDo not wait for the long-running operation to finish.
Property Value Default value: False--operation-requests --resource-guard-operation-requests
Critical operation request which is protected by the resourceGuard.
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.
ID of the tenant if the Resource Guard protecting the vault exists in a different tenant.
Use this flag to restore from a recoverypoint in secondary region.
Property Value Accepted values: false, trueName of the backup vault.
Property Value Parameter group: Resource Id Arguments Global ParametersIncrease logging verbosity to show all debug logs.
Property Value Default value: FalseShow this help message and exit.
Only show errors, suppressing warnings.
Property Value Default value: FalseOutput format.
Property Value Default value: json Accepted values: json, jsonc, none, table, tsv, yaml, yamlcJMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property Value Default value: FalseRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4