Updated docs and fixed comments

Author: rambabu-yalla

src/Sql/Sql/ChangeLog.md

@@ -18,13 +18,13 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
-* Updated `New-AzSqlInstance` to support retention
-    - Added `EnableSoftDeleteRetention` parameter to `New-AzSqlInstance` to enable the creation of instances with retention period enabled
-    - Added `SoftDeleteRetentionInDays` parameter to `New-AzSqlInstance` to enable the creation of instances with custom retention period
-* Updated `Set-AzSqlInstance` to support retention
-    - Added `EnableSoftDeleteRetention` parameter to `Set-AzSqlInstance` to enable/disable retention period on existing instances
-    - Added `SoftDeleteRetentionInDays` parameter to `Set-AzSqlInstance` to enable the update of retention period on existing instances
-* Added `Restore-AzSqlServer` cmdlet to restore a deleted Azure Sql servers within the retention period
+* Updated `New-AzSqlServer` to support soft-delete retention
+    - Added `EnableSoftDeleteRetention` 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)
+* Updated `Set-AzSqlServer` to support soft-delete retention
+    - Added `EnableSoftDeleteRetention` parameter to `Set-AzSqlServer` to enable or disable soft-delete retention on an existing server
+    - Added `SoftDeleteRetentionDays` parameter to `Set-AzSqlServer` to update the soft-delete retention period (in days) on an existing server
+* Added `Restore-AzSqlServer` cmdlet to restore a deleted Azure SQL server within the retention period
 
 ## Version 6.1.0
 * Fixed `New-AzSqlDatabaseExport` and `New-AzSqlDatabaseImport` to use SQL Authentication with ManagedIdentity without any mandatory password

src/Sql/Sql/Properties/Resources.Designer.cs

@@ -670,6 +670,9 @@
   <data name="MissingSQLAdministratorCredentials" xml:space="preserve">
     <value>SQL Administrator Credentials are only optional when Azure Active Directory Only Authentication is enabled via -EnableActiveDirectoryOnlyAuthentication.</value>
   </data>
+  <data name="MissingEnableSoftDeleteRetention" xml:space="preserve">
+    <value>EnableSoftDeleteRetention must be provided when SoftDeleteRetentionDays is set to a value greater than 0.</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>
   </data>
@@ -766,4 +769,7 @@
   <data name="ForwardMigrationWithGeoDRInfo" xml:space="preserve">
     <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>
+  </data>
 </root>

src/Sql/Sql/Properties/Resources.resx

@@ -159,26 +159,20 @@ public class NewAzureSqlServer : AzureSqlServerCmdletBase
         public Guid? FederatedClientId { get; set; }
 
         /// <summary>
-        /// Soft-delete retention days for the server
+        /// Boolean Value for enabling Soft Delete Retention for server
         /// </summary>
         [Parameter(Mandatory = false,
-            HelpMessage = "Specifies whether or not soft-delete retention is enabled for the server.")]
+            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 EnableSoftDeleteRetention { get; set; } = false;
 
         /// <summary>
         /// Soft-delete retention days for the server
         /// </summary>
         [Parameter(Mandatory = false,
-            HelpMessage = "Specifies the soft-delete retention days for the server.")]
+            HelpMessage = "Specifies the number of days to retain a deleted server for possible restoration. Valid values are 0-35. A value of 0 disables soft-delete retention. If EnableSoftDeleteRetention is set without an explicit value, the default retention is 7 days.")]
+        [ValidateRange(0, 35)]
         public int? SoftDeleteRetentionDays { get; set; }
 
-        /// <summary>
-        /// Soft-delete retention days for the server
-        /// </summary>
-        [Parameter(Mandatory = false,
-            HelpMessage = "Specifies the create mode for the server, valid values for this parameter are \"Normal\" and \"Restore\".")]
-        public string CreateMode { get; set; } = "Normal";
-
         /// <summary>
         /// Overriding to add warning message
         /// </summary>
@@ -194,6 +188,12 @@ public override void ExecuteCmdlet()
                 throw new PSArgumentException(Properties.Resources.MissingSQLAdministratorCredentials, "SqlAdministratorCredentials");
             }
 
