[Backup] az backup: Add support for HANA Snapshot (#27932)

Author: zubairabid

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

@@ -21,11 +21,11 @@
 # ARGUMENT DEFINITIONS
 
 allowed_container_types = ['AzureIaasVM']
-allowed_workload_types = ['VM', 'AzureFileShare', 'SAPHANA', 'SAPASE', 'MSSQL', 'SAPHanaDatabase', 'SQLDataBase', 'SAPAseDatabase']
-allowed_azure_workload_types = ['MSSQL', 'SAPHANA', 'SAPASE', 'SAPAseDatabase', 'SAPHanaDatabase', 'SQLDataBase']
+allowed_workload_types = ['VM', 'AzureFileShare', 'SAPHANA', 'SAPASE', 'MSSQL', 'SAPHanaDatabase', 'SQLDataBase', 'SAPAseDatabase', 'SAPHanaDBInstance']
+allowed_azure_workload_types = ['MSSQL', 'SAPHANA', 'SAPASE', 'SAPAseDatabase', 'SAPHanaDatabase', 'SQLDataBase', 'SAPHanaDBInstance']
 allowed_backup_management_types = ['AzureIaasVM', 'AzureStorage', 'AzureWorkload']
 allowed_extended_backup_management_types = allowed_backup_management_types + ['MAB']
-allowed_protectable_item_type = ['SQLAG', 'SQLInstance', 'SQLDatabase', 'HANAInstance', 'SAPAseDatabase', 'SAPHanaDatabase', 'SAPHanaSystem']
+allowed_protectable_item_type = ['SQLAG', 'SQLInstance', 'SQLDatabase', 'HANAInstance', 'SAPAseDatabase', 'SAPHanaDatabase', 'SAPHanaSystem', 'SAPHanaDBInstance']
 allowed_target_tier_type_chk_archivable = ['VaultArchive']
 allowed_tier_type = ['VaultStandard', 'Snapshot', 'VaultArchive', 'VaultStandardRehydrated', 'SnapshotAndVaultStandard', 'SnapshotAndVaultArchive']
 allowed_rehyd_priority_type = ['Standard', 'High']
@@ -453,6 +453,9 @@ def load_arguments(self, _):
         c.argument('target_resource_group', options_list=['--target-resource-group'], help="""Specify the resource group of target item for Cross Region Restore. Default value will be same as --resource-group if not specified.""")
         c.argument('target_vault_name', options_list=['--target-vault-name'], help="""Specify the vault name of target item for Cross Region Restore. Default value will be same as --vault-name if not specified.""")
         c.argument('target_subscription_id', help="""Specify the subscription of the target item for Cross Subscription Restore. Defaulted to source subscription if not specified.""")
+        c.argument('attach_and_mount', arg_type=get_three_state_flag(), help='Specify attach and mount value for HANA Snapshot restores.')
+        c.argument('identity_arm_id', help='Set Identity ARM ID for HANA Snapshot restores.')
+        c.argument('snapshot_instance_resource_group', options_list=['--snapshot-rg'], help="""Specify the resource group for HANA Snapshot Instance restores. If not provided, the default value will be fetched from the target container details.""")
 
     # Job
     with self.argument_context('backup job') as c:

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

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
 
+# pylint: disable=line-too-long
+
 from datetime import datetime
 from azure.cli.core.azclierror import RequiredArgumentMissingError, MutuallyExclusiveArgumentError, \
     ArgumentUsageError, InvalidArgumentValueError
@@ -71,7 +73,7 @@ def validate_wl_restore(item, item_type, restore_mode, recovery_mode):
             operation. Allowed values are: 'OriginalLocation', 'AlternateLocation'.
             """)
 
-    if recovery_mode is not None and recovery_mode != 'FileRecovery':
+    if recovery_mode is not None and recovery_mode not in ['FileRecovery', 'SnapshotAttachAndRecover', 'SnapshotAttach']:
         raise InvalidArgumentValueError("""
             The recovery_mode specified in recovery config file is incorrect. Please correct it and retry the
             operation.

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

@@ -524,7 +524,8 @@ def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_m
                          rp_name=None, target_item_name=None, log_point_in_time=None, target_server_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_resource_group=None,
-                         target_vault_name=None, target_subscription_id=None, target_instance_name=None):
+                         target_vault_name=None, target_subscription_id=None, target_instance_name=None,
+                         attach_and_mount=None, identity_arm_id=None, snapshot_instance_resource_group=None):
     target_subscription = get_subscription_id(cmd.cli_ctx)
     if target_subscription_id is not None:
         vault_csr_state = custom.get_vault_csr_state(vaults_cf(cmd.cli_ctx).get(resource_group_name, vault_name))
@@ -563,7 +564,9 @@ def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_m
     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,
                                           from_full_rp_name, filepath, target_container, target_resource_group,
