[BC]Migrate Module Breaking Changes Announcement#29131
[BC]Migrate Module Breaking Changes Announcement#29131JiaSeng-v wants to merge 1 commit intoAzure:mainfrom
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
|
To the author of the pull request, |
There was a problem hiding this comment.
Pull request overview
This pull request adds breaking change announcements to the Az.Migrate module for changes scheduled in Az v16.0.0 (May 2026). The changes add PreviewMessage attributes to multiple cmdlets to warn users about upcoming breaking changes.
Changes:
- Added breaking change announcement to ChangeLog.md
- Added PreviewMessage attributes to 8 cmdlets (New-AzMigrateServerReplication, New-AzMigrateProject, New-AzMigrateDiskMapping, Get-AzMigrateServerReplication, Get-AzMigrateLocalServerReplication, Get-AzMigrateLocalJob, Get-AzMigrateJob, Get-AzMigrateDiscoveredServer)
- Added preview-announcement directive in AutoRest README.md for New-ReplicationProtectionContainerMapping
- Updated module version to 2.11.0 and regenerated AutoRest files
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Migrate/Migrate/ChangeLog.md | Added breaking change announcement entry with reference URL |
| src/Migrate/Migrate/Az.Migrate.psd1 | Updated generated date, uncommented ScriptsToProcess and TypesToProcess, minor formatting changes |
| src/Migrate/Migrate.sln | Updated project GUID for AutoRest project reference |
| src/Migrate/Migrate.Autorest/test/README.md | Changed path separator from forward slash to backslash for Windows compatibility |
| src/Migrate/Migrate.Autorest/resources/README.md | Changed path separator from forward slash to backslash for Windows compatibility |
| src/Migrate/Migrate.Autorest/generate-info.json | Updated generation ID for new AutoRest generation |
| src/Migrate/Migrate.Autorest/docs/README.md | Changed path separators from forward slash to backslash for Windows compatibility |
| src/Migrate/Migrate.Autorest/docs/Az.Migrate.md | Updated Module GUID |
| src/Migrate/Migrate.Autorest/custom/README.md | Changed path separators from forward slash to backslash for Windows compatibility |
| src/Migrate/Migrate.Autorest/custom/New-AzMigrateServerReplication.ps1 | Added PreviewMessage attribute with breaking change announcement |
| src/Migrate/Migrate.Autorest/custom/New-AzMigrateProject.ps1 | Added PreviewMessage attribute with breaking change announcement |
| src/Migrate/Migrate.Autorest/custom/New-AzMigrateDiskMapping.ps1 | Added PreviewMessage attribute with breaking change announcement |
| src/Migrate/Migrate.Autorest/custom/Get-AzMigrateServerReplication.ps1 | Added PreviewMessage attribute with breaking change announcement |
| src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalServerReplication.ps1 | Added PreviewMessage attribute with breaking change announcement (duplicate attribute issue) |
| src/Migrate/Migrate.Autorest/custom/Get-AzMigrateLocalJob.ps1 | Added PreviewMessage attribute with breaking change announcement (duplicate attribute issue) |
| src/Migrate/Migrate.Autorest/custom/Get-AzMigrateJob.ps1 | Added PreviewMessage attribute with breaking change announcement |
| src/Migrate/Migrate.Autorest/custom/Get-AzMigrateDiscoveredServer.ps1 | Added PreviewMessage attribute with breaking change announcement |
| src/Migrate/Migrate.Autorest/custom/Az.Migrate.custom.psm1 | Changed path separators from forward slash to backslash for Windows compatibility |
| src/Migrate/Migrate.Autorest/README.md | Added preview-announcement directive for New-ReplicationProtectionContainerMapping cmdlet |
| src/Migrate/Migrate.Autorest/Properties/AssemblyInfo.cs | Updated assembly version from 2.10.1 to 2.11.0 |
|
|
||
| function New-AzMigrateProject { | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The grammar is incorrect. It should be "to be released in May 2026" not "to be released on May 2026". The preposition "in" is correct for months, while "on" is used for specific dates.
| * 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 v16.0.0, to be released in May 2026. *`n |
| #> | ||
| function Get-AzMigrateServerReplication { | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The grammar is incorrect. It should be "to be released in May 2026" not "to be released on May 2026". The preposition "in" is correct for months, while "on" is used for specific dates.
| * 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 v16.0.0, to be released in May 2026. *`n |
| #> | ||
| function Get-AzMigrateLocalJob { | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The grammar is incorrect. It should be "to be released in May 2026" not "to be released on May 2026". The preposition "in" is correct for months, while "on" is used for specific dates.
| * 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 v16.0.0, to be released in May 2026. *`n |
| #> | ||
| function Get-AzMigrateJob { | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The grammar is incorrect. It should be "to be released in May 2026" not "to be released on May 2026". The preposition "in" is correct for months, while "on" is used for specific dates.
| * 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 v16.0.0, to be released in May 2026. *`n |
|
|
||
| function Get-AzMigrateDiscoveredServer { | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The grammar is incorrect. It should be "to be released in May 2026" not "to be released on May 2026". The preposition "in" is correct for months, while "on" is used for specific dates.
| * 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 v16.0.0, to be released in May 2026. *`n |
| #> | ||
| function New-AzMigrateDiskMapping { | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The grammar is incorrect. It should be "to be released in May 2026" not "to be released on May 2026". The preposition "in" is correct for months, while "on" is used for specific dates.
| * 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 v16.0.0, to be released in May 2026. *`n |
| #> | ||
| function Get-AzMigrateLocalServerReplication { | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The grammar is incorrect. It should be "to be released in May 2026" not "to be released on May 2026". The preposition "in" is correct for months, while "on" is used for specific dates.
| * 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 v16.0.0, to be released in May 2026. *`n |
| ***************************************************************************************************")] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] |
There was a problem hiding this comment.
This function has two PreviewMessage attributes. The breaking change announcement attribute on lines 25-29 is duplicated with a different preview message attribute on line 30. This will likely cause conflicts. If both attributes are needed, verify that the runtime supports multiple PreviewMessage attributes, otherwise remove the duplicate or consolidate the messages.
| ***************************************************************************************************")] | |
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] | |
| ***************************************************************************************************`n | |
| `n | |
| This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] |
| ***************************************************************************************************")] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] |
There was a problem hiding this comment.
This function has two PreviewMessage attributes. The breaking change announcement attribute on lines 25-29 is duplicated with a different preview message attribute on line 30. This will likely cause conflicts. If both attributes are needed, verify that the runtime supports multiple PreviewMessage attributes, otherwise remove the duplicate or consolidate the messages.
| ***************************************************************************************************")] | |
| [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Runtime.PreviewMessageAttribute("This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] | |
| ***************************************************************************************************`n | |
| This cmdlet is based on a preview API version and may experience breaking changes in future releases.")] |
| - Additional information about change #1 | ||
| --> | ||
| ## Upcoming Release | ||
| * Preannounced breaking changes. Please refer to https://go.microsoft.com/fwlink/?linkid=2333229 |
There was a problem hiding this comment.
The URL in the ChangeLog.md (linkid=2333229) is different from the URL used in all the cmdlet files and the README.md directive (linkid=2333486). These URLs should be consistent. Please verify which URL is correct and update accordingly.
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.)
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.