-
Notifications
You must be signed in to change notification settings - Fork 4.1k
[Az.ApplicationInsights] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
… following cmdlet adds a BreakingChange announcement
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
… jinpei/main/ApplicationInsights-Announcement
|
To the author of the pull request, |
There was a problem hiding this 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 adds breaking change announcements for Azure Application Insights PowerShell cmdlets in preparation for a refactoring that will change certain output property types from arrays/single objects to lists.
Key changes include:
- Added breaking change announcements for 20+ cmdlets that will see output type changes
- Updated documentation examples with consistent formatting and placeholder values
- Modified module configuration and project files to support the new structure
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| ChangeLog.md | Documents the breaking change announcements for all affected cmdlets |
| Az.ApplicationInsights.psd1 | Updates module dependencies and configuration paths |
| ApplicationInsights.sln | Adds new project configurations and updates project references |
| custom/*.ps1 | Adds OutputBreakingChangeAttribute annotations to cmdlet functions |
| README.md | Defines breaking change directives for various cmdlet subjects |
| docs/.md and examples/.md | Updates documentation with corrected examples and consistent formatting |
| help/*.md | Removes extra blank lines and improves formatting consistency |
| #> | ||
| function New-AzApplicationInsightsApiKey { | ||
| [OutputType([Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentApiKey])] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentApiKey", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsComponentApiKey", DeprecatedOutputProperties = ("LinkedReadProperty and LinkedWriteProperty System.String[]"), NewOutputProperties = ("LinkedReadProperty and LinkedWriteProperty System.Collections.Generic.List`1[System.String]"))] |
Copilot
AI
Aug 11, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The DeprecatedOutputProperties and NewOutputProperties descriptions contain the text 'LinkedReadProperty and LinkedWriteProperty' which should be split into separate entries or properly formatted. The current format is inconsistent with other breaking change attributes in the codebase.
| [Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentApiKey", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsComponentApiKey", DeprecatedOutputProperties = ("LinkedReadProperty and LinkedWriteProperty System.String[]"), NewOutputProperties = ("LinkedReadProperty and LinkedWriteProperty System.Collections.Generic.List`1[System.String]"))] | |
| [Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Runtime.OutputBreakingChangeAttribute( | |
| "Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20150501.IApplicationInsightsComponentApiKey", | |
| "15.0.0", | |
| "9.0.0", | |
| "2025/11/03", | |
| ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.IApplicationInsightsComponentApiKey", | |
| DeprecatedOutputProperties = ("LinkedReadProperty System.String[]", "LinkedWriteProperty System.String[]"), | |
| NewOutputProperties = ("LinkedReadProperty System.Collections.Generic.List`1[System.String]", "LinkedWriteProperty System.Collections.Generic.List`1[System.String]") | |
| )] |
… jinpei/main/ApplicationInsights-Announcement
#28242
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.