Skip to content

Conversation

@lijinpei2008
Copy link
Contributor

#28242

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

… following cmdlet adds a BreakingChange announcement
@azure-client-tools-bot-prd
Copy link

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

@lijinpei2008 lijinpei2008 marked this pull request as ready for review August 11, 2025 06:18
Copilot AI review requested due to automatic review settings August 11, 2025 06:18
@lijinpei2008 lijinpei2008 added the Contains Breaking Change This PR contains breaking change label Aug 11, 2025
@github-actions
Copy link

To the author of the pull request,
This PR was labeled "Breaking Change Release" because it contains breaking changes.

  • According to our policy, breaking changes can only take place during major release and they must be preannounced.
  • Please follow our guide on the detailed steps.
  • Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

Copy link
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 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]"))]
Copy link

Copilot AI Aug 11, 2025

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.

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

Copilot uses AI. Check for mistakes.
@lijinpei2008 lijinpei2008 added Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change and removed Contains Breaking Change This PR contains breaking change labels Aug 18, 2025
@NoriZC NoriZC merged commit 348232c into main Aug 21, 2025
12 checks passed
@NoriZC NoriZC deleted the jinpei/main/ApplicationInsights-Announcement branch August 21, 2025 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants