Improve validation for EnabledSoftDelete and SoftDeleteRetentionDay params (#28619)

Author: rambabu-yalla

src/Sql/Sql.Test/ScenarioTests/ServerCrudTests.ps1

@@ -693,7 +693,7 @@ function Test-CreateServerWithDefaultSoftDeleteRetentionEnabled
 	}
 	finally
 	{
-		Set-AzSqlServer -ResourceGroupName $rg.ResourceGroupName -ServerName $serverName -SoftDeleteRetentionDays 0
+		Set-AzSqlServer -ResourceGroupName $rg.ResourceGroupName -ServerName $serverName -EnableSoftDelete $False
 		Remove-ResourceGroupForTest $rg
 	}
 }
@@ -731,7 +731,7 @@ function Test-CreateServerWithCustomSoftDeleteRetentionEnabled
 	}
 	finally
 	{
-		Set-AzSqlServer -ResourceGroupName $rg.ResourceGroupName -ServerName $serverName -SoftDeleteRetentionDays 0
+		Set-AzSqlServer -ResourceGroupName $rg.ResourceGroupName -ServerName $serverName -EnableSoftDelete $False
 		Remove-ResourceGroupForTest $rg
 	}
 }
@@ -768,7 +768,7 @@ function Test-UpdateServerWithSoftDeleteRetentionEnabled
 	}
 	finally
 	{
-		Set-AzSqlServer -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -SoftDeleteRetentionDays 0
+		Set-AzSqlServer -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -EnableSoftDelete $False
 		Remove-ResourceGroupForTest $rg
 	}
 }
@@ -798,7 +798,7 @@ function Test-RestoreDeletedServer
 	}
 	finally
 	{
-		Set-AzSqlServer -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -SoftDeleteRetentionDays 0
+		Set-AzSqlServer -ResourceGroupName $rg.ResourceGroupName -ServerName $server.ServerName -EnableSoftDelete $False
 		Remove-ResourceGroupForTest $rg
 	}
 }

src/Sql/Sql.Test/SessionRecords/Microsoft.Azure.Commands.Sql.Test.ScenarioTests.ServerCrudTests/TestServerCreateWithCustomSoftRetentionEnabled.json

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Improved parameter validation for the EnableSoftDelete and SoftDeleteRetentionDays parameters.
 * Updated `New-AzSqlServer` to support soft-delete retention
     - Added `EnableSoftDelete` parameter to `New-AzSqlServer` to enable creation of a server with soft-delete retention
     - Added `SoftDeleteRetentionDays` parameter to `New-AzSqlServer` to set the soft-delete retention period (in days)

src/Sql/Sql.Test/SessionRecords/Microsoft.Azure.Commands.Sql.Test.ScenarioTests.ServerCrudTests/TestServerCreateWithDefaultSoftRetentionEnabled.json

@@ -671,7 +671,7 @@
     <value>SQL Administrator Credentials are only optional when Azure Active Directory Only Authentication is enabled via -EnableActiveDirectoryOnlyAuthentication.</value>
   </data>
   <data name="MissingEnableSoftDelete" xml:space="preserve">
-    <value>Invalid configuration: SoftDeleteRetentionDays can only be set to a value greater than 0 if EnableSoftDelete is set to true.</value>
+    <value>SoftDeleteRetentionDays parameter can only be specified if EnableSoftDelete is explicitly specified.</value>
   </data>
   <data name="RemoveAzureSqlServerOutboundFirewallRuleDescription" xml:space="preserve">
     <value>Permanently removing allowed FQDN '{0}' from the list of Outbound Firewall Rules (Allowed FQDNs) for Azure Sql Database Server '{1}'.</value>
@@ -770,9 +770,12 @@
     <value>Changing the service tier to Hyperscale also converts the geo-secondary replica to Hyperscale. For more information, see https://go.microsoft.com/fwlink/?linkid=2314103</value>
   </data>
   <data name="DeletedServerNotFound" xml:space="preserve">
-    <value>No deleted server named '{0}' found in resource group '{1}' that can be restored.</value>
+    <value>No deleted server named '{0}' found in location '{1}' that can be restored.</value>
   </data>
-  <data name="InvalidSoftDeleteRetentionDays" xml:space="preserve">
-    <value>Invalid configuration: SoftDeleteRetentionDays can only be set to 0 when EnableSoftDelete is false.</value>
+  <data name="InvalidSoftDeleteRetentionDaysForDisablingSoftDelete" xml:space="preserve">
+    <value>SoftDeleteRetentionDays can only be set to 0 when EnableSoftDelete is false.</value>
+  </data>
+  <data name="InvalidSoftDeleteRetentionDaysRange" xml:space="preserve">
+    <value>SoftDeleteRetentionDays must be between 1 and 35 when EnableSoftDelete is true.</value>
   </data>
 </root>

