az backup recoveryconfig
Manage recovery configuration of an Azure workload backed up item.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az backup recoveryconfig show |
Construct the recovery configuration of an Azure workload backed up item. |
Core | GA |
az backup recoveryconfig show
Construct the recovery configuration of an Azure workload backed up item.
For SQL snapshot restores, provide --snapshot-rg and --identity-arm-id. Inspect the generated target_physical_path entries and edit target_path only for volumes that need remapping. Use --recovery-mode SnapshotAttach to attach snapshot disks without recovering databases, or SnapshotAttachAndRecover to recover databases. Use --no-recovery-mode to leave databases in the restoring state. For cross-region restore, generate the configuration normally and specify --use-secondary-region only when submitting it with az backup restore restore-azurewl. Configuration generation reads primary-region metadata. Select a recovery point available in the secondary region and the intended target instance, disk resource group and managed identity for that region. Restore validates the snapshot and log availability in the secondary region.
az backup recoveryconfig show --restore-mode {AlternateWorkloadRestore, OriginalWorkloadRestore, RestoreAsFiles}
[--attach-and-mount {false, true}]
[--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload}]
[--container-name]
[--filepath]
[--from-full-rp-name]
[--identity-arm-id]
[--ids]
[--item-name]
[--log-point-in-time]
[--no-recovery-mode]
[--recovery-mode {SnapshotAttach, SnapshotAttachAndRecover}]
[--resource-group]
[--rp-name]
[--snapshot-rg]
[--subscription]
[--target-container-name]
[--target-instance-name]
[--target-item-name]
[--target-resource-group]
[--target-server-name]
[--target-server-type {HANAInstance, SAPAseDatabase, SAPHanaDBInstance, SAPHanaDatabase, SAPHanaSystem, SQLAG, SQLDatabase, SQLInstance}]
[--target-subscription-id]
[--target-vault-name]
[--vault-name]
[--workload-type {MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase, SQLInstance}]
Examples
Construct the recovery configuration of an Azure workload backed up item. The configuration object stores all details such as the recovery mode, target destinations for the restore and application specific parameters like target physical paths for SQL.
az backup recoveryconfig show --container-name MyContainer --item-name MyItem --resource-group MyResourceGroup --vault-name MyVault --restore-mode OriginalWorkloadRestore
Generate a SQL instance snapshot original-location recovery configuration.
az backup recoveryconfig show --container-name MyContainer --item-name "SQLInstance;mssqlserver" --resource-group MyResourceGroup --vault-name MyVault --workload-type SQLInstance --rp-name MySnapshotRp --restore-mode OriginalWorkloadRestore --recovery-mode SnapshotAttachAndRecover --snapshot-rg RestoreResourceGroup --identity-arm-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/IdentityResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity"
Required Parameters
Specify the restore mode.
| Property | Value |
|---|---|
| Accepted values: | AlternateWorkloadRestore, OriginalWorkloadRestore, RestoreAsFiles |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Specify attach and mount value for HANA Snapshot restores.
| Property | Value |
|---|---|
| Accepted values: | false, true |
Specify the backup management type. Define how Azure Backup manages the backup of entities within the ARM resource. For eg: AzureWorkloads refers to workloads installed within Azure VMs, AzureStorage refers to entities within Storage account. Required only if friendly name is used as Container name.
| Property | Value |
|---|---|
| Default value: | AzureWorkload |
| Accepted values: | AzureIaasVM, AzureStorage, AzureWorkload |
Name of the backup container. Accepts 'Name' or 'FriendlyName' from the output of az backup container list command. If 'FriendlyName' is passed then BackupManagementType is required.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The path to which the DB should be restored as files.
Name of the starting Recovery point.
ARM ID of the user-assigned managed identity for SQL or HANA snapshot restores.
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 |
Name of the backed up item.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Specify the point-in-time (in UTC) which will be restored.
Leave restored SQL databases in the restoring state.
| Property | Value |
|---|---|
| Default value: | False |
SQL snapshot recovery mode. SnapshotAttach attaches disks without recovering databases.
| Property | Value |
|---|---|
| Accepted values: | SnapshotAttach, SnapshotAttachAndRecover |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of the recovery point.
Resource group for restored snapshot disks. Required for SQL snapshot restores; defaults to the target container resource group for HANA.
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 |
The target container to which the DB recovery point should be restored.
Specify the target instance name for the restore operation.
Specify the target item name for the restore operation.
Specify the resource group of target item for Cross Region Restore. Default value will be same as --resource-group if not specified.
Specify the parent server name of the target item.
Specify the type of the server which should be discovered.
| Property | Value |
|---|---|
| Accepted values: | HANAInstance, SAPAseDatabase, SAPHanaDBInstance, SAPHanaDatabase, SAPHanaSystem, SQLAG, SQLDatabase, SQLInstance |
Specify the subscription of the target item for Cross Subscription Restore. Defaulted to source subscription if not specified.
Specify the vault name of target item for Cross Region Restore. Default value will be same as --vault-name if not specified.
Name of the Recovery services vault.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Specify the type of applications within the Resource which should be discovered and protected by Azure Backup. 'MSSQL' and 'SQLDataBase' can be used interchangeably for SQL databases in Azure VM. Use 'SQLInstance' for SQL instance snapshot protection. 'SAPHANA' and 'SAPHanaDatabase' are interchangeable for SAP HANA in Azure VM.
| Property | Value |
|---|---|
| Accepted values: | MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase, SQLInstance |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |