[PS] Migrate DataProtection module to autorest v4 by JunKai-v · Pull Request #29023 · Azure/azure-powershell

JunKai-v · 2026-01-05T07:48:12Z

Description

Preannouncement PR: #29117

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

azure-client-tools-bot-prd · 2026-01-05T07:48:15Z

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

JunKai-v · 2026-01-05T07:50:38Z

@microsoft-github-policy-service agree company="Microsoft"

wyunchi-ms · 2026-01-05T14:14:31Z

src/DataProtection/DataProtection.Autorest/examples/Test-AzDataProtectionBackupInstance.md

+```powershell
+{{ Add code here }}


Please resolve these placeholder examples

Copilot

Pull request overview

This pull request migrates the DataProtection module from AutoRest v3 to AutoRest v4. The migration includes regenerating help documentation files, updating module manifests, adding new cmdlets, updating tests, and modifying examples to align with the new API version.

Key Changes:

Added 3 new cmdlets: Update-AzDataProtectionBackupPolicy, Update-AzDataProtectionResourceGuardMapping, and Unlock-AzDataProtectionDppResourceGuardProxyDelete
Updated help documentation across ~80 files to reflect API changes (type namespace changes from Api20250201 to base types)
Updated module manifest with new required Az.Accounts version (5.3.1) and new exported functions
Modified parameter types from enum types to strings for better flexibility
Updated examples to use simplified syntax for user-assigned identities

Reviewed changes

Copilot reviewed 152 out of 152 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
ChangeLog.md	Added entry for breaking changes with link to migration guide
Az.DataProtection.psd1	Updated module version dependencies and exported functions
Help/*.md (80+ files)	Updated documentation with API v4 changes, parameter type updates, and namespace changes
Test files	Added placeholder tests for new cmdlets; updated existing test with namespace change
Example files	Updated examples with simplified UAMI syntax
Solution files	Updated project GUIDs for regenerated project
.gitignore	Removed unnecessary ignore entries

isra-fel · 2026-01-09T09:38:28Z

/azp run

azure-pipelines · 2026-01-09T09:38:46Z

Azure Pipelines successfully started running 3 pipeline(s).

JunKai-v · 2026-01-13T03:29:05Z

/azp run

azure-pipelines · 2026-01-13T03:29:20Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 151 out of 151 changed files in this pull request and generated 19 comments.

Copilot · 2026-01-13T09:26:21Z

src/DataProtection/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md


 The first, second commands fetch the instance and recovery point for the instance.
-The third and fourth command initializes the target container id and target storage account ARM id.
+The third and fourthcommand initializes the target container id and target storage account ARM id.


Spelling error: "fourthcommand" should be "fourth command"

Copilot · 2026-01-13T09:26:21Z

src/DataProtection/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md

 The last command triggers the restore for AzureDatabaseForPGFlexServer.

-### Example 10: Trigger vaulted backup containers ItemLevelRestore with PrefixMatch for Azureblob.
+### Example 10: Trigger vaulted backup conatiners ItemLevelRestore with PrefixMatch for Azureblob.


Spelling error: "conatiners" should be "containers"

Copilot · 2026-01-13T09:26:22Z

src/DataProtection/DataProtection/help/New-AzDataProtectionPolicyTriggerScheduleClientObject.md

 ```

-This command creates an hourly schedule for Azure Backup Rule.
+This command creates an hourly scheudle for Azure Backup Rule.


Spelling error: "scheudle" should be "schedule"

Copilot · 2026-01-13T09:26:22Z

src/DataProtection/DataProtection/help/New-AzDataProtectionBackupInstance.md

 The sixth command assigns the necessary permissions for configure backup.

-The seventh and eight command initializes custom tags and configure backup finally by creating a backup instance.
+The sevnth and eight command initializes custom tags and configure backup finally by creating a backup instance.


Spelling error: "sevnth" should be "seventh"

Copilot · 2026-01-13T09:26:22Z

src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTagClientObject.md

 This command adds a weekly tag to given backup policy

-### Example 2: Remove Weekly tag from Backup Policy
+### Example 2: Remove Weeky tag from Backup Policy


Spelling error: "Weeky" should be "Weekly"

Copilot · 2026-01-13T09:26:25Z

