Skip to content

Conversation

@lijinpei2008
Copy link
Contributor

…shell v3->v4

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

@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
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@lijinpei2008 lijinpei2008 added the Contains Breaking Change This PR contains breaking change label Aug 18, 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.

@Pan-Qi Pan-Qi marked this pull request as ready for review August 18, 2025 06:43
@Copilot Copilot AI review requested due to automatic review settings August 18, 2025 06:43
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 updates the Az.ApplicationInsights module's generation tool from autorest.powershell v3 to v4. The update includes the regeneration of cmdlets and documentation using the newer version of the autorest tool, leading to multiple API signature changes and parameter type updates across various Application Insights commands.

Key changes:

  • Parameter type changes from strongly-typed enums to string types across multiple cmdlets
  • Addition of new parameter sets with JSON input options for Update and Create operations
  • Updates to help documentation reflecting new parameter types and parameter sets

Reviewed Changes

Copilot reviewed 104 out of 104 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
tools/StaticAnalysis/Exceptions/Az.ApplicationInsights/BreakingChangeIssues.csv Documents expected breaking changes from the v3 to v4 migration
src/ApplicationInsights/ApplicationInsights/help/*.md Updates help documentation to reflect new parameter types and sets
src/ApplicationInsights/ApplicationInsights/Az.ApplicationInsights.psd1 Updates module metadata including dependency versions and format paths
src/ApplicationInsights/ApplicationInsights.sln Adds new solution configurations and project references
src/ApplicationInsights/ApplicationInsights.Autorest/test/ Updates test files with new parameter expectations
src/ApplicationInsights/ApplicationInsights.Autorest/examples/ Updates example documentation with corrected parameter usage
src/ApplicationInsights/ApplicationInsights.Autorest/docs/ Updates auto-generated documentation to match new cmdlet signatures

Name Location WebTestKind ResourceGroupName
---- -------- ----------- -----------------
basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test
bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a typo in the name 'bsaic-portal-appinsights-portal01'. It should be 'basic-portal-appinsights-portal01' to match the pattern in other examples.

Suggested change
bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test
basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test

Copilot uses AI. Check for mistakes.
Name Location WebTestKind ResourceGroupName
---- -------- ----------- -----------------
basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test
bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a typo in the name 'bsaic-portal-appinsights-portal01'. It should be 'basic-portal-appinsights-portal01' to match the pattern in other examples.

Suggested change
bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test
basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test

Copilot uses AI. Check for mistakes.
Name Location WebTestKind ResourceGroupName Enabled
---- -------- ----------- ----------------- -------
basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test True
bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test True
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a typo in the name 'bsaic-portal-appinsights-portal01'. It should be 'basic-portal-appinsights-portal01' to match the pattern in other examples.

Suggested change
bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test True
basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test True

Copilot uses AI. Check for mistakes.
### Example 1: Remove an application insights api key for an application insights resource
```powershell
Remove-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 00001111-aaaa-2222-bbbb-3333cccc4444
Remove-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId dd173f38-4fd1-4c75-8af5-99c29aa0f867
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The example shows a different UUID format than the original example which used '00001111-aaaa-2222-bbbb-3333cccc4444'. For consistency across documentation, consider using a standardized placeholder format for UUIDs in examples.

Suggested change
Remove-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId dd173f38-4fd1-4c75-8af5-99c29aa0f867
Remove-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 00001111-aaaa-2222-bbbb-3333cccc4444

Copilot uses AI. Check for mistakes.
### Example 2: Get specific API key for an application insights resource
```powershell
Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 00001111-aaaa-2222-bbbb-3333cccc4444
Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 7c4c61dc-b392-4aa4-992f-ee92b84e5dee
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The example shows a different UUID format than the original example which used '00001111-aaaa-2222-bbbb-3333cccc4444'. For consistency across documentation, consider using a standardized placeholder format for UUIDs in examples.

Suggested change
Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 7c4c61dc-b392-4aa4-992f-ee92b84e5dee
Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 00001111-aaaa-2222-bbbb-3333cccc4444

Copilot uses AI. Check for mistakes.
@isra-fel isra-fel added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label Oct 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 Contains Breaking Change This PR contains breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants