Introduced changes to cmdlets to support self-server restore of sql logical server #28589

rambabu-yalla · 2025-09-18T11:59:16Z

…ver restore

Description

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
  - A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
- Should not change ChangeLog.md if no new release is required, such as fixing test case only.
SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
SHOULD have proper test coverage for changes in pull request.
SHOULD NOT adjust version of module manually in pull request

…ver restore

azure-client-tools-bot-prd · 2025-09-18T11:59:19Z

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copilot

Pull Request Overview

This PR introduces support for self-service restore functionality for SQL logical servers by adding soft-delete retention capabilities and a new restore cmdlet. The changes allow users to configure retention periods for deleted servers and restore them within that timeframe.

Key changes:

Added soft-delete retention parameters to New-AzSqlServer and Set-AzSqlServer cmdlets
Introduced new Restore-AzSqlServer cmdlet for restoring deleted servers
Updated the underlying data model and service layer to support retention functionality

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
src/Sql/Sql/help/Set-AzSqlServer.md	Added documentation for new retention parameters
src/Sql/Sql/help/Restore-AzSqlServer.md	Added help documentation for new restore cmdlet
src/Sql/Sql/help/New-AzSqlServer.md	Added documentation for soft-delete retention parameters
src/Sql/Sql/Server/Services/AzureSqlServerCommunicator.cs	Added method to retrieve deleted servers
src/Sql/Sql/Server/Services/AzureSqlServerAdapter.cs	Added support for retention days and create mode in server operations
src/Sql/Sql/Server/Model/AzureSqlServerModel.cs	Extended model with retention and create mode properties
src/Sql/Sql/Server/Cmdlet/SetAzureSqlServer.cs	Added retention parameters and logic
src/Sql/Sql/Server/Cmdlet/RestoreAzureSqlServer.cs	New cmdlet implementation for server restoration
src/Sql/Sql/Server/Cmdlet/NewAzureSqlServer.cs	Added soft-delete retention parameters
src/Sql/Sql/ChangeLog.md	Updated changelog with feature description
src/Sql/Sql/Az.Sql.psd1	Added new Restore-AzSqlServer cmdlet to exports
src/Sql/Sql.Management.Sdk/README.md	Updated SDK configuration with new API specifications

src/Sql/Sql/help/Restore-AzSqlServer.md

src/Sql/Sql/help/Set-AzSqlServer.md

src/Sql/Sql/help/New-AzSqlServer.md

src/Sql/Sql/ChangeLog.md

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

src/Sql/Sql/ChangeLog.md

pjpatel12 · 2025-09-18T19:18:07Z

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

                    Sid = this.ExternalAdminSID
-                }              
+                },
+                RetentionDays = (this.EnableSoftDeleteRetention && !this.SoftDeleteRetentionDays.HasValue) ? 7 : this.SoftDeleteRetentionDays


Are we still covered for the scenario of SoftDeleteRetentionDays being null and EnableSoftDeleteRetention not being passed (i.e. using default value of false)?

src/Sql/Sql/Server/Services/AzureSqlServerCommunicator.cs

src/Sql/Sql/help/Restore-AzSqlServer.md

Copilot

Pull Request Overview

Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

src/Sql/Sql/Properties/Resources.Designer.cs: Language not supported

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

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

src/Sql/Sql/help/New-AzSqlServer.md

Copilot

Pull Request Overview

Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

src/Sql/Sql/Properties/Resources.Designer.cs: Language not supported

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

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

Copilot

Pull Request Overview

Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

src/Sql/Sql/Properties/Resources.Designer.cs: Language not supported

Copilot · 2025-09-21T19:46:26Z

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