src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupVault.md

 ```

-First command gets a specific vault by given vault name, subsequent three commands fetch the specified properties of encryption settings.
+First command gets a specific vault by given vault name, subsequent three commands fetch the specity properites of encryption settings.


Spelling error: "specity" should be "specify"

Copilot · 2026-01-13T09:26:25Z

src/DataProtection/DataProtection/help/Update-AzDataProtectionResourceGuard.md


 The first command is used to fetch the resource guard to be updated.
-The second and third command is used to fetch the critical operations user want to update.
+The second and third command is used to fecth the critical operations user want to update.


Spelling error: "fecth" should be "fetch"

Copilot · 2026-01-13T09:26:26Z

src/DataProtection/DataProtection/help/Find-AzDataProtectionRestorableTimeRange.md

 Fetch the backup instance.
 Fetch valid time ranges for Backup Instance $instance[0].
-Display RestorableTimeRange, note that this can be multiple discrete ranges.
+Dispaly RestorableTimeRange, note that this can be multiple dicrete ranges.


Spelling error: "Dispaly" should be "Display"

Copilot · 2026-01-13T09:26:26Z

src/DataProtection/DataProtection/help/Find-AzDataProtectionRestorableTimeRange.md

 Fetch the backup instance.
 Fetch valid time ranges for Backup Instance $instance[0].
-Display RestorableTimeRange, note that this can be multiple discrete ranges.
+Dispaly RestorableTimeRange, note that this can be multiple dicrete ranges.


Spelling error: "dicrete" should be "discrete"

Copilot · 2026-01-13T09:26:26Z

src/DataProtection/DataProtection/help/Get-AzDataProtectionBackupVault.md

 ```

-First command gets a specific vault by given vault name, subsequent three commands fetch the specified properties of encryption settings.
+First command gets a specific vault by given vault name, subsequent three commands fetch the specity properites of encryption settings.


Spelling error: "properites" should be "properties"

github-actions · 2026-01-14T03:53:48Z

To the author of the pull request,
This PR was labeled "Contains Breaking Change" because breaking changes have been detected by the static analysis pipeline.

According to our policy, breaking changes can only take place during major release and they must be preannounced.
Please follow our guide on the detailed steps.
Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

Copilot

Pull request overview

Copilot reviewed 148 out of 148 changed files in this pull request and generated 9 comments.

Copilot · 2026-01-14T06:39:33Z

src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupVault.md


-This command is used to change CmkIdentityType from SystemAssigned to UserAssigned.
-CmkIdentityId is a required parameter.
+This command is used to change CmkIdentityType from SystemAssigned to UserAssgined.


Typo: "UserAssgined" should be "UserAssigned"

Copilot · 2026-01-14T06:39:34Z

src/DataProtection/DataProtection/help/Update-AzDataProtectionBackupVault.md

-This command is used to change CmkIdentityType from SystemAssigned to UserAssigned.
-CmkIdentityId is a required parameter.
+This command is used to change CmkIdentityType from SystemAssigned to UserAssgined.
+CmkIdenityId is a required parameter.


Typo: "CmkIdenityId" should be "CmkIdentityId"

Copilot · 2026-01-14T06:39:34Z

src/DataProtection/DataProtection/help/Update-AzDataProtectionResourceGuard.md


 The first command is used to fetch the resource guard to be updated.
-The second and third command is used to fetch the critical operations user want to update.
+The second and third command is used to fecth the critical operations user want to update.


Typo: "fecth" should be "fetch"

Copilot · 2026-01-14T06:39:34Z

src/DataProtection/DataProtection/help/Start-AzDataProtectionBackupInstanceRestore.md

 The last command triggers the restore for AzureDatabaseForPGFlexServer.

-### Example 10: Trigger vaulted backup containers ItemLevelRestore with PrefixMatch for Azureblob.
+### Example 10: Trigger vaulted backup conatiners ItemLevelRestore with PrefixMatch for Azureblob.


Typo: "conatiners" should be "containers"

Copilot · 2026-01-14T06:39:34Z

src/DataProtection/DataProtection/help/New-AzDataProtectionBackupPolicy.md

 The seventh command updates the policy object with custom schedule.
 The eighth, ninth, tenth commands update the Monthly retention rule with custom lifecycles.
-The eleventh, twelfth commands create a tag criteria for Monthly policy.
+The eleventh, twelth commands create a tag criteria for Monthly policy.


Typo: "twelth" should be "twelfth"

Copilot · 2026-01-14T06:39:35Z

src/DataProtection/DataProtection/ChangeLog.md

        - Additional information about change #1
 -->
 ## Upcoming Release
+* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249).


The ChangeLog entry should be written in the past tense to describe what was changed, not as a generic statement about user experience. Consider a more specific entry like: "Migrated module to AutoRest v4 for improved consistency. This introduces breaking changes documented at [link]."

Copilot · 2026-01-14T06:39:35Z

src/DataProtection/DataProtection/help/Edit-AzDataProtectionPolicyTagClientObject.md

 This command adds a weekly tag to given backup policy

