Update immutable ltr ga #28735

brandong-ms · 2025-10-23T18:12:39Z

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

Merge main repo into fork

…d for Sql

…k the new cmdlets to add PassThru parameter which returns LTR backup model object.

…ding

…4-11-01-preview

…s errors

…-2024-11-01-preview

https://github.com/brandong-ms/azure-powershell into update-sql-powershell-for-rest-api-2024-11-01-preview

…hen available.

…mmutable-ltr-ga

azure-client-tools-bot-prd · 2025-10-23T18:12:42Z

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

isra-fel · 2025-10-23T18:38:23Z

/azp run

azure-pipelines · 2025-10-23T18:38:43Z

Azure Pipelines successfully started running 3 pipeline(s).

isra-fel · 2025-10-23T21:08:25Z

/azp run

azure-pipelines · 2025-10-23T21:08:43Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull Request Overview

This PR adds support for immutable Long-Term Retention (LTR) backups in Azure SQL, introducing time-based and legal hold immutability features. The implementation includes new cmdlets for managing immutability policies, updated existing cmdlets to expose immutability parameters, and comprehensive documentation.

Key Changes:

Added four new cmdlets for managing LTR backup immutability (Lock, Remove, Set Legal Hold, Remove Legal Hold)
Extended existing models to include immutability properties (TimeBasedImmutability, TimeBasedImmutabilityMode, LegalHoldImmutability)
Updated Set-AzSqlDatabaseBackupLongTermRetentionPolicy to support immutability parameters

Reviewed Changes