-                                          target_vault_name, target_subscription)
+                                          target_vault_name, target_subscription, workload_type=workload_type,
+                                          attach_and_mount=attach_and_mount, identity_arm_id=identity_arm_id,
+                                          snapshot_instance_resource_group=snapshot_instance_resource_group)
 
 
 def undelete_protection(cmd, client, resource_group_name, vault_name, container_name, item_name,

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

@@ -23,12 +23,14 @@
                      'SAPHANA': 'SAPHanaDatabase',
                      'SQLDataBase': 'SQLDataBase',
                      'SAPHanaDatabase': 'SAPHanaDatabase',
+                     'SAPHanaDBInstance': 'SAPHanaDBInstance',
                      'SAPAseDatabase': 'SAPAseDatabase',
                      'VM': 'VM',
                      'AzureFileShare': 'AzureFileShare'}
 
 workload_bmt_map = {'SQLDataBase': 'AzureWorkload',
                     'SAPHanaDatabase': 'AzureWorkload',
+                    'SAPHanaDBInstance': 'AzureWorkload',
                     'SAPAseDatabase': 'AzureWorkload',
                     'VM': 'AzureIaasVM',
                     'AzureFileShare': 'AzureStorage'}

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

@@ -71,7 +71,7 @@ def is_sql(resource_type):
 
 
 def is_hana(resource_type):
-    return resource_type.lower() == 'saphanadatabase'
+    return resource_type.lower() == 'saphanadatabase' or resource_type.lower() == "saphanadbinstance"
 
 
 def is_sapase(resource_type):

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

@@ -10,6 +10,7 @@
 # pylint: disable=broad-except
 # pylint: disable=too-many-locals
 # pylint: disable=too-many-statements
+# pylint: disable=too-many-branches
 
 from knack.log import get_logger
 
@@ -21,8 +22,9 @@
     AzureWorkloadSQLPointInTimeRestoreRequest, AzureWorkloadSAPAsePointInTimeRestoreRequest, \
     AzureVmWorkloadSAPHanaDatabaseProtectedItem, AzureVmWorkloadSQLDatabaseProtectedItem, \
     RecoveryPointRehydrationInfo, AzureWorkloadSAPHanaRestoreWithRehydrateRequest, \
-    AzureWorkloadSQLRestoreWithRehydrateRequest, ProtectionState, AzureVmWorkloadSAPAseDatabaseProtectedItem, \
-    MoveRPAcrossTiersRequest \
+    AzureWorkloadSQLRestoreWithRehydrateRequest, ProtectionState, SnapshotRestoreParameters, \
+    UserAssignedManagedIdentityDetails, UserAssignedIdentityProperties, \
+    AzureVmWorkloadSAPAseDatabaseProtectedItem, MoveRPAcrossTiersRequest
 
 from azure.mgmt.recoveryservicesbackup.passivestamp.models import CrossRegionRestoreRequest
 
@@ -41,6 +43,7 @@
 
 from azure.mgmt.recoveryservicesbackup.activestamp import RecoveryServicesBackupClient
 from azure.cli.core.commands.client_factory import get_mgmt_service_client
+from azure.cli.core.profiles import ResourceType
 
 
 fabric_name = "Azure"
@@ -51,6 +54,7 @@
                      'SAPHANA': 'SAPHanaDatabase',
                      'SQLDataBase': 'SQLDataBase',
                      'SAPHanaDatabase': 'SAPHanaDatabase',
+                     'SAPHanaDBInstance': 'SAPHanaDBInstance',
                      'SAPASE': 'SAPAseDatabase',
                      'SAPAseDatabase': 'SAPAseDatabase'}
 
@@ -70,6 +74,7 @@
                              'HANAInstance': 'SAPHanaSystem',
                              'SAPHanaSystem': 'SAPHanaSystem',
                              'SQLInstance': 'SQLInstance',
+                             'SAPHanaDBInstance': 'SAPHanaDBInstance',
                              'SQLAG': 'SQLAvailabilityGroupContainer',
                              'SAPASE': 'SAPAseDatabase',
                              'SAPAseDatabase': 'SAPAseDatabase'}
