[Backup] az backup recoveryconfig show: Add more parameters to support restoring as files for SQL/SAP Hana

src/azure-cli/HISTORY.rst

@@ -7,6 +7,10 @@ Release History
 
 * az ams is now GA.
 
+**Backup**
+
+* Added restore as files support for SQL and SAP Databases.
+
 **SQL**
 
 * Update SQL Managed Instance cmdlet `az sql mi update` with two new parameters: tier and family.

src/azure-cli/azure/cli/command_modules/backup/_params.py

@@ -38,6 +38,7 @@
 retain_until_help = """The date until which this backed up copy will be available for retrieval, in UTC (d-m-Y). For SAPHANA and SQL workload, retain-until parameter value will be overridden by the underlying policy."""
 diskslist_help = """List of disks to be excluded or included."""
 disk_list_setting_help = """option to decide whether to include or exclude the disk or reset any previous settings to default behavior"""
+target_container_name_help = """The target container to which the DB recovery point should be downloaded as files."""
 
 vault_name_type = CLIArgumentType(help='Name of the Recovery services vault.', options_list=['--vault-name', '-v'], completer=get_resource_name_completion_list('Microsoft.RecoveryServices/vaults'))
 container_name_type = CLIArgumentType(help=container_name_help, options_list=['--container-name', '-c'])
@@ -48,14 +49,17 @@
 backup_management_type = CLIArgumentType(help=backup_management_type_help, arg_type=get_enum_type(allowed_backup_management_types), options_list=['--backup-management-type'])
 workload_type = CLIArgumentType(help=workload_type_help, arg_type=get_enum_type(allowed_workload_types), options_list=['--workload-type'])
 restore_mode_type = CLIArgumentType(help=restore_mode_help, arg_type=get_enum_type(['OriginalLocation', 'AlternateLocation']), options_list=['--restore-mode'])
-restore_mode_workload_type = CLIArgumentType(help=restore_mode_help, arg_type=get_enum_type(['AlternateWorkloadRestore', 'OriginalWorkloadRestore']), options_list=['--restore-mode'])
+restore_mode_workload_type = CLIArgumentType(help=restore_mode_help, arg_type=get_enum_type(['AlternateWorkloadRestore', 'OriginalWorkloadRestore', 'RestoreAsFiles']), options_list=['--restore-mode'])
 resolve_conflict_type = CLIArgumentType(help=resolve_conflict_help, arg_type=get_enum_type(['Overwrite', 'Skip']), options_list=['--resolve-conflict'])
 resource_id_type = CLIArgumentType(help=resource_id_help, options_list=['--resource-id'])
 policy_type = CLIArgumentType(help=policy_help, options_list=['--policy'], completer=FilesCompleter(), type=file_type)
 protectable_item_type = CLIArgumentType(help=workload_type_help, options_list=['--protectable-item-type'], arg_type=get_enum_type(allowed_protectable_item_type))
 target_server_type = CLIArgumentType(help=target_server_type_help, options_list=['--target-server-type'], arg_type=get_enum_type(allowed_protectable_item_type))
 protectable_item_name_type = CLIArgumentType(help=protectable_item_name_type_help, options_list=['--protectable-item-name'])
 diskslist_type = CLIArgumentType(nargs='+', help=diskslist_help)
+target_container_name_type = CLIArgumentType(options_list=['--target-container-name'], help=target_container_name_help)
+filepath_type = CLIArgumentType(options_list=['--filepath'], help="The path to which the DB should be restored as files.")
+from_full_rp_type = CLIArgumentType(options_list=['--from-full-rp-name'], help="Name of the starting Recovery point.")
 
 
 # pylint: disable=too-many-statements
@@ -272,6 +276,11 @@ def load_arguments(self, _):
         c.argument('target_server_type', target_server_type)
         c.argument('target_server_name', options_list=['--target-server-name'], help="""Specify the parent server name of the target item.""")
         c.argument('workload_type', workload_type)
+        c.argument('target_container_name', target_container_name_type)
+        c.argument('from_full_rp_name', from_full_rp_type)
+        c.argument('filepath', filepath_type)
+        c.argument('backup_management_type', backup_management_type)
+
     # Job
     with self.argument_context('backup job') as c:
         c.argument('vault_name', vault_name_type, id_part='name')

src/azure-cli/azure/cli/command_modules/backup/custom_base.py

@@ -366,15 +366,26 @@ def restore_azure_wl(cmd, client, resource_group_name, vault_name, recovery_conf
 
 def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_mode, container_name, item_name,
                          rp_name=None, target_item_name=None, log_point_in_time=None, target_server_type=None,
-                         target_server_name=None, workload_type=None):
+                         target_server_name=None, workload_type=None, backup_management_type="AzureWorkload",
+                         from_full_rp_name=None, filepath=None, target_container_name=None):
     target_item = None
     if target_item_name is not None:
         protectable_items_client = backup_protectable_items_cf(cmd.cli_ctx)
         target_item = show_protectable_instance(cmd, protectable_items_client, resource_group_name, vault_name,
                                                 target_server_name, target_server_type,
                                                 workload_type, container_name)
