Skip to content

[PS] announcement for MachineLearningServices module migration breaking change#28844

Merged
wyunchi-ms merged 4 commits intomainfrom
joyer/machinelearningservice-breakingchange
Jan 6, 2026
Merged

[PS] announcement for MachineLearningServices module migration breaking change#28844
wyunchi-ms merged 4 commits intomainfrom
joyer/machinelearningservice-breakingchange

Conversation

@JoyerJin
Copy link
Copy Markdown
Contributor

@JoyerJin JoyerJin commented Nov 10, 2025

Description

Mandatory Checklist

  • 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
Copy link
Copy Markdown

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

@JoyerJin JoyerJin marked this pull request as ready for review November 10, 2025 09:17
Copilot AI review requested due to automatic review settings November 10, 2025 09:17
Copy link
Copy Markdown
Contributor

Copilot AI left a 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 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

Copy link
Copy Markdown
Contributor

@dolauli dolauli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the changelog file.

Copy link
Copy Markdown
Contributor

@wyunchi-ms wyunchi-ms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the changelog.md

Copilot AI review requested due to automatic review settings January 5, 2026 05:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 50 out of 50 changed files in this pull request and generated 3 comments.

Comment on lines +639 to +657
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**************************************************************************************************"
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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 *
*****************************************************************************************

Copilot uses AI. Check for mistakes.
Comment on lines +31 to +35
[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
***************************************************************************************************")]
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
[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
********************************************************************************")]

Copilot uses AI. Check for mistakes.
- Additional information about change #1
-->
## Upcoming Release
* Preannounced breaking changes. Please refer to https://go.microsoft.com/fwlink/?linkid=2333229
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot generated this review using guidance from repository custom instructions.
@wyunchi-ms wyunchi-ms merged commit 793427c into main Jan 6, 2026
17 of 18 checks passed
@wyunchi-ms wyunchi-ms deleted the joyer/machinelearningservice-breakingchange branch January 6, 2026 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants