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

Edit

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

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]
                              [--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}]

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

--restore-mode

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.

--attach-and-mount

Specify attach and mount value for HANA Snapshot restores.

Property	Value
Accepted values:	false, true

--backup-management-type

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

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

Property	Value
Parameter group:	Resource Id Arguments

--filepath

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

--from-full-rp-name

Name of the starting Recovery point.

--identity-arm-id

Set Identity ARM ID for HANA Snapshot restores.

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

Property	Value
Parameter group:	Resource Id Arguments

--item-name -i

Name of the backed up item.

Property	Value
Parameter group:	Resource Id Arguments

--log-point-in-time

Specify the point-in-time (in UTC) which will be restored.

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--rp-name -r

Name of the recovery point.

--snapshot-rg

Specify the resource group for HANA Snapshot Instance restores. If not provided, the default value will be fetched from the target container details.

--subscription

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

--target-container-name

The target container to which the DB recovery point should be restored.

--target-instance-name

Specify the target instance name for the restore operation.

--target-item-name

Specify the target item name for the restore operation.

--target-resource-group

Specify the resource group of target item for Cross Region Restore. Default value will be same as --resource-group if not specified.

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

Property	Value
Accepted values:	HANAInstance, SAPAseDatabase, SAPHanaDBInstance, SAPHanaDatabase, SAPHanaSystem, SQLAG, SQLDatabase, SQLInstance

--target-subscription-id

Specify the subscription of the target item for Cross Subscription Restore. Defaulted to source subscription if not specified.

--target-vault-name

Specify the vault name of target item for Cross Region Restore. Default value will be same as --vault-name if not specified.

--vault-name -v

Name of the Recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

--workload-type

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 in Azure VM, as can 'SAPHANA' and 'SAPHanaDatabase' for SAP HANA in Azure VM.

Property	Value
Accepted values:	MSSQL, SAPASE, SAPAseDatabase, SAPHANA, SAPHanaDBInstance, SAPHanaDatabase, SQLDataBase

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Share via

az backup recoveryconfig

Commands