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

@@ -170,6 +170,7 @@ public class NewAzureSqlServer : AzureSqlServerCmdletBase
         /// </summary>
         [Parameter(Mandatory = false,
             HelpMessage = "Specifies the soft-delete retention days for the server.")]
+        [ValidateRange(0, 35)]
         public int? SoftDeleteRetentionDays { get; set; }
 
         /// <summary>
@@ -194,6 +195,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 +267,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

@@ -54,11 +54,6 @@ public class RestoreAzureSqlServer : AzureSqlServerCmdletBase
         /// </summary>
         public override void ExecuteCmdlet()
         {
-            if (this.ServerName == "")
-            {
-                throw new PSArgumentException("Missing ServerName");
-            }
-
             base.ExecuteCmdlet();
         }
 
@@ -85,7 +80,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 +94,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

@@ -138,15 +138,29 @@ public class SetAzureSqlServer : AzureSqlServerCmdletBase
         /// </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.")]
+        [ValidateRange(0, 35)]
         [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; }
+        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 +199,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;
         }

src/Sql/Sql/Server/Services/AzureSqlServerAdapter.cs

@@ -22,7 +22,7 @@ New-AzSqlServer -ServerName <String> [-SqlAdministratorCredentials <PSCredential
  [-EnableActiveDirectoryOnlyAuthentication] [-ExternalAdminName <String>] [-ExternalAdminSID <Guid>]
  [-FederatedClientId <Guid>] [-EnableSoftDeleteRetention <Boolean>] [-SoftDeleteRetentionDays <Int32>]
  [-CreateMode <String>] [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>]
- [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -49,8 +49,6 @@ This command creates a version 12 Azure SQL Database server.
 
 ### Example 2: Create a new Azure SQL Database server with External (Microsoft Entra ID) Administrator, Microsoft Entra-only Authentication and no SqlAdministratorCredentials
 <!-- Skip: Output cannot be splitted from code -->
-
-
 ```powershell
 New-AzSqlServer -ResourceGroupName "ResourceGroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" -ExternalAdminName DummyLogin -EnableActiveDirectoryOnlyAuthentication
 ResourceGroupName        : resourcegroup01
@@ -103,6 +101,60 @@ PrimaryUserAssignedIdentityId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
 
 This command creates a version 12 Azure SQL Database server with TDE CMK enabled.
 
+### Example 4: Create a new Azure SQL Database server with soft delete retention enabled with default retention days
+```powershell
+New-AzSqlServer -ResourceGroupName "ResourceGroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" -SqlAdministratorCredentials (Get-Credential) -EnableSoftDeleteRetention $true
+```
+
+```output
+ResourceGroupName             : ResourceGroup01
+ServerName                    : server01
+Location                      : centralus
+SqlAdministratorLogin         : ramtest
+SqlAdministratorPassword      :
+ServerVersion                 : 12.0
+Tags                          :
+Identity                      :
+FullyQualifiedDomainName      : server01.database.windows.net
+MinimalTlsVersion             : 1.2
+PublicNetworkAccess           : Enabled
+RestrictOutboundNetworkAccess : Disabled
+Administrators                :
+PrimaryUserAssignedIdentityId :
+KeyId                         :
+FederatedClientId             :
+SoftDeleteRetentionDays       : 7
+```
+
+This command creates a version 12 Azure SQL Database server with soft-delete retention enabled (default 7 days).
+
+### Example 5: Create a new Azure SQL Database server with soft delete retention enabled with 30 retention days
+```powershell
+New-AzSqlServer -ResourceGroupName "ResourceGroup01" -Location "Central US" -ServerName "server01" -ServerVersion "12.0" -SqlAdministratorCredentials (Get-Credential) -EnableSoftDeleteRetention $true -SoftDeleteRetentionDays 30
+```
+
+```output
+ResourceGroupName             : ResourceGroup01
+ServerName                    : server01
+Location                      : centralus
+SqlAdministratorLogin         : ramtest
+SqlAdministratorPassword      :
+ServerVersion                 : 12.0
+Tags                          :
+Identity                      :
+FullyQualifiedDomainName      : server01.database.windows.net
+MinimalTlsVersion             : 1.2
+PublicNetworkAccess           : Enabled
+RestrictOutboundNetworkAccess : Disabled
+Administrators                :
+PrimaryUserAssignedIdentityId :
+KeyId                         :
+FederatedClientId             :
+SoftDeleteRetentionDays       : 30
+```
+
+This command creates a version 12 Azure SQL Database server with soft-delete retention set to 30 days.
+
 ## PARAMETERS
 
 ### -AsJob
@@ -316,21 +368,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ProgressAction
-{{ Fill ProgressAction Description }}
-
-```yaml
-Type: System.Management.Automation.ActionPreference
-Parameter Sets: (All)
-Aliases: proga
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -PublicNetworkAccess
 Takes a flag, enabled/disabled, to specify whether public network access to server is allowed or not.
 When disabled, only connections made through Private Links can reach this server.