-
Notifications
You must be signed in to change notification settings - Fork 4.1k
[Az.ApplicationInsights] Update generation tool version: autorest.powershell v3->v4 #28242
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
base: main
Are you sure you want to change the base?
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
… jinpei/main/ApplicationInsights-v4
|
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 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 |
Copilot
AI
Aug 18, 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.
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.
| bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test | |
| basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test |
| Name Location WebTestKind ResourceGroupName | ||
| ---- -------- ----------- ----------------- | ||
| basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test | ||
| bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test |
Copilot
AI
Aug 18, 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.
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.
| bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test | |
| basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test |
| 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 |
Copilot
AI
Aug 18, 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.
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.
| bsaic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test True | |
| basic-portal-appinsights-portal01 westus2 ping azpwsh-rg-test True |
| ### 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 |
Copilot
AI
Aug 18, 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.
[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.
| Remove-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId dd173f38-4fd1-4c75-8af5-99c29aa0f867 | |
| Remove-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 00001111-aaaa-2222-bbbb-3333cccc4444 |
| ### 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 |
Copilot
AI
Aug 18, 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.
[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.
| Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 7c4c61dc-b392-4aa4-992f-ee92b84e5dee | |
| Get-AzApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId 00001111-aaaa-2222-bbbb-3333cccc4444 |
…shell v3->v4
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.