-
Notifications
You must be signed in to change notification settings - Fork 4.1k
[BC] DataProtection Breaking Change Announcement #29117
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds breaking change announcement warnings to DataProtection module cmdlets in preparation for an AutoRest v4 migration (referenced in PR #29023). The changes include adding PreviewMessage attributes to cmdlets, updating help documentation, incrementing the module version to 2.8.0, and regenerating AutoRest configuration files.
Changes:
- Added breaking change warning messages to 18 DataProtection cmdlets via PreviewMessage attributes
- Updated module version from 2.7.0 to 2.8.0 and Az.Accounts dependency from 5.3.0 to 5.3.1
- Corrected spelling errors in help documentation markdown files
Reviewed changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated 39 comments.
Show a summary per file
| File | Description |
|---|---|
| src/DataProtection/DataProtection/help/*.md (11 files) | Spelling corrections in cmdlet help documentation |
| src/DataProtection/DataProtection/Az.DataProtection.psd1 | Updated module version to 2.8.0, Az.Accounts dependency to 5.3.1, and uncommented ScriptsToProcess/TypesToProcess |
| src/DataProtection/DataProtection.sln | Regenerated solution file with updated project GUID |
| src/DataProtection/DataProtection.Autorest/custom/Cmdlets/**/*.ps1 (18 files) | Added PreviewMessage attributes announcing breaking changes |
| src/DataProtection/DataProtection.Autorest/README.md | Added AutoRest directive to configure breaking change preview messages |
| src/DataProtection/DataProtection.Autorest/Properties/AssemblyInfo.cs | Updated assembly version to 2.8.0 |
| src/DataProtection/DataProtection.Autorest/generate-info.json | Updated generation ID |
| src/DataProtection/DataProtection.Autorest/docs/Az.DataProtection.md | Updated module GUID |
| src/DataProtection/DataProtection.Autorest/.gitignore | Removed ignore entries for custom/*.psm1 and custom/autogen-model-cmdlets |
| 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 |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling error: "Weeky" should be "Weekly".
| ### Example 2: Remove Weeky tag from Backup Policy | |
| ### Example 2: Remove Weekly tag from Backup Policy |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | ||
| * At least one change applies to this cmdlet. *`n | ||
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PreviewMessage attribute contains incorrect information. The message states the breaking change will occur in "Az v16.0.0, to be released on May 2026", but the README.md directive (line 489) indicates it should be "Az v15.0.0, to be released on November 19th 2025". There is a version number mismatch and date mismatch between the cmdlet attribute and the AutoRest configuration.
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * At least one change applies to this cmdlet. *`n | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n | |
| * This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *`n | |
| * At least one change applies to this cmdlet. *`n | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n |
| [CmdletBinding(PositionalBinding=$false)] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Description('Gets or lists jobs in a backup vault')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PreviewMessage attribute contains incorrect information. The message states the breaking change will occur in "Az v16.0.0, to be released on May 2026", but the README.md directive (line 489) indicates it should be "Az v15.0.0, to be released on November 19th 2025". There is a version number mismatch and date mismatch between the cmdlet attribute and the AutoRest configuration.
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *`n |
|
|
||
| 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. |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling error: "UserAssgined" should be "UserAssigned".
|
|
||
| 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. |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spacing error: "fourthcommand" should be "fourth command" (missing space).
| internal | ||
| exports | ||
| tools | ||
| custom/*.psm1 | ||
| custom/autogen-model-cmdlets | ||
| test/*-TestResults.xml | ||
| license.txt | ||
| /*.ps1 |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The removal of these two gitignore entries may have unintended consequences. The entries "custom/*.psm1" and "custom/autogen-model-cmdlets" were previously ignored but are now tracked. If these paths should remain untracked (e.g., because they contain generated or temporary files), this change should be reverted. Please verify whether these paths should be tracked in version control.
| 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. |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling error: "dicrete" should be "discrete".
| Dispaly RestorableTimeRange, note that this can be multiple dicrete ranges. | |
| Display RestorableTimeRange, note that this can be multiple discrete ranges. |
| [CmdletBinding(PositionalBinding=$false)] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Description('Gets default policy template for a selected datasource type.')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PreviewMessage attribute contains incorrect information. The message states the breaking change will occur in "Az v16.0.0, to be released on May 2026", but the README.md directive (line 489) indicates it should be "Az v15.0.0, to be released on November 19th 2025". There is a version number mismatch and date mismatch between the cmdlet attribute and the AutoRest configuration.
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *`n |
| [CmdletBinding(PositionalBinding=$false, SupportsShouldProcess)] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Description('Creates or updates a BackupVault resource belonging to a resource group.')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PreviewMessage attribute contains incorrect information. The message states the breaking change will occur in "Az v16.0.0, to be released on May 2026", but the README.md directive (line 489) indicates it should be "Az v15.0.0, to be released on November 19th 2025". There is a version number mismatch and date mismatch between the cmdlet attribute and the AutoRest configuration.
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *`n |
| ``` | ||
|
|
||
| The first command is used to fetch the backup instances which are in soft deleted for a give backup vault. | ||
| The first comamnd is used to fetch the backup instances which are in soft deleted for a give backup vault. |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling error: "comamnd" should be "command".
|
/azp run |
|
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. |
|
replaced by #29125 |
Description
Migration PR: #29023
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.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.