-### Example 2: Remove Weekly tag from Backup Policy
+### Example 2: Remove Weeky tag from Backup Policy


Typo: "Weeky" should be "Weekly"

Copilot · 2026-01-14T06:39:35Z

src/DataProtection/DataProtection/help/New-AzDataProtectionBackupInstance.md

 The sixth command assigns the necessary permissions for configure backup.

-The seventh and eight command initializes custom tags and configure backup finally by creating a backup instance.
+The sevnth and eight command initializes custom tags and configure backup finally by creating a backup instance.


Typo: "sevnth" should be "seventh"

Copilot · 2026-01-14T06:39:36Z

src/DataProtection/DataProtection/help/New-AzDataProtectionBackupInstance.md

    Start-Sleep -Seconds 10
 }
-$backupinstanceCreate = New-AzDataProtectionBackupInstance -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -BackupInstance $backupInstanceClientObject
+$backupnstanceCreate = New-AzDataProtectionBackupInstance -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -BackupInstance $backupInstanceClientObject


Typo: "backupnstanceCreate" should be "backupInstanceCreate"

Copilot

Pull request overview

Copilot reviewed 154 out of 154 changed files in this pull request and generated no new comments.

isra-fel · 2026-01-16T12:38:45Z

/azp run

azure-pipelines · 2026-01-16T12:39:06Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 162 out of 172 changed files in this pull request and generated no new comments.

isra-fel · 2026-01-30T06:39:44Z

/azp run

azure-pipelines · 2026-01-30T06:39:50Z

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

JunKai-v · 2026-01-30T11:46:13Z

replace by #29122

JunKai-v added 2 commits January 5, 2026 12:07

dataprotection-migrate-v4

bf5777d

Merge branch 'Azure:main' into data-protection-v4

8e51dc4

microsoft-github-policy-service bot added the customer-reported label Jan 5, 2026

add-change-log

0b1c019

wyunchi-ms reviewed Jan 5, 2026

View reviewed changes

JunKai-v marked this pull request as draft January 6, 2026 02:09

update directive and custom folder for manage identity type

8952e6b

Copilot AI review requested due to automatic review settings January 9, 2026 09:23

Copilot started reviewing on behalf of JunKai-v January 9, 2026 09:25 View session

Copilot AI reviewed Jan 9, 2026

View reviewed changes

update breaking change issues csv

8c9f55e

Copilot AI review requested due to automatic review settings January 13, 2026 09:13

Copilot started reviewing on behalf of JunKai-v January 13, 2026 09:15 View session

Copilot AI reviewed Jan 13, 2026

View reviewed changes

JunKai-v added Contains Breaking Change This PR contains breaking change autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 labels Jan 14, 2026

JunKai-v force-pushed the data-protection-v4 branch from 3c0a1a8 to 8c9f55e Compare January 14, 2026 03:57

add model cmdlet attribute

3b7b403

Copilot AI review requested due to automatic review settings January 14, 2026 06:28

Copilot started reviewing on behalf of JunKai-v January 14, 2026 06:31 View session

Copilot AI reviewed Jan 14, 2026

View reviewed changes

JunKai-v added 2 commits January 14, 2026 16:08

fix test cases

f44d624

fix test cases with error no azure login detected

059a638

Copilot AI review requested due to automatic review settings January 15, 2026 04:26

Copilot started reviewing on behalf of JunKai-v January 15, 2026 04:28 View session

Copilot AI reviewed Jan 15, 2026

View reviewed changes

fix test cases with error no azure login detected

27c73d2

record test

7cba67e

Copilot AI review requested due to automatic review settings January 23, 2026 08:08

Copilot started reviewing on behalf of JunKai-v January 23, 2026 08:10 View session

Copilot AI reviewed Jan 23, 2026

View reviewed changes

JunKai-v mentioned this pull request Jan 30, 2026

[BC] DataProtection Breaking Change Announcement #29117

Closed

6 tasks

rebuild

55d9fbc

JunKai-v closed this Jan 30, 2026

JunKai-v deleted the data-protection-v4 branch February 3, 2026 04:36

Conversation

JunKai-v commented Jan 5, 2026 • 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 Jan 5, 2026

Uh oh!

JunKai-v commented Jan 5, 2026

Uh oh!

wyunchi-ms Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

isra-fel commented Jan 9, 2026

Uh oh!

azure-pipelines bot commented Jan 9, 2026

Uh oh!

JunKai-v commented Jan 13, 2026

Uh oh!

azure-pipelines bot commented Jan 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

JunKai-v commented Jan 5, 2026 •

edited

Loading