+        [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.")]
+        [PSArgumentCompleter("true", "false")]
+        public bool EnableSoftDeleteRetention { get; set; } = false;


[nitpick] The default value assignment here is redundant since bool properties default to false. Consider removing the explicit assignment for cleaner code.

Suggested change

public bool EnableSoftDeleteRetention { get; set; } = false;

public bool EnableSoftDeleteRetention { get; set; }

Copilot · 2025-09-21T19:46:27Z

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

+        /// </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 EnableSoftDeleteRetention { get; set; } = false;


[nitpick] The default value assignment here is redundant since bool properties default to false. Consider removing the explicit assignment for cleaner code.

Suggested change

public bool EnableSoftDeleteRetention { get; set; } = false;

public bool EnableSoftDeleteRetention { get; set; }

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

Copilot

Pull Request Overview

Copilot reviewed 13 out of 14 changed files in this pull request and generated 5 comments.

Files not reviewed (1)

src/Sql/Sql/Properties/Resources.Designer.cs: Language not supported

Copilot · 2025-09-21T19:57:22Z

src/Sql/Sql/help/Set-AzSqlServer.md

 ```

+### -EnableSoftDeleteRetention
+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.


The parameter description references 'RetentionDays parameter' but the actual parameter name is 'SoftDeleteRetentionDays'. This should be corrected to match the actual parameter name for clarity.

Suggested change

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.

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 SoftDeleteRetentionDays parameter.

Copilot · 2025-09-21T19:57:22Z

src/Sql/Sql/help/Set-AzSqlServer.md

 ```

+### -SoftDeleteRetentionDays
+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.


The description states valid values are '0 to 35' but should be '0-35' to match the format used in other parameter descriptions and the ValidateRange attribute in the code.

Suggested change

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.

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 0-35. If set to 0, soft-delete retention is disabled.

Copilot · 2025-09-21T19:57:22Z

src/Sql/Sql/help/Restore-AzSqlServer.md

+Administrators                :
+PrimaryUserAssignedIdentityId :
+KeyId                         :
+FederatedClientId             : 


There's a trailing space after the colon that should be removed for consistency with other output examples.

Suggested change

FederatedClientId :

FederatedClientId :

Copilot · 2025-09-21T19:57:23Z

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

+                bool serverExists = ModelAdapter.ListServers().Any(s =>
+                    string.Equals(s.ResourceGroupName, this.ResourceGroupName, StringComparison.OrdinalIgnoreCase) &&
+                    string.Equals(s.ServerName, this.ServerName, StringComparison.OrdinalIgnoreCase));
+
+                if (serverExists)


The ListServers() call retrieves all servers in the subscription and then filters them in memory. This could be inefficient for subscriptions with many servers. Consider using a more targeted approach like GetServer() with exception handling instead.

Suggested change

bool serverExists = ModelAdapter.ListServers().Any(s =>

string.Equals(s.ResourceGroupName, this.ResourceGroupName, StringComparison.OrdinalIgnoreCase) &&

string.Equals(s.ServerName, this.ServerName, StringComparison.OrdinalIgnoreCase));

if (serverExists)

var server = ModelAdapter.GetServer(this.ResourceGroupName, this.ServerName);

if (server != null)

Copilot · 2025-09-21T19:57:23Z

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

+                if (this.SoftDeleteRetentionDays.HasValue && this.SoftDeleteRetentionDays.Value == 0)
+                {
+                    updateData[0].SoftDeleteRetentionDays = 0;
+                }
+                else
+                {
+                    updateData[0].SoftDeleteRetentionDays = null;
+                }


[nitpick] The logic for handling SoftDeleteRetentionDays when EnableSoftDeleteRetention is false could be simplified. The nested if-else structure could be replaced with a more direct assignment: updateData[0].SoftDeleteRetentionDays = this.SoftDeleteRetentionDays?.Value == 0 ? 0 : (int?)null;

Suggested change

if (this.SoftDeleteRetentionDays.HasValue && this.SoftDeleteRetentionDays.Value == 0)

{

updateData[0].SoftDeleteRetentionDays = 0;

}

else

{

updateData[0].SoftDeleteRetentionDays = null;

}

updateData[0].SoftDeleteRetentionDays = this.SoftDeleteRetentionDays?.Value == 0 ? 0 : (int?)null;

VeryEarly

Please check in upgraded SDK, under src/Sql/Sql/Management.Sdk
Please add proper test cases

pranavathalye · 2025-09-22T10:25:29Z

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

            }

+            // 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)


Nit: Should SoftDeleteRetentionDays <= 0 be accepted if EnableSoftDeletionRetention is not supplied or set as false? I ask this purely from a command line user experience behaviour. Should the dependent parameter in absence of its parent always be rejected?

pranavathalye · 2025-09-22T10:26:19Z

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

                    Sid = this.ExternalAdminSID
-                }              
+                },
+                SoftDeleteRetentionDays = (this.EnableSoftDeleteRetention && !this.SoftDeleteRetentionDays.HasValue) ? 7 : this.SoftDeleteRetentionDays


Is there a need to consider logging a message to the terminal that a default value is being taken?

pranavathalye · 2025-09-22T10:30:37Z

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

