[PS] Migrate DataProtection module to autorest v4 after <Added support for DPP vault soft delete feature> by JunKai-v · Pull Request #29122 · Azure/azure-powershell

JunKai-v · 2026-01-30T11:45:58Z

Description

Preannouncement PR: #29125

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-30T11:46:04Z

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

Copilot

Pull request overview

This PR migrates the DataProtection module from AutoRest v3 to v4, implementing support for DPP vault soft delete features. The migration involves substantial changes across help documentation, code model namespaces, and parameter signatures.

Changes:

Migrated from AutoRest v3 to v4 by removing use-extension directive in README.md
Updated model namespaces from Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20250901 to Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models
Changed identity-related parameters in vault cmdlets (replaced -IdentityType and -IdentityUserAssignedIdentity with -EnableSystemAssignedIdentity and -UserAssignedIdentity)
Regenerated help documentation with updated type references and parameter descriptions
Updated cmdlet parameter names (e.g., -BackupInstanceName to -Name in Update-AzDataProtectionBackupInstance)
Removed deprecated -IdentityType parameter from ResourceGuard cmdlets
Added new parameter sets and identity objects for various operations

Reviewed changes

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

Show a summary per file

File	Description
src/DataProtection/DataProtection.Autorest/README.md	Removed AutoRest v3 extension directive, updated variant removal patterns, added new directives
src/DataProtection/DataProtection/help/*.md	Regenerated help documentation with updated type references and corrected spellings
src/DataProtection/DataProtection.Autorest/custom/*/.ps1	Updated model namespace references throughout custom cmdlets
src/DataProtection/DataProtection.Autorest/custom/Models/*.cs	Updated namespace from Api20250901 to root Models namespace
src/DataProtection/DataProtection/Az.DataProtection.psd1	Updated module manifest metadata
src/DataProtection/DataProtection.sln	Updated project GUID
src/DataProtection/DataProtection.Autorest/Properties/AssemblyInfo.cs	Version bump from 2.8.0 to 2.9.0

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

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

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

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

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

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

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

Copilot

Pull request overview

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

JunKai-v · 2026-02-03T02:06:00Z

/azp run

azure-pipelines · 2026-02-03T02:06:18Z

Azure Pipelines successfully started running 3 pipeline(s).

github-actions · 2026-02-03T02:54:25Z

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.

JunKai-v · 2026-02-03T02:58:36Z

/azp run

azure-pipelines · 2026-02-03T02:58:52Z

Azure Pipelines successfully started running 3 pipeline(s).

JunKai-v · 2026-02-04T00:07:42Z

/azp run

azure-pipelines · 2026-02-04T00:08:01Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Pull request overview

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

...ion.Autorest/custom/Cmdlets/Platform/Restore/Start-AzDataProtectionBackupInstanceRestore.ps1

...on/DataProtection.Autorest/custom/Cmdlets/Platform/Vault/New-AzDataProtectionBackupVault.ps1

...DataProtection.Autorest/custom/Cmdlets/Platform/Vault/Undo-AzDataProtectionVaultDeletion.ps1

...DataProtection.Autorest/custom/Cmdlets/Platform/Vault/Update-AzDataProtectionBackupVault.ps1

src/DataProtection/DataProtection.Autorest/docs/Update-AzDataProtectionBackupVault.md

src/DataProtection/DataProtection.Autorest/README.md

src/DataProtection/DataProtection/help/Suspend-AzDataProtectionBackupInstanceBackup.md

src/DataProtection/DataProtection/help/Undo-AzDataProtectionVaultDeletion.md

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

rerecorded failed tests

Copilot

Pull request overview

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

Copilot · 2026-03-27T05:30:33Z

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

 The fourth command initializes the prefix array for each container.
-PrefixMatch is a hashtable where each key is the conatiner name being restored and the value is a list of string prfixes for container names for Item level recovery.
+PrefixMatch is a hashtable where each key is the container name being restored and the value is a list of string prfixes for container names for Item level recovery.
 The fifth command initializes the target storage account Id.


There is a spelling error in the description: "prfixes" should be "prefixes" (user-facing help text).

Copilot · 2026-03-27T05:30:33Z

src/DataProtection/DataProtection/ChangeLog.md

 ## Upcoming Release
+* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249).
+
 * Preannounced breaking changes. Please refer to https://go.microsoft.com/fwlink/?linkid=2333229


The Upcoming Release entry is very generic ("Improved user experience and consistency") and doesn’t tell users what changed in Az.DataProtection. Since this PR migrates the module and introduces breaking changes, the changelog should summarize the concrete user-visible impacts (e.g., cmdlet/parameter changes) and avoid vague link text like "here".

Copilot · 2026-03-27T05:30:34Z

src/DataProtection/DataProtection.Autorest/test/utils.ps1

    $AksRestoreVariables = @{
-        SubscriptionId = "2c6832bf-90ef-457a-a663-9aeae88a7f80" 
-        ResourceGroupName = "tiering-test"
-        VaultName = "aks-tiering-test" #"demobackupvault"
-        NewPolicyName = "" #"pstest-aks-policy"
-        PolicyName = "test01"
-        DataSourceLocation = "eastasia"
-        SourceClusterId = "/subscriptions/2c6832bf-90ef-457a-a663-9aeae88a7f80/resourceGroups/tiering-test/providers/Microsoft.ContainerService/managedClusters/aks-test-priyansh"
-        SnapshotResourceGroupId = "/subscriptions/2c6832bf-90ef-457a-a663-9aeae88a7f80/resourceGroups/tiering-test"
-        FriendlyName = "aks-test-priyansh\newBI"
-        ClusterName = "aks-test-priyansh"
+        # just does backup and restore, any cluster would work with healthy state
+        SubscriptionId = "38304e13-357e-405e-9e9a-220351dcce8c" #"2c6832bf-90ef-457a-a663-9aeae88a7f80" 
+        ResourceGroupName = "payalsinghal" #"priyansh-rg"
+        VaultName = "payaUAMIECY" #"priyansh-vault"
+        NewPolicyName = "pstest-aks-policy"
+        PolicyName = "uami01" #"choudharypr-gc-policy-1"
+        DataSourceLocation = "eastus2euap" #"eastasia"
+        SourceClusterId = "/subscriptions/38304e13-357e-405e-9e9a-220351dcce8c/resourceGroups/payalsinghal/providers/microsoft.containerservice/managedClusters/payaUAMIECY" #"/subscriptions/2c6832bf-90ef-457a-a663-9aeae88a7f80/resourceGroups/priyansh-rg/providers/Microsoft.ContainerService/managedClusters/priyansh-scaletest"
+        SnapshotResourceGroupId = "/subscriptions/38304e13-357e-405e-9e9a-220351dcce8c/resourceGroups/payalsinghal" #"/subscriptions/2c6832bf-90ef-457a-a663-9aeae88a7f80/resourceGroups/priyansh-rg"
+        FriendlyName = "payaUAMIECY\uami01ECY" #"priyansh-scaletest\small-sizes"
+        ClusterName = "payaUAMIECY"


The updated AKS restore test variables are hard-coded to a specific subscription/resource group/vault/cluster (and the previous values are left commented out). This makes the test environment brittle and likely to fail in CI/other dev environments; please move these values to the normal test environment configuration (or keep placeholders) rather than embedding specific live resource IDs in the repo.

Copilot · 2026-03-27T05:30:34Z

...ion.Autorest/custom/Cmdlets/Platform/Restore/Start-AzDataProtectionBackupInstanceRestore.ps1


        [Parameter(ParameterSetName="TriggerExpanded", Mandatory, HelpMessage='Type of the source data store')]
-        [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SourceDataStoreType]
+        [System.String]


SourceDataStoreType is typed as System.String, but the generated module includes Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SourceDataStoreType with an ArgumentCompleter. Keeping the Support type here would preserve validation/tab-completion and match the underlying generated cmdlet contract.

Suggested change

[System.String]

[Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SourceDataStoreType]

Copilot · 2026-03-27T05:30:34Z

src/DataProtection/DataProtection/help/Az.DataProtection.md

 ### [Test-AzDataProtectionBackupInstanceUpdate](Test-AzDataProtectionBackupInstanceUpdate.md)
-Validate whether update for backup instance will be successful or not
+Validate whether validate for backup instance will be successful or not



The module index entry description repeats the same grammatical error as the cmdlet help ("Validate whether validate for backup instance..."). Since this is user-facing, please fix the wording to be clear and consistent with the cmdlet synopsis.

Copilot · 2026-03-27T05:30:35Z

src/DataProtection/DataProtection.Autorest/docs/Update-AzDataProtectionBackupInstance.md

 ### -UseSystemAssignedIdentity
 Use system assigned identity

 ```yaml
-Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
+Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=10.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
 Parameter Sets: (All)


The generated docs now include an assembly-qualified type with System.Private.CoreLib, Version=10.0.0.0 for -UseSystemAssignedIdentity. This is confusing/noisy for users and suggests help generation picked up a runtime-specific type name; please regenerate/help-normalize types to stable PowerShell-friendly forms (e.g., System.Nullable[System.Boolean] or System.Boolean).

Copilot · 2026-03-27T05:30:35Z

tools/StaticAnalysis/Exceptions/Az.DataProtection/ExampleIssues.csv

+"Az.DataProtection","Update-AzDataProtectionBackupVault","6","3","Unassigned_Parameter","5013","1","Update-AzDataProtectionBackupVault -EnableSystemAssignedIdentity must be assigned with a value.","-EnableSystemAssignedIdentity","Assign value for the parameter -EnableSystemAssignedIdentity."
+"Az.DataProtection","Update-AzDataProtectionBackupVault","6","3","Unassigned_Parameter","5013","1","Update-AzDataProtectionBackupVault -EnableSystemAssignedIdentity must be assigned with a value.","-EnableSystemAssignedIdentity","Assign value for the parameter -EnableSystemAssignedIdentity."


ExampleIssues.csv contains two identical exception entries for Update-AzDataProtectionBackupVault (rows 5 and 6). This duplication makes it harder to track/maintain suppressions and may cause confusion when updating/removing exceptions; please remove the duplicate row (or differentiate them if they are meant to cover distinct cases).

Copilot · 2026-03-27T05:30:35Z

...on/DataProtection.Autorest/custom/Cmdlets/Platform/Vault/New-AzDataProtectionBackupVault.ps1

@@ -63,29 +63,28 @@
        ${SoftDeleteRetentionDurationInDay},

        [Parameter(Mandatory=$false, HelpMessage='Soft delete state of the vault. Allowed values are Off, On, AlwaysOn')]
-        [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SoftDeleteState]
+        [System.String]
        [ValidateSet('Off','On', 'AlwaysOn')]  
        ${SoftDeleteState},

        [Parameter(HelpMessage='Resource tags.')]
        [System.Collections.Hashtable]
        ${Tag},

-        [Parameter(Mandatory=$false, HelpMessage='Gets or sets the user assigned identities.')]
-        [Alias('UserAssignedIdentity', 'AssignUserIdentity')]
-        [System.Collections.Hashtable]
-        ${IdentityUserAssignedIdentity},
+        [Parameter(HelpMessage='The array of user assigned identities associated with the resource. The elements in array will be ARM resource ids in the form: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}."')]
+        [System.String[]]
+        ${UserAssignedIdentity},

        [Parameter(Mandatory=$false, HelpMessage='Enable CMK encryption state for a Backup Vault.')]
-        [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.EncryptionState]
+        [System.String]
        ${CmkEncryptionState},

        [Parameter(Mandatory=$false, HelpMessage='Enable infrastructure encryption with CMK on this vault. Infrastructure encryption must be configured only when creating the vault.')]
-        [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.InfrastructureEncryptionState]
+        [System.String]
        ${CmkInfrastructureEncryption},

        [Parameter(Mandatory=$false, HelpMessage='The identity type to be used for CMK encryption - SystemAssigned or UserAssigned Identity.')]
-        [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.IdentityType]
+        [System.String]
        ${CmkIdentityType},


Several parameters were changed from DataProtection.Support types to plain strings (e.g., AzureMonitorAlertsForAllJobFailure, ImmutabilityState, CrossRegionRestoreState, SoftDeleteState, and CMK-related parameters). The Support types still exist in the generated code and provide built-in argument completers/type conversion; using plain strings here weakens validation and tab-completion, especially for CMK parameters which currently have no ValidateSet.

Copilot · 2026-03-27T05:30:35Z

...on/DataProtection.Autorest/custom/Cmdlets/Platform/Vault/New-AzDataProtectionBackupVault.ps1

@@ -165,13 +159,13 @@
            return
        }


The cmdlet previously defaulted identity to SystemAssigned when the identity parameter was not provided, but the current wrapper does not set any default for EnableSystemAssignedIdentity. This changes the default behavior of New-AzDataProtectionBackupVault (vaults may now be created without an identity), which is a breaking change; consider preserving the previous default (set EnableSystemAssignedIdentity when absent) or explicitly document this behavior change in help/changelog.

JunKai-v · 2026-04-07T04:27:23Z

/azp run

azure-pipelines · 2026-04-07T04:27:38Z

Azure Pipelines successfully started running 3 pipeline(s).

data protection v4 migration

bf61ec1

Copilot AI review requested due to automatic review settings January 30, 2026 11:45

JunKai-v mentioned this pull request Jan 30, 2026

[PS] Migrate DataProtection module to autorest v4 #29023

Closed

6 tasks

Copilot started reviewing on behalf of JunKai-v January 30, 2026 11:48 View session

Copilot AI reviewed Jan 30, 2026

View reviewed changes

JunKai-v added 2 commits February 3, 2026 08:36

breaking change issues

775cb95

update change log md

3661a14

Copilot AI review requested due to automatic review settings February 3, 2026 00:37

Copilot started reviewing on behalf of JunKai-v February 3, 2026 00:40 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

fix spelling error

ff6bd37

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

JunKai-v mentioned this pull request Feb 3, 2026

[BC] DataProtection Breaking Change Announcement after <Added support for DPP vault soft delete feature> #29125

Merged

6 tasks

update example issues csv

54324b7

Copilot AI review requested due to automatic review settings February 4, 2026 02:02

fix no az account login issues

4b0fba1

Copilot started reviewing on behalf of JunKai-v February 4, 2026 02:04 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

JunKai-v added 2 commits February 4, 2026 17:20

fix test cases param

367eb7a

update breaking change issues csv

189fa7e

Copilot AI review requested due to automatic review settings February 5, 2026 00:45

Copilot started reviewing on behalf of JunKai-v February 5, 2026 00:47 View session

This comment was marked as spam.

Sign in to view

hiaga reviewed Feb 13, 2026

View reviewed changes

hiaga and others added 3 commits March 19, 2026 11:01

rerecorded failed tests

10904e2

updated help

7413176

Merge pull request #1 from hiaga/dp-v4-new

69c4fb4

rerecorded failed tests

JunKai-v marked this pull request as ready for review March 26, 2026 04:07

JunKai-v requested review from VeryEarly and Copilot March 26, 2026 04:07

Copilot started reviewing on behalf of JunKai-v March 26, 2026 04:10 View session

This comment was marked as spam.

Sign in to view

JunKai-v added 2 commits March 27, 2026 13:00

Merge remote-tracking branch 'upstream/main' into dp-v4-new

7244e21

rebuild

9d8c289

Copilot AI review requested due to automatic review settings March 27, 2026 05:21

Copilot started reviewing on behalf of JunKai-v March 27, 2026 05:25 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

JunKai-v added 2 commits April 7, 2026 12:16

Merge remote-tracking branch 'upstream/main' into dp-v4-new

52b4c64

rebuild

0a65d8d

JunKai-v added this to the Az 16.0.0 (06/02/2026) milestone Apr 7, 2026

	[System.String]
	[Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Support.SourceDataStoreType]

		"Az.DataProtection","Update-AzDataProtectionBackupVault","6","3","Unassigned_Parameter","5013","1","Update-AzDataProtectionBackupVault -EnableSystemAssignedIdentity must be assigned with a value.","-EnableSystemAssignedIdentity","Assign value for the parameter -EnableSystemAssignedIdentity."
		"Az.DataProtection","Update-AzDataProtectionBackupVault","6","3","Unassigned_Parameter","5013","1","Update-AzDataProtectionBackupVault -EnableSystemAssignedIdentity must be assigned with a value.","-EnableSystemAssignedIdentity","Assign value for the parameter -EnableSystemAssignedIdentity."

Conversation

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

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!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

JunKai-v commented Feb 3, 2026

Uh oh!

azure-pipelines bot commented Feb 3, 2026

Uh oh!

github-actions bot commented Feb 3, 2026

Uh oh!

JunKai-v commented Feb 3, 2026

Uh oh!

azure-pipelines bot commented Feb 3, 2026

Uh oh!

JunKai-v commented Feb 4, 2026

Uh oh!

azure-pipelines bot commented Feb 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

This comment was marked as spam.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as spam.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

JunKai-v commented Jan 30, 2026 •

edited

Loading