[PS ManagedServices] Add breaking change announcement #27957
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 to notify users of type changes from Fixed Array to List across the module. Key changes include updates to the changelog, module metadata, cmdlet annotations, and documentation reflecting the breaking changes.
- Updates in ChangeLog.md with new breaking change messages.
- Adjustments to the Az.ManagedServices.psd1 file for module versioning and file path fixes.
- New breaking change annotations in cmdlets and updated documentation in README.md.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/ManagedServices/ManagedServices/ChangeLog.md | Added breaking change messages to announce type changes. |
| src/ManagedServices/ManagedServices/Az.ManagedServices.psd1 | Updated generated date, required module version, and file path style. |
| src/ManagedServices/ManagedServices.sln | Added new project configurations and modified project references. |
| src/ManagedServices/ManagedServices.Autorest/resources/README.md | Added documentation regarding resource files. |
| src/ManagedServices/ManagedServices.Autorest/generate-info.json | Updated generate_Id value. |
| src/ManagedServices/ManagedServices.Autorest/docs/Az.ManagedServices.md | Updated Module Guid. |
| src/ManagedServices/ManagedServices.Autorest/custom/New-AzManagedServicesEligibleAuthorizationObject.ps1 | Added a CmdletBreakingChange attribute for a breaking change. |
| src/ManagedServices/ManagedServices.Autorest/README.md | Updated breaking change directives and messages in the module documentation. |
| src/ManagedServices/ManagedServices.Autorest/Properties/AssemblyInfo.cs | Added assembly metadata. |
Comments suppressed due to low confidence (2)
src/ManagedServices/ManagedServices.Autorest/README.md:73
- For clarity and grammatical accuracy, consider changing 'have changed' to 'has changed' in the breaking change description.
change-description: "The type of property 'DelegatedRoleDefinitionId' have changed from Fixed Array to List. The types of property 'JustInTimeAccessPolicyManagedByTenantApprover' have changed to List."
src/ManagedServices/ManagedServices/ChangeLog.md:22
- [nitpick] The phrase 'fixing one object to List' is ambiguous. Consider clarifying the message to precisely indicate what type change is being announced.
* Added breaking change announcement for fixing one object to List.
...ervices/ManagedServices.Autorest/custom/New-AzManagedServicesEligibleAuthorizationObject.ps1
Outdated
Show resolved
Hide resolved
vidai-msft
requested changes
Jun 13, 2025
vidai-msft
reviewed
Jun 13, 2025
| subject: RegistrationAssignment | ||
| set: | ||
| breaking-change: | ||
| change-description: "The types of property 'Authorization' and 'EligibleAuthorization' have changed to 'List'." |
There was a problem hiding this comment.
Suggested change
| change-description: "The types of property 'Authorization' and 'EligibleAuthorization' have changed to 'List'." | |
| change-description: "The types of property 'Authorization' and 'EligibleAuthorization' will be changed to 'List'." |
| subject: RegistrationDefinition | ||
| set: | ||
| breaking-change: | ||
| change-description: "The types of the properties 'DelegatedRoleDefinitionId' and 'JustInTimeAccessPolicyManagedByTenantApprover' will be changed to List." |
There was a problem hiding this comment.
Suggested change
| change-description: "The types of the properties 'DelegatedRoleDefinitionId' and 'JustInTimeAccessPolicyManagedByTenantApprover' will be changed to List." | |
| change-description: "The types of the properties 'DelegatedRoleDefinitionId' and 'JustInTimeAccessPolicyManagedByTenantApprover' will be changed to 'List'." |
| @@ -26,6 +26,7 @@ | |||
| #> | |||
| function New-AzManagedServicesEligibleAuthorizationObject { | |||
| [OutputType('Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Models.Api20200201Preview.EligibleAuthorization')] | |||
| [Microsoft.Azure.PowerShell.Cmdlets.ManagedServices.Runtime.CmdletBreakingChange("15.0.0", "9.0.0", "2025/11/03", ChangeDescription="The type of property 'DelegatedRoleDefinitionId' will be changed from Fixed Array to List.")] | |||
There was a problem hiding this comment.
Should be updated to ""The type of the property 'DelegatedRoleDefinitionId' will be changed to 'List'."" to make them consistent. One question, is 'DelegatedRoleDefinitionId' a property or parameter?
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
Add breaking change announcement for #27929
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.