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

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

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

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

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

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

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

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

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?

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

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

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.

rambabu-yalla · 2025-09-24T10:00:43Z

Please check in upgraded SDK, under src/Sql/Sql/Management.Sdk

Please add proper test cases

Checked in Generated files under src/Sql/Sql/Management.Sdk and also added test cases with recordings.

Copilot

Pull Request Overview

Copilot reviewed 16 out of 33 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/NewAzureSqlServer.cs

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

…elete

Copilot

Pull Request Overview

Copilot reviewed 16 out of 40 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

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

Copilot · 2025-09-25T00:26:37Z

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

+                if (ModelAdapter.GetDeletedServer(this.Location, this.ServerName) == null)
+                {
+                   throw new PSArgumentException(
+                       string.Format(Properties.Resources.DeletedServerNotFound,
+                       this.ServerName, this.ResourceGroupName),
+                       "ServerName");
+                }


The error message format uses this.ResourceGroupName but the GetDeletedServer method only uses this.Location and this.ServerName. This could be misleading since the deleted server lookup is by location and server name, not resource group.

VeryEarly · 2025-09-25T06:53:53Z

/azp run

azure-pipelines · 2025-09-25T06:54:10Z

Azure Pipelines successfully started running 3 pipeline(s).

VeryEarly · 2025-09-25T07:43:41Z

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

+
+### Example 1
+```powershell
+PS C:\> Restore-AzSqlServer -ResourceGroupName "resourcegroup01" -ServerName "server01" -Location "CentralUS"


Please delete "PS C:> "

VeryEarly · 2025-09-25T07:44:58Z

src/Sql/Sql.Management.Sdk/README.md

 ###
 ``` yaml
-commit: 37d29762e68000fc58e03dcefada999f3876f0af
+commit: 51eb4a8df996ebb94c835bf93e08a7001e5d5459


pipeline validation tool detected the SDK does not match the commit in this README.md, please either regenerate or make sure what generated in your local was uploaded

VeryEarly · 2025-09-25T07:46:09Z

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

+	.SYNOPSIS
+	Tests disabling soft delete
+#>
+function Test-ServerDisableSoftDelete


no record for this test case

Same functionality is tested in existing test cases. removed the test

VeryEarly · 2025-09-26T05:17:14Z

/azp run

azure-pipelines · 2025-09-26T05:17:31Z

Azure Pipelines successfully started running 3 pipeline(s).

VeryEarly · 2025-09-26T07:30:47Z

/azp run

azure-pipelines · 2025-09-26T07:31:07Z

Azure Pipelines successfully started running 3 pipeline(s).

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

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

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

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

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

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

pranavathalye reviewed Sep 22, 2025

View reviewed changes

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

pranavathalye reviewed Sep 22, 2025

View reviewed changes

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

pranavathalye reviewed Sep 22, 2025

View reviewed changes

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

pranavathalye reviewed Sep 22, 2025

View reviewed changes

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

pranavathalye reviewed Sep 22, 2025

View reviewed changes

rambabu-yalla added 2 commits September 24, 2025 15:13

Fixed review comments

423f32c

Added test cases and recordings

c819b27

rambabu-yalla requested a review from Copilot September 24, 2025 10:01

Copilot AI reviewed Sep 24, 2025

View reviewed changes

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

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

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

Added missing Generated commands and updated the param to EnableSoftD…

4a14bfd

…elete

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

Copilot AI reviewed Sep 25, 2025

View reviewed changes

VeryEarly reviewed Sep 25, 2025

View reviewed changes

rambabu-yalla force-pushed the dev/ramyal/server-restore branch from affb1e7 to b363bf6 Compare September 25, 2025 09:06

Added missed generated files

7c09029

rambabu-yalla force-pushed the dev/ramyal/server-restore branch from b363bf6 to 7c09029 Compare September 25, 2025 09:10

Update SignatureIssues.csv

481f6be

VeryEarly approved these changes Sep 26, 2025

View reviewed changes

dolauli approved these changes Sep 26, 2025

View reviewed changes

VeryEarly merged commit ef1e68c into Azure:main Sep 26, 2025
12 checks passed

github-actions bot mentioned this pull request Oct 1, 2025

Monthly issue metrics report #28630

Closed

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

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

Uh oh!

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!

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!

Uh oh!

Uh oh!

VeryEarly left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pranavathalye Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pranavathalye Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pranavathalye left a comment

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