+            // SoftDeleteRetentionDays depends on EnableSoftDeleteRetention; if days are provided but soft-delete is not enabled, fail early.
+            if (this.SoftDeleteRetentionDays.HasValue && this.SoftDeleteRetentionDays > 0 && !this.EnableSoftDeleteRetention)
+            {
+                throw new PSArgumentException(Properties.Resources.MissingEnableSoftDeleteRetention, "EnableSoftDeleteRetention");
+            }
+
             base.ExecuteCmdlet();
         }
 
@@ -260,7 +260,7 @@ public override void ExecuteCmdlet()
                     Login = this.ExternalAdminName,
                     Sid = this.ExternalAdminSID
                 },
-                RetentionDays = (this.EnableSoftDeleteRetention && !this.SoftDeleteRetentionDays.HasValue) ? 7 : this.SoftDeleteRetentionDays
+                SoftDeleteRetentionDays = (this.EnableSoftDeleteRetention && !this.SoftDeleteRetentionDays.HasValue) ? 7 : this.SoftDeleteRetentionDays
             });
             return newEntity;
         }

src/Sql/Sql/Server/Cmdlet/NewAzureSqlServer.cs

@@ -49,19 +49,6 @@ public class RestoreAzureSqlServer : AzureSqlServerCmdletBase
         [ValidateNotNullOrEmpty]
         public string Location { get; set; }
 
-        /// <summary>
-        /// Overriding to add warning message
-        /// </summary>
-        public override void ExecuteCmdlet()
-        {
-            if (this.ServerName == "")
-            {
-                throw new PSArgumentException("Missing ServerName");
-            }
-
-            base.ExecuteCmdlet();
-        }
-
         /// <summary>
         /// Check to see if the server already exists as a live server or if there's a deleted server to restore.
         /// </summary>