Copilot reviewed 25 out of 64 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/Sql/Sql/help/*.md	Added/updated help documentation for immutability cmdlets and properties
src/Sql/Sql/Properties/Resources.resx	Added user-facing warning and description strings for immutability operations
src/Sql/Sql/Database Backup/Services/*.cs	Implemented communicator and adapter methods for immutability API calls
src/Sql/Sql/Database Backup/Model/*.cs	Extended models with immutability properties
src/Sql/Sql/Database Backup/Cmdlet/*.cs	Implemented new cmdlets and updated existing policy cmdlet
src/Sql/Sql/Common/DatabaseBackupConstants.cs	Added constants for immutability values
src/Sql/Sql/ChangeLog.md	Documented changes for upcoming release
src/Sql/Sql/Az.Sql.psd1	Exported new cmdlets
src/Sql/Sql.Test/SessionRecords/*.json	Added test recordings
src/Sql/Sql.Test/ScenarioTests/DatabaseBackupTests.cs	Added test methods for immutability features
src/Sql/Sql.Management.Sdk/README.md	Updated API spec references to 2024-11-01-preview

Files not reviewed (1)

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

Copilot · 2025-10-23T22:18:15Z

src/Sql/Sql/ChangeLog.md

+    - Updated `AzureSqlDatabaseBackupLongTermRetentionPolicyModel` to add `TimeBasedImmutability` and `TimeBasedImmutabilityMode` properties.
+    - Updated `AzureSqlDatabaseLongTermRetentionBackupModel` to add `TimeBasedImmutability`, `TimeBasedImmutabilityMode`, and `LegalHoldImmutability` properties.
+    - Added new cmdlets `Lock-AzSqlDatabaseLongTermRetentionBackupImmutability` and `Remove-AzSqlDatabaseLongTermRetentionBackupImmutability` for managing time-based immutability on LTR backups.
+    - Added new cmdlets `Set-Az SqlDatabaseLongTermRetentionBackupLegalHold` and `Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold` for managing legal hold immutability on LTR backups.


There is an extra space in the cmdlet name. It should be "Set-AzSqlDatabaseLongTermRetentionBackupLegalHold" not "Set-Az SqlDatabaseLongTermRetentionBackupLegalHold".

Suggested change

- Added new cmdlets `Set-Az SqlDatabaseLongTermRetentionBackupLegalHold` and `Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold` for managing legal hold immutability on LTR backups.

- Added new cmdlets `Set-AzSqlDatabaseLongTermRetentionBackupLegalHold` and `Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold` for managing legal hold immutability on LTR backups.

Copilot · 2025-10-23T22:18:16Z

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

+WeekOfYear                             : 26
+Location                               :
+TimeBasedImmutability                  : Enabled
+TimeBasedImmutabilityMode              : Unlocked


The example output shows TimeBasedImmutabilityMode as "Unlocked" when the command explicitly sets -TimeBasedImmutabilityMode Locked. This is inconsistent with the command being executed.

Suggested change

TimeBasedImmutabilityMode : Unlocked

TimeBasedImmutabilityMode : Locked

Copilot · 2025-10-23T22:18:16Z

src/Sql/Sql/help/Get-AzSqlDatabaseLongTermRetentionBackup.md


 ### -DatabaseName
-The name of the Azure SQL Database the backup is from.
+The name of the Azure SQL Server the backups are under.


The description for -DatabaseName parameter is incorrect. It states "The name of the Azure SQL Server the backups are under" but should describe the database name, not the server name. The ServerName parameter already describes the server.

Suggested change

The name of the Azure SQL Server the backups are under.

The name of the Azure SQL database the backups are under.

isra-fel

Generally LGTM. When you refresh the help documents make sure to add -RefreshModulePage to update the index doc Az.Sql.md as well.

isra-fel · 2025-10-27T02:38:31Z

src/Sql/Sql/ChangeLog.md

Please add the new entries below "#Upcoming Release“

github-actions · 2025-10-27T02:41:26Z

This PR was labeled "needs-revision" because it has unresolved review comments or CI failures.
Please resolve all open review comments and make sure all CI checks are green. Refer to our guide to troubleshoot common CI failures.

brandong-ms and others added 30 commits September 11, 2020 11:51

Merge pull request #1 from Azure/master

3854887

Merge main repo into fork

Merge https://github.com/Azure/azure-powershell

e19f24e

Merge branch 'master' of https://github.com/Azure/azure-powershell

eb37f98

Merge branch 'Azure:main' into master

b7ee16a

Pure autorest generation

206196c

Update LTR cmdlets for Immutable LTR GA feature set

4ac9650

Tweaks to parameter descriptions

42d883a

Updating module manifest to add new cmdlets, and updating changelog.m…

4d70898

…d for Sql

Add documentation new cmdlets, and updated for existing cmdlets. Twea…

26b8883

…k the new cmdlets to add PassThru parameter which returns LTR backup model object.

First round of test updates

7596962

Adding tests for lock and remove immutability

b65ce9d

Update TestRestorePointInTimeBackup to be recordable

384a377

Respond to Copilot PR feedback

0d09c61

Making TestShortTermRetentionPolicy recordable

b3bab5b

Remove wait from the TestRestorePointInTimeBackup test when not recor…

3427184

…ding

Pass in the isRecording switch basd on TestMockSupport.RunningMocked

6607e40

Merge branch 'Azure:main' into update-sql-powershell-for-rest-api-202…

f81c2cb

…4-11-01-preview

Update help files to confim to PlatyPS schema and fix example analysi…

727b3e7

…s errors

Merge branch 'Az.Sql-preview' into update-sql-powershell-for-rest-api…

959647e

…-2024-11-01-preview

Update changelog after merge

cb206ec

Update Remove-AzSqlDatabaseLongTermRetentionBackupImmutability.md

dd70f58

Update Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold.md

7654b67

Update Set-AzSqlDatabaseLongTermRetentionBackupLegalHold.md

513ba9d

Remove prompts from examples, and remove newlines from help files

c9a6656

Update Set-AzSqlDatabaseLongTermRetentionBackupLegalHold.md

ade1be0

Fix the test script to add additional parameter to avoid prompt

633464b

Merge branch 'update-sql-powershell-for-rest-api-2024-11-01-preview' of

32848d4

https://github.com/brandong-ms/azure-powershell into update-sql-powershell-for-rest-api-2024-11-01-preview

Merge branch 'Azure:main' into master

8c861d3

Merge branch 'Azure:main' into master

aea8d1b

Merge public preview feature branch

eac9fda

brandong-ms and others added 4 commits October 23, 2025 11:00

Update the new CmdLets to use ResourceGroupName version of the API, w…

327367a

…hen available.

Set Preview tag on the legal hold cmdlets

dc47dce

Merge branch 'Azure:main' into master

4bf043e

Merge commit '4bf043e94be824c22c9ef0f08e48d656732bf5cd' into update-i…

2d2fc84

…mmutable-ltr-ga

Rerecorded tests, and fix some bugs found during testing.

039391d

brandong-ms marked this pull request as ready for review October 23, 2025 22:17

Copilot AI review requested due to automatic review settings October 23, 2025 22:17

Copilot AI reviewed Oct 23, 2025

View reviewed changes

isra-fel requested changes Oct 27, 2025

View reviewed changes

src/Sql/Sql/ChangeLog.md

Copy link

Member

isra-fel Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the new entries below "#Upcoming Release“

isra-fel assigned brandong-ms Oct 27, 2025

isra-fel added the needs-revision label Oct 27, 2025

isra-fel added this to the Az 14.6.0 (11/04/2025) milestone Oct 27, 2025

	- Added new cmdlets `Set-Az SqlDatabaseLongTermRetentionBackupLegalHold` and `Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold` for managing legal hold immutability on LTR backups.
	- Added new cmdlets `Set-AzSqlDatabaseLongTermRetentionBackupLegalHold` and `Remove-AzSqlDatabaseLongTermRetentionBackupLegalHold` for managing legal hold immutability on LTR backups.

	TimeBasedImmutabilityMode : Unlocked
	TimeBasedImmutabilityMode : Locked

	The name of the Azure SQL Server the backups are under.
	The name of the Azure SQL database the backups are under.

Update immutable ltr ga #28735

Are you sure you want to change the base?

Update immutable ltr ga #28735

Uh oh!

Conversation

brandong-ms commented Oct 23, 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 Oct 23, 2025

Uh oh!

isra-fel commented Oct 23, 2025

Uh oh!

azure-pipelines bot commented Oct 23, 2025

Uh oh!

isra-fel commented Oct 23, 2025

Uh oh!

azure-pipelines bot commented Oct 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

isra-fel left a comment

Choose a reason for hiding this comment

Uh oh!

isra-fel Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

brandong-ms commented Oct 23, 2025 •

edited

Loading