+            try
+            {
+                bool serverExists = ModelAdapter.ListServers().Any(s =>
+                    string.Equals(s.ResourceGroupName, this.ResourceGroupName, StringComparison.OrdinalIgnoreCase) &&


Consider using ListServersByResourceGroup() API?

Or even ModelAdapter.GetServer(ResourceGroupName, ServerName...)

pranavathalye · 2025-09-22T10:35:18Z

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

+            // Now check if there's a deleted server to restore
+            try
+            {
+                var deletedServer = ModelAdapter.GetDeletedServer(this.ResourceGroupName, this.ServerName);


Nit: deletedServer used only once hence can be avoided altogether.

pranavathalye · 2025-09-22T10:36:57Z

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

+            List<Model.AzureSqlServerModel> newEntity = new List<Model.AzureSqlServerModel>();
+            newEntity.Add(new Model.AzureSqlServerModel()
+            {
+                Location = this.Location,


Is validation for Location required at this stage of the flow?

pranavathalye · 2025-09-22T10:38:50Z

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

+                throw new PSArgumentException(string.Format(Properties.Resources.ServerNameInvalid, this.ServerName), "ServerName");
+            }
+
+            List<Model.AzureSqlServerModel> newEntity = new List<Model.AzureSqlServerModel>();


Nit: Can combine into something like

return new List<Model.AzureSqlServerModel> { new Model.AzureSqlServerModel { Location = this.Location, ResourceGroupName = this.ResourceGroupName, ServerName = this.ServerName, CreateMode = "Restore" } };

pranavathalye · 2025-09-22T10:44:05Z

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

+        /// <returns>The created server</returns>
+        protected override IEnumerable<Model.AzureSqlServerModel> PersistChanges(IEnumerable<Model.AzureSqlServerModel> entity)
+        {
+            return new List<Model.AzureSqlServerModel>() {


Nit: Assert that entity.Count == 1?

pranavathalye · 2025-09-22T11:06:44Z

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

+            {
+                // 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)


Is this a special case to allow user to reset SoftDeleteRetentionDays to 0, which effectively disables soft delete?

Is changing of retention days via this cmdlet not allowed?

If setting retention to 0 days is used as means to disallow soft deletion -
2a. How does user enable it back?
2b. Why not use a parameter DisableSoftDelete or DisableSoftDeleteRetention?

pranavathalye

Completed first review pass.

Introduced changes to new set and restore cmdlets to support self ser…

caf31a9

…ver restore

Copilot AI review requested due to automatic review settings September 18, 2025 11:59

microsoft-github-policy-service bot added the customer-reported label Sep 18, 2025

Copilot AI reviewed Sep 18, 2025

View reviewed changes

pjpatel12 reviewed Sep 18, 2025

View reviewed changes

VeryEarly self-assigned this Sep 19, 2025

VeryEarly requested changes Sep 19, 2025

View reviewed changes

src/Sql/Sql/help/Restore-AzSqlServer.md Outdated Show resolved Hide resolved

rambabu-yalla requested a review from Copilot September 20, 2025 13:23

Copilot AI reviewed Sep 20, 2025

View reviewed changes

src/Sql/Sql/Server/Cmdlet/SetAzureSqlServer.cs Outdated Show resolved Hide resolved

src/Sql/Sql/Server/Cmdlet/RestoreAzureSqlServer.cs Show resolved Hide resolved

src/Sql/Sql/help/New-AzSqlServer.md Outdated Show resolved Hide resolved

rambabu-yalla force-pushed the dev/ramyal/server-restore branch from 7c84cba to 8863670 Compare September 21, 2025 18:14

rambabu-yalla requested a review from Copilot September 21, 2025 18:25

Copilot AI reviewed Sep 21, 2025

View reviewed changes

src/Sql/Sql/Server/Cmdlet/NewAzureSqlServer.cs Outdated Show resolved Hide resolved

src/Sql/Sql/Server/Cmdlet/NewAzureSqlServer.cs Show resolved Hide resolved

src/Sql/Sql/Server/Cmdlet/SetAzureSqlServer.cs Show resolved Hide resolved

rambabu-yalla force-pushed the dev/ramyal/server-restore branch from 8863670 to afdcbf7 Compare September 21, 2025 19:44

rambabu-yalla requested a review from Copilot September 21, 2025 19:45

Copilot AI reviewed Sep 21, 2025

View reviewed changes

Updated docs and fixed comments

bdc66f7

rambabu-yalla force-pushed the dev/ramyal/server-restore branch from afdcbf7 to bdc66f7 Compare September 21, 2025 19:54

rambabu-yalla requested a review from Copilot September 21, 2025 19:56

Copilot AI reviewed Sep 21, 2025

View reviewed changes

VeryEarly requested changes Sep 22, 2025

View reviewed changes

pushing Generated files under sql.management.Sdk

caf1888

pranavathalye reviewed Sep 22, 2025

View reviewed changes

	public bool EnableSoftDeleteRetention { get; set; } = false;
	public bool EnableSoftDeleteRetention { get; set; }

	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.
	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 SoftDeleteRetentionDays parameter.

	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.
	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 0-35. If set to 0, soft-delete retention is disabled.

Introduced changes to cmdlets to support self-server restore of sql logical server #28589

Are you sure you want to change the base?

Introduced changes to cmdlets to support self-server restore of sql logical server #28589

Conversation

rambabu-yalla commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Sep 18, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

VeryEarly left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rambabu-yalla commented Sep 18, 2025 •

edited

Loading

pranavathalye Sep 22, 2025 •

edited

Loading

pranavathalye Sep 22, 2025 •

edited

Loading