az backup recoveryconfig

Manage recovery configuration of an Azure workload backed up item.

Commands

az backup recoveryconfig show

Construct the recovery configuration of an Azure workload backed up item.

az backup recoveryconfig show

Construct the recovery configuration of an Azure workload backed up item.

az backup recoveryconfig show --container-name
                              --item-name
                              --resource-group
                              --restore-mode {AlternateWorkloadRestore, OriginalWorkloadRestore, RestoreAsFiles}
                              --vault-name
                              [--backup-management-type {AzureIaasVM, AzureStorage, AzureWorkload}]
                              [--filepath]
                              [--from-full-rp-name]
                              [--log-point-in-time]
                              [--query-examples]
                              [--rp-name]
                              [--subscription]
                              [--target-container-name]
                              [--target-item-name]
                              [--target-server-name]
                              [--target-server-type {HANAInstance, SAPHanaDatabase, SAPHanaSystem, SQLAG, SQLDatabase, SQLInstance}]
                              [--workload-type {AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM}]

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

Required Parameters

--container-name -c

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.

--item-name -i

Name of the backed up item.

--resource-group -g

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

--restore-mode

Specify the restore mode.

accepted values: AlternateWorkloadRestore, OriginalWorkloadRestore, RestoreAsFiles
--vault-name -v

Name of the Recovery services vault.

Optional Parameters

--backup-management-type

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

accepted values: AzureIaasVM, AzureStorage, AzureWorkload
default value: AzureWorkload
--filepath

The path to which the DB should be restored as files.

--from-full-rp-name

Name of the starting Recovery point.

--log-point-in-time

Specify the point-in-time which will be restored.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--rp-name -r

Name of the recovery point.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--target-container-name

The target container to which the DB recovery point should be downloaded as files.

--target-item-name

Specify the target item name for the restore operation.

--target-server-name

Specify the parent server name of the target item.

--target-server-type

Specify the type of the server which should be discovered.

accepted values: HANAInstance, SAPHanaDatabase, SAPHanaSystem, SQLAG, SQLDatabase, SQLInstance
--workload-type

Specifiy the type of applications within the Resource which should be discovered and protected by Azure Backup.

accepted values: AzureFileShare, MSSQL, SAPHANA, SAPHanaDatabase, SQLDataBase, VM