Added soft delete feature

Author: rambabu-yalla

src/azure-cli/azure/cli/command_modules/sql/_help.py

@@ -1601,6 +1601,10 @@
     text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword --tags key1=value1 key2=value2
   - name: Create a server with disabled public network access to server.
     text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword -e false
+  - name: Create a server with soft delete enabled and 7-day retention period.
+    text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword --enable-soft-delete --soft-delete-retention-days 7
+  - name: Create a server with minimal TLS version and soft delete protection.
+    text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword --minimal-tls-version 1.2 --enable-soft-delete --soft-delete-retention-days 3
   - name: Create a server without SQL Admin, with AD admin and AD Only enabled.
     text: az sql server create --enable-ad-only-auth --external-admin-principal-type User --external-admin-name myUserName --external-admin-sid c5e964e2-6bb2-1111-1111-3b16ec0e1234 -g myResourceGroup -n myServer
   - name: Create a server without SQL Admin, with AD admin, AD Only enabled, User ManagedIdenties and Identity Type is SystemAssigned,UserAssigned.
@@ -1615,6 +1619,13 @@
               --identity-type UserAssigned --pid /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi
 """
 
+helps['sql server restore'] = """
+type: command
+short-summary: Restore a deleted SQL server.
+examples:
+  - name: Restore a deleted server.
+    text: az sql server restore -g mygroup -n myserver -l westus2
+"""
 helps['sql server dns-alias'] = """
 type: group
 short-summary: Manage a server's DNS aliases.
@@ -1799,7 +1810,12 @@
 examples:
   - name: Update a server. (autogenerated)
     text: az sql server update --admin-password myadminpassword --name MyAzureSQLServer --resource-group MyResourceGroup
-    crafted: true
+  - name: Enable soft delete protection with 7-day retention.
+    text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --enable-soft-delete
+  - name: Modify soft delete retention period.
+    text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --enable-soft-delete --soft-delete-retention-days 5
+  - name: Disable soft delete protection.
+    text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --enable-soft-delete false
   - name: Update a server with User Managed Identies and Identity Type is SystemAssigned,UserAssigned.
     text: az sql server update -g myResourceGroup -n myServer -i \\
               --user-assigned-identity-id /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \\

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

@@ -73,7 +73,8 @@
     create_args_for_complex_type,
     validate_managed_instance_storage_size,
     validate_backup_storage_redundancy,
-    validate_subnet
+    validate_subnet,
+    validate_soft_delete_parameters
 )
 
 #####
@@ -1912,6 +1913,17 @@ def _configure_security_policy_storage_params(arg_ctx):
                    options_list=['--federated-client-id', '--fid'],
                    help='The federated client id used in cross tenant CMK scenario.')
 
+        c.argument('enable_soft_delete',
+                   options_list=['--enable-soft-delete'],
+                   arg_type=get_three_state_flag(),
+                   help='Set whether soft delete is enabled or not. When true,'
+                   'the soft delete is enabled for 7 days by default.')
+
+        c.argument('soft_delete_retention_days',
+                   options_list=['--soft-delete-retention-days'],
+                   help='The number of days to retain soft deleted resources.',
+                   validator=validate_soft_delete_parameters)
+
     with self.argument_context('sql server create') as c:
         c.argument('location',
                    arg_type=get_location_type_with_default_from_resource_group(self.cli_ctx))
@@ -1923,7 +1935,9 @@ def _configure_security_policy_storage_params(arg_ctx):
                 'administrator_login_password',
                 'location',
                 'minimal_tls_version',
-                'tags'
+                'tags',
+                'enable_soft_delete',
+                'soft_delete_retention_days'
             ])
 
         c.argument('administrator_login',
@@ -1963,6 +1977,12 @@ def _configure_security_policy_storage_params(arg_ctx):
                    options_list=['--expand-ad-admin'],
                    help='Expand the Active Directory Administrator for the server.')
 
