[PS] Add breaking change announcement about migration StackHCI to autorest v4 #28392
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
JoyerJin
added
the
Breaking Change Preannounce
There was a problem hiding this comment.
Pull Request Overview
This PR adds breaking change announcements for the Azure Stack HCI PowerShell module's migration to AutoRest v4. The changes primarily focus on documenting upcoming breaking changes in cmdlet output properties and parameter types, with supporting updates to module metadata and configuration files.
Key changes include:
- Addition of comprehensive breaking change documentation for multiple cmdlets
- Updates to module configuration and solution files for AutoRest v4 migration
- Minor documentation corrections
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/StackHCI/StackHCI/ChangeLog.md | Added detailed breaking change announcements for cmdlet output property type changes and parameter modifications |
| src/StackHCI/StackHCI.Autorest/README.md | Added breaking change directives for multiple cmdlets documenting transitions from fixed arrays to lists |
| src/StackHCI/StackHCI.sln | Updated solution file with new project references and build configurations for AutoRest v4 migration |
| src/StackHCI/StackHCI/Az.StackHCI.psd1 | Updated module manifest with generation date and uncommented script/type processing entries |
| src/StackHCI/StackHCI.Autorest/custom/stackhci.ps1 | Added DoNotExport attributes and fixed typo in parameter documentation |
| src/StackHCI/StackHCI/help/Disable-AzStackHCIRemoteSupport.md | Minor capitalization correction in documentation |
| src/StackHCI/StackHCI.Autorest/docs/Az.StackHCI.md | Updated module GUID |
| src/StackHCI/StackHCI.Autorest/generate-info.json | Updated generation ID |
| src/StackHCI/StackHCI.Autorest/resources/README.md | Added new resources directory documentation |
| src/StackHCI/StackHCI.Autorest/Properties/AssemblyInfo.cs | Added new assembly information file |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/StackHCI/StackHCI/ChangeLog.md
Outdated
| * Cmdlet `Invoke-AzStackHciConsentAndInstallDefaultExtension` | ||
| * Cmdlet `Invoke-AzStackHciExtendClusterSoftwareAssuranceBenefit` | ||
| * The parameters of the 'New/Update-AzStackHciCluster' commands will be changed. | ||
| * 'IdentityType' will be removed. 'EnableSystemAssignedIdentity' will be used to enable/disable system-assigned identities. |
There was a problem hiding this comment.
Missing space before the bullet point. The line should start with ' * ' instead of ' * '.
Suggested change
| * 'IdentityType' will be removed. 'EnableSystemAssignedIdentity' will be used to enable/disable system-assigned identities. | |
| * 'IdentityType' will be removed. 'EnableSystemAssignedIdentity' will be used to enable/disable system-assigned identities. |
Copilot uses AI. Check for mistakes.
src/StackHCI/StackHCI/ChangeLog.md
Outdated
| * Cmdlet `Invoke-AzStackHciExtendClusterSoftwareAssuranceBenefit` | ||
| * The parameters of the 'New/Update-AzStackHciCluster' commands will be changed. | ||
| * 'IdentityType' will be removed. 'EnableSystemAssignedIdentity' will be used to enable/disable system-assigned identities. | ||
| * The type of 'UserAssignedIdentity' will be simplified to an array of strings that is used to specify the user's assigned identity. |
There was a problem hiding this comment.
Missing space before the bullet point. The line should start with ' * ' instead of ' * '.
Suggested change
| * The type of 'UserAssignedIdentity' will be simplified to an array of strings that is used to specify the user's assigned identity. | |
| * The type of 'UserAssignedIdentity' will be simplified to an array of strings that is used to specify the user's assigned identity. |
Copilot uses AI. Check for mistakes.
NoriZC
approved these changes
Aug 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.