@@ -441,12 +446,12 @@ def enable_protection_for_azure_wl(cmd, client, resource_group_name, vault_name,
     # Get protectable item.
     protectable_item_object = protectable_item
     protectable_item_type = protectable_item_object.properties.protectable_item_type
-    if protectable_item_type.lower() not in ["sqldatabase", "sqlinstance", "saphanadatabase", "saphanasystem",
-                                             "sapasedatabase"]:
+    if protectable_item_type.lower() not in ["sqldatabase", "sqlinstance", "saphanadatabase",
+                                             "saphanasystem", "saphanadbinstance", "sapasedatabase"]:
         raise CLIError(
             """
-            Protectable Item must be either of type SQLDataBase, HANADatabase, HANAInstance, SAPAseDatabase or
-            SQLInstance.
+            Protectable Item must be of type SQLDataBase, HANADatabase, HANAInstance,
+            SAPAseDatabase, SAPHanaDBInstance, or SQLInstance.
             """)
 
     item_name = protectable_item_object.name
@@ -659,6 +664,9 @@ def restore_azure_wl(cmd, client, resource_group_name, vault_name, recovery_conf
     alternate_directory_paths = recovery_config_object['alternate_directory_paths']
     recovery_mode = recovery_config_object['recovery_mode']
     filepath = recovery_config_object['filepath']
+    attach_and_mount = recovery_config_object['attach_and_mount']
+    identity_arm_id = recovery_config_object['identity_arm_id']
+    snapshot_instance_resource_group = recovery_config_object['snapshot_instance_resource_group']
 
     item = common.show_item(cmd, backup_protected_items_cf(cmd.cli_ctx), resource_group_name, vault_name,
                             container_uri, item_uri, "AzureWorkload")
@@ -734,6 +742,42 @@ def restore_azure_wl(cmd, client, resource_group_name, vault_name, recovery_conf
         setattr(trigger_restore_properties, 'should_use_alternate_target_location', True)
         setattr(trigger_restore_properties, 'is_non_recoverable', False)
 
+    if recovery_mode == 'SnapshotAttachAndRecover' or recovery_mode == 'SnapshotAttach':
+        trigger_restore_properties.recovery_mode = recovery_mode
+        if snapshot_instance_resource_group is None:
+            target_resource_group_name = container_id.split('/')[4]
+        else:
+            target_resource_group_name = snapshot_instance_resource_group
+
+        # For SnapshotAttach (--attach-and-mount was not provided), skip_attach_and_mount should be False
+        skip_attach_and_mount = False
+        if recovery_mode == 'SnapshotAttachAndMount':
+            skip_attach_and_mount = not attach_and_mount
+
+        snapshot_restore_parameters = SnapshotRestoreParameters(skip_attach_and_mount=skip_attach_and_mount,
+                                                                log_point_in_time_for_db_recovery='')
+
+        # Fetching UAMI details
+        rg_name = identity_arm_id.split('/')[-5]
+        id_name = identity_arm_id.split('/')[-1]
+        sub_name = identity_arm_id.split('/')[-7]
+        identity_client = get_mgmt_service_client(cmd.cli_ctx, ResourceType.MGMT_MSI,
+                                                  subscription_id=sub_name).user_assigned_identities
+        identity_details = identity_client.get(resource_group_name=rg_name, resource_name=id_name)
+        user_assigned_identity_properties = UserAssignedIdentityProperties(
+            client_id=identity_details.client_id,
+            principal_id=identity_details.principal_id
+        )
+        user_assigned_managed_identity_details = UserAssignedManagedIdentityDetails(
+            identity_arm_id=identity_arm_id,
+            user_assigned_identity_properties=user_assigned_identity_properties
+        )
+
+        setattr(trigger_restore_properties, 'snapshot_restore_parameters', snapshot_restore_parameters)
+        setattr(trigger_restore_properties, 'target_resource_group_name', target_resource_group_name)
+        setattr(trigger_restore_properties, 'user_assigned_managed_identity_details',
+                user_assigned_managed_identity_details)
+
     trigger_restore_request = RestoreRequestResource(properties=trigger_restore_properties)
 
     if use_secondary_region:
@@ -774,18 +818,19 @@ 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, from_full_rp_name,
-                         filepath, target_container, target_resource_group, target_vault_name, target_subscription):
+                         filepath, target_container, target_resource_group, target_vault_name, target_subscription,
+                         workload_type, attach_and_mount, identity_arm_id, snapshot_instance_resource_group):
     if log_point_in_time is not None:
         datetime_type(log_point_in_time)
 
     if restore_mode == 'AlternateWorkloadRestore':
         _check_none_and_many(target_item, "Target Item")
 
         protectable_item_type = target_item.properties.protectable_item_type
-        if protectable_item_type.lower() not in ["sqlinstance", "saphanasystem"]:
+        if protectable_item_type.lower() not in ["sqlinstance", "saphanasystem", "saphanadbinstance"]:
             raise CLIError(
                 """
-                Target Item must be either of type HANAInstance or SQLInstance.
+                Target Item must be of type HANAInstance, SQLInstance, or SAPHanaDBInstance.
                 """)
 
     if restore_mode == 'RestoreAsFiles' and target_container is None:
@@ -862,6 +907,11 @@ def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_m
     if restore_mode == 'RestoreAsFiles':
         recovery_mode = 'FileRecovery'
         container_id = target_container.id
+    if workload_type == 'SAPHanaDBInstance':
+        if attach_and_mount is not None:
+            recovery_mode = 'SnapshotAttachAndRecover'
+        else:
+            recovery_mode = 'SnapshotAttach'
 
     return {
         'restore_mode': restore_mode_map[restore_mode],
@@ -876,7 +926,10 @@ def show_recovery_config(cmd, client, resource_group_name, vault_name, restore_m
         'container_id': container_id,
         'recovery_mode': recovery_mode,
         'filepath': filepath,
-        'alternate_directory_paths': alternate_directory_paths}
+        'alternate_directory_paths': alternate_directory_paths,
+        'attach_and_mount': attach_and_mount,
+        'identity_arm_id': identity_arm_id,
+        'snapshot_instance_resource_group': snapshot_instance_resource_group}
 
 
 def _fetch_nodes_list_and_auto_protection_policy(cmd, paged_items, resource_group_name, vault_name,