src/Sql/Sql.Test/SessionRecords/Microsoft.Azure.Commands.Sql.Test.ScenarioTests.ServerCrudTests/TestServerRestoreDeletedServer.json

@@ -163,7 +163,8 @@ public class NewAzureSqlServer : AzureSqlServerCmdletBase
         /// </summary>
         [Parameter(Mandatory = false,
             HelpMessage = "Specify whether to enable soft-delete retention for the server. When enabled, a dropped server can be restored within the retention window (defaults to 7 days if not specified). To set a custom retention period use -SoftDeleteRetentionDays.")]
-        public bool EnableSoftDelete { get; set; }
+        [PSArgumentCompleter("true", "false")]
+        public bool? EnableSoftDelete { get; set; }
 
         /// <summary>
         /// Soft-delete retention days for the server
@@ -188,18 +189,27 @@ public override void ExecuteCmdlet()
                 throw new PSArgumentException(Properties.Resources.MissingSQLAdministratorCredentials, "SqlAdministratorCredentials");
             }
 
-            // if the user specified a retention days value, then they must also enable soft delete
-            if (this.SoftDeleteRetentionDays.HasValue && this.SoftDeleteRetentionDays > 0 && !this.EnableSoftDelete)
+            if (SoftDeleteRetentionDays.HasValue)
             {
-                throw new PSArgumentException(Properties.Resources.MissingEnableSoftDelete, "EnableSoftDelete");
-            }
-
-            // if the user specified 0 retention days, then they must not enable soft delete
-            if (this.EnableSoftDelete && this.SoftDeleteRetentionDays.HasValue && this.SoftDeleteRetentionDays == 0)
-            {
-                throw new PSArgumentException(Properties.Resources.InvalidSoftDeleteRetentionDays, "SoftDeleteRetentionDays");
+                if (EnableSoftDelete == true)
+                {
+                    if (SoftDeleteRetentionDays.Value < 1 || SoftDeleteRetentionDays.Value > 35)
+                    {
+                        throw new PSArgumentException(Properties.Resources.InvalidSoftDeleteRetentionDaysRange, "SoftDeleteRetentionDays");
+                    }
+                }
+                else if (EnableSoftDelete == false)
+                {
+                    if (SoftDeleteRetentionDays.Value != 0)
+                    {
+                        throw new PSArgumentException(Properties.Resources.InvalidSoftDeleteRetentionDaysForDisablingSoftDelete, "SoftDeleteRetentionDays");
+                    }
+                }
+                else
+                {
+                    throw new PSArgumentException(Properties.Resources.MissingEnableSoftDelete, "EnableSoftDelete");
+                }
             }
-
             base.ExecuteCmdlet();
         }
 
@@ -244,16 +254,19 @@ public override void ExecuteCmdlet()
             }
 
             int? softDeleteRetentionDays;
-            if (this.EnableSoftDelete)
+            if (this.EnableSoftDelete == true)
             {
                 // If enabling soft-delete retention, use the explicitly provided value or default to 7 days if none provided.
                 softDeleteRetentionDays = this.SoftDeleteRetentionDays ?? 7;
             }
+            else if (this.EnableSoftDelete == false)
+            {
+                // If disabling, explicitly set retention to 0.
+                softDeleteRetentionDays = 0;
+            }
             else
             {
-                // If not enabling, only explicitly set retention to 0 when the caller provided 0.
-                // Otherwise, leave as null so the service preserves the existing retention setting.
-                softDeleteRetentionDays = (this.SoftDeleteRetentionDays.HasValue && this.SoftDeleteRetentionDays.Value == 0) ? 0 : (int?)null;
+                softDeleteRetentionDays = (int?)null;
             }
 
 

src/Sql/Sql.Test/SessionRecords/Microsoft.Azure.Commands.Sql.Test.ScenarioTests.ServerCrudTests/TestServerUpdateWithSoftRetentionEnabled.json

@@ -86,7 +86,7 @@ public class RestoreAzureSqlServer : AzureSqlServerCmdletBase
                 {
                    throw new PSArgumentException(
                        string.Format(Properties.Resources.DeletedServerNotFound,
-                       this.ServerName, this.ResourceGroupName),
+                       this.ServerName, this.Location),
                        "ServerName");
                 }
 
@@ -99,10 +99,10 @@ public class RestoreAzureSqlServer : AzureSqlServerCmdletBase
                 {
                     throw new PSArgumentException(
                         string.Format(Properties.Resources.DeletedServerNotFound, 
-                        this.ServerName, this.ResourceGroupName),
+                        this.ServerName, this.Location),
                         "ServerName");
                 }
-                
+
                 // Unexpected exception encountered
                 throw;
             }