+    target_container = None
+    if target_container_name is not None:
+        container_client = backup_protection_containers_cf(cmd.cli_ctx)
+        target_container = common.show_container(cmd, container_client, target_container_name, resource_group_name,
+                                                 vault_name, backup_management_type)
+
+        if isinstance(target_container, list):
+            raise CLIError("Multiple containers with same Friendly Name found. Please give native names instead.")
+
     return custom_wl.show_recovery_config(cmd, client, resource_group_name, vault_name, restore_mode, container_name,
-                                          item_name, rp_name, target_item, target_item_name, log_point_in_time)
+                                          item_name, rp_name, target_item, target_item_name, log_point_in_time,
+                                          from_full_rp_name, filepath, target_container)
 
 
 def undelete_protection(cmd, client, resource_group_name, vault_name, container_name, item_name,

src/azure-cli/azure/cli/command_modules/backup/custom_wl.py

@@ -7,6 +7,8 @@
 import azure.cli.command_modules.backup.custom_common as common
 # pylint: disable=import-error
 # pylint: disable=broad-except
+# pylint: disable=too-many-locals
+# pylint: disable=too-many-statements
 
 from uuid import uuid4
 from azure.cli.command_modules.backup._validators import datetime_type
@@ -461,22 +463,30 @@ def restore_azure_wl(cmd, client, resource_group_name, vault_name, recovery_conf
     database_name = recovery_config_object['database_name']
     container_id = recovery_config_object['container_id']
     alternate_directory_paths = recovery_config_object['alternate_directory_paths']
+    recovery_mode = recovery_config_object['recovery_mode']
+    filepath = recovery_config_object['filepath']
 
     # Construct trigger restore request object
     trigger_restore_properties = _get_restore_request_instance(item_type, log_point_in_time)
     trigger_restore_properties.recovery_type = restore_mode
 
     if restore_mode == 'AlternateLocation':
-        setattr(trigger_restore_properties, 'source_resource_id', source_resource_id)
-        setattr(trigger_restore_properties, 'target_info', TargetRestoreInfo(overwrite_option='Overwrite',
-                                                                             database_name=database_name,
-                                                                             container_id=container_id))
-        if 'sql' in item_type.lower():
-            directory_map = []
-            for i in alternate_directory_paths:
-                directory_map.append(SQLDataDirectoryMapping(mapping_type=i[0], source_path=i[1],
-                                                             source_logical_name=i[2], target_path=i[3]))
-            setattr(trigger_restore_properties, 'alternate_directory_paths', directory_map)
+        if recovery_mode != "FileRecovery":
+            setattr(trigger_restore_properties, 'source_resource_id', source_resource_id)
+            setattr(trigger_restore_properties, 'target_info', TargetRestoreInfo(overwrite_option='Overwrite',
+                                                                                 database_name=database_name,
+                                                                                 container_id=container_id))
+            if 'sql' in item_type.lower():
+                directory_map = []
+                for i in alternate_directory_paths:
+                    directory_map.append(SQLDataDirectoryMapping(mapping_type=i[0], source_path=i[1],
+                                                                 source_logical_name=i[2], target_path=i[3]))
+                setattr(trigger_restore_properties, 'alternate_directory_paths', directory_map)
+        else:
+            target_info = TargetRestoreInfo(overwrite_option='Overwrite', container_id=container_id,
+                                            target_directory_for_file_restore=filepath)
+            setattr(trigger_restore_properties, 'target_info', target_info)
+            trigger_restore_properties.recovery_mode = recovery_mode
 
     if log_point_in_time is not None:
         setattr(trigger_restore_properties, 'point_in_time', datetime_type(log_point_in_time))
@@ -493,7 +503,8 @@ def restore_azure_wl(cmd, client, resource_group_name, vault_name, recovery_conf
 
 
 def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_mode, container_name, item_name,
-                         rp_name, target_item, target_item_name, log_point_in_time):
+                         rp_name, target_item, target_item_name, log_point_in_time, from_full_rp_name,
+                         filepath, target_container):
     if log_point_in_time is not None:
         datetime_type(log_point_in_time)
 
@@ -511,6 +522,9 @@ def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_m
                 Target Item must be either of type HANAInstance or SQLInstance.
                 """)
 
+    if restore_mode == 'RestoreAsFiles' and target_container is None:
+        raise CLIError("Target Container must be provided.")
+
     if rp_name is None and log_point_in_time is None:
         raise CLIError(
             """
@@ -531,7 +545,11 @@ def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_m
 
     # Mapping of restore mode
     restore_mode_map = {'OriginalWorkloadRestore': 'OriginalLocation',
-                        'AlternateWorkloadRestore': 'AlternateLocation'}
+                        'AlternateWorkloadRestore': 'AlternateLocation',
+                        'RestoreAsFiles': 'AlternateLocation'}
+
+    if rp_name is None and restore_mode == "RestoreAsFiles" and from_full_rp_name is not None:
+        rp_name = from_full_rp_name
     rp_name = rp_name if rp_name is not None else 'DefaultRangeRecoveryPoint'
 
     if rp_name == 'DefaultRangeRecoveryPoint':
@@ -573,6 +591,11 @@ def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_m
     if not ('sql' in item_type.lower() and restore_mode == 'AlternateWorkloadRestore'):
         alternate_directory_paths = None
 
+    recovery_mode = None
+    if restore_mode == 'RestoreAsFiles':
+        recovery_mode = 'FileRecovery'
+        container_id = target_container.id
+
     return {
         'restore_mode': restore_mode_map[restore_mode],
         'container_uri': item.properties.container_name,
@@ -583,6 +606,8 @@ def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_m
         'source_resource_id': item.properties.source_resource_id,
         'database_name': db_name,
         'container_id': container_id,
+        'recovery_mode': recovery_mode,
+        'filepath': filepath,
         'alternate_directory_paths': alternate_directory_paths}