[PS] Migrate MonitorWorkspace in Monitor module to autorest v4 #28186
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
changed the title
JoyerJin
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR migrates the MonitorWorkspace module in the Monitor package from AutoRest v3 to AutoRest v4, which involves updating the code generation configuration and updating related documentation and breaking change exceptions.
- Updates AutoRest configuration to use v4 default instead of explicitly using v3 extension
- Adds new parameter sets for JSON file and string input to workspace cmdlets
- Updates documentation to reflect the new cmdlet capabilities and output types
Reviewed Changes
Copilot reviewed 18 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tools/StaticAnalysis/Exceptions/Az.Monitor/BreakingChangeIssues.csv | Documents breaking changes from v3 to v4 migration for property types and parameter sets |
| src/Monitor/MonitorWorkspace.Autorest/README.md | Updates AutoRest configuration to remove v3 extension and modify variant removal directive |
| src/Monitor/MonitorWorkspace.Autorest/docs/*.md | Updates cmdlet documentation with new parameter sets and simplified output types |
| src/Monitor/Monitor/help/*.md | Updates help documentation to match the autorest module changes |
| src/Monitor/MonitorWorkspace.Autorest/test/env.json | Updates test environment configuration with new resource identifiers |
| src/Monitor/Monitor.sln | Updates solution file with new project GUID for the regenerated module |
|
To the author of the pull request, |
|
|
| "Az.Monitor","New-AzMonitorWorkspace","New-AzMonitorWorkspace","0","3000","The type of property 'PrivateEndpointConnection' of type 'Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.Api20230403.IAzureMonitorWorkspaceResource' has changed from 'Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IPrivateEndpointConnection' to 'System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IPrivateEndpointConnection]'.","Change the type of property 'PrivateEndpointConnection' back to 'Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.IPrivateEndpointConnection'." | ||
| "Az.Monitor","New-AzMonitorWorkspace","New-AzMonitorWorkspace","0","3000","The type of property 'ProvisioningState' of type 'Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.Api20230403.IAzureMonitorWorkspaceResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Support.ProvisioningState]' to 'System.String'.","Change the type of property 'ProvisioningState' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Support.ProvisioningState]'." | ||
| "Az.Monitor","New-AzMonitorWorkspace","New-AzMonitorWorkspace","0","3000","The type of property 'PublicNetworkAccess' of type 'Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Models.Api20230403.IAzureMonitorWorkspaceResource' has changed from 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Support.PublicNetworkAccess]' to 'System.String'.","Change the type of property 'PublicNetworkAccess' back to 'System.Nullable`1[Microsoft.Azure.PowerShell.Cmdlets.Monitor.MonitorWorkspace.Support.PublicNetworkAccess]'." | ||
| "Az.Monitor","New-AzMonitorWorkspace","New-AzMonitorWorkspace","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzMonitorWorkspace' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzMonitorWorkspace'." |
There was a problem hiding this comment.
What does this error mean?
There was a problem hiding this comment.
The Location and Tag parameters were used in all parameter set before, now they are not in json parameter sets after migration.
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
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.