+    with self.argument_context('sql server restore') as c:
+        c.argument('location',
+                   arg_type=get_location_type_with_default_from_resource_group(self.cli_ctx),
+                   required=True,
+                   help='Location where the deleted server was originally located.')
+
     with self.argument_context('sql server list') as c:
         c.argument('expand_ad_admin',
                    options_list=['--expand-ad-admin'],

src/azure-cli/azure/cli/command_modules/sql/_util.py

@@ -262,3 +262,7 @@ def get_sql_managed_database_ledger_digest_uploads_operations(cli_ctx, _):
 
 def get_sql_managed_database_move_operations(cli_ctx, _):
     return get_sql_management_client(cli_ctx).managed_database_move_operations
+
+
+def get_sql_deleted_servers_operations(cli_ctx, _):
+    return get_sql_management_client(cli_ctx).deleted_servers

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

@@ -4,6 +4,10 @@
 # --------------------------------------------------------------------------------------------
 
 from azure.cli.core.util import CLIError
+from azure.cli.core.azclierror import (
+    RequiredArgumentMissingError,
+    InvalidArgumentValueError
+)
 
 # Important note: if cmd validator exists, then individual param validators will not be
 # executed. See C:\git\azure-cli\env\lib\site-packages\knack\invocation.py `def _validation`
@@ -138,3 +142,48 @@ def validate_managed_instance_storage_size(namespace):
         pass
     else:
         raise CLIError('incorrect usage: --storage must be specified in increments of 32 GB')
+
+
+###############################################
+#                sql server                   #
+###############################################
+
+
+def validate_soft_delete_parameters(namespace):
+    enable_soft_delete = getattr(namespace, 'enable_soft_delete', None)
+    soft_delete_retention_days = getattr(namespace, 'soft_delete_retention_days', None)
+
+    # Check if soft_delete_retention_days is specified without enable_soft_delete
+    if soft_delete_retention_days is not None and enable_soft_delete is None:
+        raise RequiredArgumentMissingError(
+            'The --soft-delete-retention-days parameter requires --enable-soft-delete to be specified.',
+            'Please specify both --enable-soft-delete and --soft-delete-retention-days together.')
+
+    # Validate soft_delete_retention_days value when specified
+    if soft_delete_retention_days is not None:
+        try:
+            retention_days = int(soft_delete_retention_days)
+            namespace.soft_delete_retention_days = retention_days
+        except (ValueError, TypeError) as exc:
+            raise InvalidArgumentValueError(
+                'The value for --soft-delete-retention-days must be a valid integer.') from exc
+
+        # Validate range based on enable_soft_delete value
+        if enable_soft_delete is True:
+            # When enable_soft_delete is true, retention days must be 1-7
+            if not 1 <= retention_days <= 7:
+                raise InvalidArgumentValueError(
+                    'The --soft-delete-retention-days value must be between 1 and 7 (inclusive) '
+                    'when --enable-soft-delete is true.',
+                    'Please specify a value between 1 and 7 days.')
+        elif enable_soft_delete is False:
+            # When enable_soft_delete is false, retention days must be 0
+            if retention_days != 0:
+                raise InvalidArgumentValueError(
+                    'The --soft-delete-retention-days value must be 0 when --enable-soft-delete is false.',
+                    'Please set --soft-delete-retention-days to 0 or remove it when disabling soft delete.')
+        else:
+            # This shouldn't happen since we check above, but for safety
+            raise RequiredArgumentMissingError(
+                'The --soft-delete-retention-days parameter requires --enable-soft-delete to be specified.',
+                'Please specify both --enable-soft-delete and --soft-delete-retention-days together.')

src/azure-cli/azure/cli/command_modules/sql/commands.py

@@ -572,6 +572,9 @@ def load_command_table(self, _):
         g.custom_command('create', 'server_create',
                          table_transformer=server_table_format,
                          supports_no_wait=True)
+        g.custom_command('restore', 'server_restore',
+                         table_transformer=server_table_format,
+                         supports_no_wait=True)
         g.command('delete', 'begin_delete',
                   confirmation=True)
         g.custom_show_command('show', 'server_get',

src/azure-cli/azure/cli/command_modules/sql/custom.py

@@ -13,6 +13,11 @@
     CLIError,
     sdk_no_wait,
 )
+from azure.cli.core.azclierror import (
+    ResourceNotFoundError,
+    ValidationError,
+    AzCLIError
+)
 
 from azure.mgmt.sql.models import (
     AdministratorName,
@@ -58,6 +63,7 @@
     SensitivityLabelSource,
     ServerAzureADOnlyAuthentication,
     ServerConnectionPolicy,
+    ServerCreateMode,
     ServerExternalAdministrator,
     ServerInfo,
     ServerKey,
@@ -92,6 +98,7 @@
     get_sql_replication_links_operations,
     get_sql_elastic_pools_operations,
     get_sql_databases_operations,
+    get_sql_deleted_servers_operations,
 )
 
 
@@ -179,6 +186,58 @@ def _is_serverless_slo(sku_name):
     return "_S_" in sku_name
 
 
+def _check_server_exists(client, resource_group_name, server_name):
+    '''
+    Checks if a server already exists and raises ValidationError if it does.
+    Returns False if server doesn't exist (ResourceNotFound/NotFound),
+    raises the original exception for other errors.
+    '''
+    try:
+        existing_server = client.get(resource_group_name, server_name)
+        if existing_server:
+            raise ValidationError(
+                f'Server "{server_name}" already exists in resource group "{resource_group_name}". '
+                'Cannot restore to an existing server name.',
+                'Please specify a different server name for the restore operation.')
+    except ValidationError:
+        # Re-raise ValidationError as-is
+        raise
+    except Exception as ex:
+        # If server doesn't exist, that's what we want - continue with restore
+        if 'ResourceNotFound' not in str(ex) and 'NotFound' not in str(ex):
+            # Re-raise if it's not a "not found" error
+            raise
+    return False
+
+
+def _validate_deleted_server_exists(cmd, location, server_name):
+    """
+    Validates that a deleted server exists and can be restored.
+    """
+    try:
+        deleted_servers_client = get_sql_deleted_servers_operations(cmd.cli_ctx, None)
+        deleted_server = deleted_servers_client.get(location, server_name)
+
+        if deleted_server:
+            logger.info('Found deleted server: %s', deleted_server.name)
+            return True
+
+    except Exception as ex:
+        # If server doesn't exist in deleted servers, raise appropriate error
+        if 'ResourceNotFound' in str(ex) or 'NotFound' in str(ex):
+            raise ResourceNotFoundError(
+                f'No deleted server found with name "{server_name}" in location "{location}".',
+                'Please verify the server was deleted with soft delete enabled '
+                'and is within the retention period.') from ex
+        # Handle any other unexpected errors
+        raise AzCLIError(f'Failed to validate deleted server "{server_name}": {str(ex)}') from ex
+
+    # This shouldn't be reached if the API call succeeds but returns None
+    raise ResourceNotFoundError(
+        f'No deleted server found with name "{server_name}" in location "{location}".',
+        'Please verify the server was deleted with soft delete enabled and is within the retention period.')
+
+
 def _get_default_server_version(location_capabilities):
     '''
     Gets the default server version capability from the full location
@@ -4369,6 +4428,8 @@ def server_create(
         external_admin_principal_type=None,
         external_admin_sid=None,
         external_admin_name=None,
+        enable_soft_delete=None,
+        soft_delete_retention_days=None,
         **kwargs):
     '''
     Creates a server.
@@ -4414,13 +4475,58 @@ def server_create(
         azure_ad_only_authentication=ad_only,
         tenant_id=tenant_id)
 
+    kwargs['create_mode'] = ServerCreateMode.NORMAL
+
+    if enable_soft_delete is not None:
+        if soft_delete_retention_days is not None:
+            kwargs['retention_days'] = soft_delete_retention_days
+        else:
+            kwargs['retention_days'] = 7
+
     # Create
     return sdk_no_wait(no_wait, client.begin_create_or_update,
                        server_name=server_name,
                        resource_group_name=resource_group_name,
                        parameters=kwargs)
 
 
+def server_restore(
+        cmd,
+        client,
+        resource_group_name,
+        server_name,
+        location,
+        no_wait=False,
+        **kwargs):
+    '''
+    Restores a deleted server.
+    '''
+    # Validate that we have enough information to perform the restore
+    if not server_name or not resource_group_name or not location:
+        logger.info('Not all required parameters were provided. '
+                    'Please specify server name, resource group name, and location.')
+        return None
+
+    # Check if server already exists
+    _check_server_exists(client, resource_group_name, server_name)
+
+    # Validate deleted server exists
+    _validate_deleted_server_exists(cmd, location, server_name)
+
+    # Set required parameters for restore
+    kwargs['location'] = location
+    kwargs['create_mode'] = ServerCreateMode.RESTORE
+
+    logger.info('Attempting to restore server "%s" in location "%s"',
+                server_name, location)
+
+    # Create/restore the server
+    return sdk_no_wait(no_wait, client.begin_create_or_update,
+                       server_name=server_name,
+                       resource_group_name=resource_group_name,
+                       parameters=kwargs)
+
+
 def server_list(
         client,
         resource_group_name=None,
@@ -4469,7 +4575,9 @@ def server_update(
         key_id=None,
         federated_client_id=None,
         identity_type=None,
-        user_assigned_identity_id=None):
+        user_assigned_identity_id=None,
+        enable_soft_delete=None,
+        soft_delete_retention_days=None):
     '''
     Updates a server. Custom update function to apply parameters to instance.
     '''
@@ -4507,6 +4615,17 @@ def server_update(
     instance.key_id = (key_id or instance.key_id)
     instance.federated_client_id = (federated_client_id or instance.federated_client_id)
 
+    # Handle soft delete parameters
+    if enable_soft_delete is not None:
+        if soft_delete_retention_days is not None:
+            instance.retention_days = soft_delete_retention_days
+        elif enable_soft_delete:
+            # Set default to 7 days when enabling soft delete without specifying retention
+            instance.retention_days = 7
+        else:
+            # When disabling soft delete, clear retention days
+            instance.retention_days = 0
+
     return instance