add breaking change pre-announcements for StackHCIVM SecureString par…#29332
Open
shraddhasun wants to merge 1 commit intoAzure:mainfrom
Open
add breaking change pre-announcements for StackHCIVM SecureString par…#29332shraddhasun wants to merge 1 commit intoAzure:mainfrom
shraddhasun wants to merge 1 commit intoAzure:mainfrom
Conversation
…ameter type changes
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds breaking-change pre-announcements for the StackHCIVM module ahead of planned parameter type changes (String → SecureString), so users get advance notice before the API surface changes.
Changes:
- Added an
## Upcoming Releasechangelog entry describing the upcoming SecureString parameter type changes. - Added
ParameterBreakingChangeAttributeannotations to the custom cmdlet parameters (ImagePath,AdminPassword). - Added AutoRest README directives to emit breaking-change announcements for the same parameter type changes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/StackHCIVM/StackHCIVM/ChangeLog.md | Adds an upcoming-release note to inform users about the planned breaking changes. |
| src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMVirtualMachine_New.ps1 | Adds a breaking change attribute for the AdminPassword parameter type change announcement. |
| src/StackHCIVM/StackHCIVM.Autorest/custom/New-AzStackHCIVMImage.ps1 | Adds a breaking change attribute for the ImagePath parameter type change announcement. |
| src/StackHCIVM/StackHCIVM.Autorest/README.md | Adds AutoRest directives to generate breaking change announcements for the parameter type changes. |
Contributor
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 3 pipeline(s). |
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
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.
…ameter type changes
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.