[PS] announcement for MachineLearningServices module migration breaking change#28844
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.
Pull Request Overview
This PR updates the Az.MachineLearningServices module with documentation corrections, version dependency updates, and breaking change annotations for Az v16.0.0 (to be released May 2026). The changes prepare users for upcoming breaking changes while fixing existing documentation issues.
- Corrects spelling and grammar errors across documentation files
- Updates Az.Accounts dependency from version 4.0.1 to 5.3.0
- Adds breaking change preview messages to cmdlets affected by v16.0.0 changes
- Restructures the solution file with updated project GUIDs and platform configurations
Reviewed Changes
Copilot reviewed 49 out of 49 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| Az.MachineLearningServices.psd1 | Updates Az.Accounts version requirement, generation date, and formatting |
| MachineLearningServices.sln | Restructures solution with new project GUID and platform configurations |
| README.md | Adds AutoRest directives for breaking change preview messages |
| generate-info.json | Updates generation ID |
| resources/README.md | Adds new resources directory documentation |
| Multiple help/*.md files | Fixes spelling errors (enpoints→endpoints, oupt→output, vaule→value, etc.) |
| Multiple examples/*.md files | Fixes same spelling errors as help files |
| Multiple docs/*.md files | Fixes same spelling errors and truncated text |
| Az.MachineLearningServices.md | Updates module GUID |
| Multiple custom/*.ps1 files | Adds breaking change parameter attributes and preview messages |
| New-AzMLWorkspaceComputeStartStopScheduleObject.ps1 | New file with breaking change preview message |
| New-AzMLWorkSpaceConnection.ps1 | Adds breaking change preview message |
| AssemblyInfo.cs | New assembly information file |
dolauli
left a comment
There was a problem hiding this comment.
Please update the changelog file.
src/MachineLearningServices/MachineLearningServices/help/Get-AzMLWorkspaceKey.md
Outdated
Show resolved
Hide resolved
wyunchi-ms
left a comment
There was a problem hiding this comment.
Please update the changelog.md
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | ||
| - where: | ||
| verb: New|Update | ||
| subject: BatchEndpoint|OnlineEndpoint|Compute | ||
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* EnableSystemAssignedIdentity will replace IdentityType applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | ||
| - where: | ||
| verb: Get | ||
| subject: Datastore|WorkspaceOutboundNetworkDependencyEndpoint | ||
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | ||
| - where: | ||
| verb: Invoke | ||
| subject: Diagnose | ||
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" |
There was a problem hiding this comment.
The preview announcement messages in the AutoRest README.md have inconsistent formatting with unnecessary escaping. The messages use "\r\n" for line breaks and have trailing spaces in some lines. These escape sequences may not render correctly when displayed to users. Consider using simpler formatting or ensuring consistent spacing across all preview messages.
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | |
| - where: | |
| verb: New|Update | |
| subject: BatchEndpoint|OnlineEndpoint|Compute | |
| set: | |
| preview-announcement: | |
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* EnableSystemAssignedIdentity will replace IdentityType applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | |
| - where: | |
| verb: Get | |
| subject: Datastore|WorkspaceOutboundNetworkDependencyEndpoint | |
| set: | |
| preview-announcement: | |
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | |
| - where: | |
| verb: Invoke | |
| subject: Diagnose | |
| set: | |
| preview-announcement: | |
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | |
| preview-message: | | |
| ***************************************************************************************** | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. * | |
| * At least one change applies to this cmdlet. * | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 * | |
| ***************************************************************************************** | |
| - where: | |
| verb: New|Update | |
| subject: BatchEndpoint|OnlineEndpoint|Compute | |
| set: | |
| preview-announcement: | |
| preview-message: | | |
| ***************************************************************************************** | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. * | |
| * EnableSystemAssignedIdentity will replace IdentityType applies to this cmdlet. * | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 * | |
| ***************************************************************************************** | |
| - where: | |
| verb: Get | |
| subject: Datastore|WorkspaceOutboundNetworkDependencyEndpoint | |
| set: | |
| preview-announcement: | |
| preview-message: | | |
| ***************************************************************************************** | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. * | |
| * At least one change applies to this cmdlet. * | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 * | |
| ***************************************************************************************** | |
| - where: | |
| verb: Invoke | |
| subject: Diagnose | |
| set: | |
| preview-announcement: | |
| preview-message: | | |
| ***************************************************************************************** | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. * | |
| * At least one change applies to this cmdlet. * | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 * | |
| ***************************************************************************************** |
| [Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in 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 | ||
| ***************************************************************************************************")] |
There was a problem hiding this comment.
The PreviewMessage attribute has inconsistent formatting across multiple custom cmdlet files. The message uses backticks with `n for newlines and has inconsistent spacing in the asterisk borders. Some lines have trailing spaces after asterisks, creating visual inconsistency. Consider standardizing the formatting to ensure consistent display across all cmdlets with breaking change announcements.
| [Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.PreviewMessage("**********************************************************************************************`n | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in 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 | |
| ***************************************************************************************************")] | |
| [Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.PreviewMessage("********************************************************************************`n | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in 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 | |
| ********************************************************************************")] |
| - 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 ChangeLog entry violates the repository's custom coding guideline for ChangeLog.md files. According to the guidelines, changelog entries should be written from the user's perspective and explain what changed and how it affects their usage. The current entry "Preannounced breaking changes. Please refer to https://go.microsoft.com/fwlink/?linkid=2333229" is too generic and doesn't provide specific information about what breaking changes users should expect. Consider expanding this to briefly describe the nature of the breaking changes or at least mention which cmdlets or parameters are affected.
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.