@@ -85,7 +72,7 @@ public override void ExecuteCmdlet()
             }
             catch (CloudException ex)
             {
-                if (ex.Response.StatusCode != System.Net.HttpStatusCode.NotFound)
+                if (ex.Response?.StatusCode != System.Net.HttpStatusCode.NotFound)
                 {
                     // Unexpected exception encountered
                     throw;
@@ -99,21 +86,21 @@ public override void ExecuteCmdlet()
                 var deletedServer = ModelAdapter.GetDeletedServer(this.ResourceGroupName, this.ServerName);
                 if (deletedServer == null)
                 {
-                    throw new PSArgumentException(
-                        string.Format("No deleted server named '{0}' found in resource group '{1}' that can be restored.",
-                        this.ServerName, this.ResourceGroupName),
-                        "ServerName");
+                   throw new PSArgumentException(
+                       string.Format(Properties.Resources.DeletedServerNotFound,
+                       this.ServerName, this.ResourceGroupName),
+                       "ServerName");
                 }
 
                 // Deleted server exists and can be restored
                 return null;
             }
             catch (CloudException ex)
             {
-                if (ex.Response.StatusCode == System.Net.HttpStatusCode.NotFound)
+                if (ex.Response?.StatusCode == System.Net.HttpStatusCode.NotFound)
                 {
                     throw new PSArgumentException(
-                        string.Format("No deleted server named '{0}' found in resource group '{1}' that can be restored.", 
+                        string.Format(Properties.Resources.DeletedServerNotFound, 
                         this.ServerName, this.ResourceGroupName),
                         "ServerName");
                 }

src/Sql/Sql/Server/Cmdlet/RestoreAzureSqlServer.cs

@@ -126,27 +126,40 @@ public class SetAzureSqlServer : AzureSqlServerCmdletBase
         public string IdentityType { get; set; }
 
         /// <summary>
-        /// Value for soft-delete retention days for the server.
+        /// Boolean for enabling Soft Delete Retention for server
         /// </summary>
         [Parameter(Mandatory = false,
-            HelpMessage = "Boolean value for whether or not to enable soft-delete for the server such that the server can be restored for a default of 7 days after dropping. If you want to specify a different retention period, use the RetentionDays parameter.")]
+            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.")]
         [PSArgumentCompleter("true", "false")]
         public bool EnableSoftDeleteRetention { get; set; } = false;
 
         /// <summary>
         /// Value for soft-delete retention days for the server.
         /// </summary>
         [Parameter(Mandatory = false,
-            HelpMessage = "Value for soft-delete retention days for the server such that the server can be restored for the specified number of days after dropping. Only valid values are from 0 to 35. If set to 0, soft-delete retention is disabled.")]
-        [PSArgumentCompleter("0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35")]
-        public int? RetentionDays { get; set; }
+            HelpMessage = "Specifies the number of days to retain a deleted server for possible restoration. Valid values are 0-35. A value of 0 disables soft-delete retention. If EnableSoftDeleteRetention is set without an explicit value, the default retention is 7 days.")]
+        [ValidateRange(0, 35)]
+        public int? SoftDeleteRetentionDays { get; set; }
 
         /// <summary>
         /// Defines whether it is ok to skip the requesting of rule removal confirmation
         /// </summary>
         [Parameter(HelpMessage = "Skip confirmation message for performing the action")]
         public SwitchParameter Force { get; set; }
 
+        /// <summary>
+        /// Overriding to add warning message
+        /// </summary>
+        public override void ExecuteCmdlet()
+        {
+            // SoftDeleteRetentionDays depends on EnableSoftDeleteRetention; if days are provided but soft-delete is not enabled, fail early.
+            if (this.SoftDeleteRetentionDays.HasValue && this.SoftDeleteRetentionDays > 0 && !this.EnableSoftDeleteRetention)
+            {
+                throw new PSArgumentException(Properties.Resources.MissingEnableSoftDeleteRetention, "EnableSoftDeleteRetention");
+            }
+
+            base.ExecuteCmdlet();
+        }
         /// <summary>
         /// Get the server to update
         /// </summary>
@@ -185,7 +198,24 @@ public class SetAzureSqlServer : AzureSqlServerCmdletBase
             updateData[0].PrimaryUserAssignedIdentityId = this.PrimaryUserAssignedIdentityId ?? model.FirstOrDefault().PrimaryUserAssignedIdentityId;
             updateData[0].KeyId = this.KeyId ?? updateData[0].KeyId;
             updateData[0].FederatedClientId = this.FederatedClientId ?? updateData[0].FederatedClientId;
-            updateData[0].RetentionDays = this.EnableSoftDeleteRetention ? (this.RetentionDays ?? 7) : (int?)null;
+            if (this.EnableSoftDeleteRetention)
+            {
+                // If enabling soft-delete retention, use the explicitly provided value or default to 7 days if none provided.
+                updateData[0].SoftDeleteRetentionDays = this.SoftDeleteRetentionDays ?? 7;
+            }
+            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.
+                if (this.SoftDeleteRetentionDays.HasValue && this.SoftDeleteRetentionDays.Value == 0)
+                {
+                    updateData[0].SoftDeleteRetentionDays = 0;
+                }
+                else
+                {
+                    updateData[0].SoftDeleteRetentionDays = null;
+                }
+            }
 
             return updateData;
         }

src/Sql/Sql/Server/Cmdlet/SetAzureSqlServer.cs

@@ -112,7 +112,7 @@ public class AzureSqlServerModel
         /// <summary>
         /// Gets or sets a value for the soft-delete retention days for the server
         /// </summary>
-        public int? RetentionDays { get; set; }
+        public int? SoftDeleteRetentionDays { get; set; }
 
         /// <summary>
         /// Sets a value for the create mode for the server

src/Sql/Sql/Server/Model/AzureSqlServerModel.cs

@@ -143,7 +143,7 @@ public AzureSqlServerModel UpsertServer(AzureSqlServerModel model)
                 PrimaryUserAssignedIdentityId = model.PrimaryUserAssignedIdentityId,
                 KeyId = model.KeyId,
                 FederatedClientId = model.FederatedClientId,
-                RetentionDays = model.RetentionDays,
+                RetentionDays = model.SoftDeleteRetentionDays,
                 CreateMode = model.CreateMode,
             });
 
@@ -195,7 +195,7 @@ private static AzureSqlServerModel CreateServerModelFromResponse(Management.Sql.
             server.PrimaryUserAssignedIdentityId = resp.PrimaryUserAssignedIdentityId;
             server.KeyId = resp.KeyId;
             server.FederatedClientId = resp.FederatedClientId;
-            server.RetentionDays = resp.RetentionDays;
+            server.SoftDeleteRetentionDays = resp.RetentionDays;
 
             return server;
         }