Skip to content

[Monitor] Update MonitorWorkspace module to API version 2025-10-03#29531

Open
GokulPrasad-Work wants to merge 1 commit intoAzure:mainfrom
GokulPrasad-Work:feature/monitor-workspace-2025-10-03-update
Open

[Monitor] Update MonitorWorkspace module to API version 2025-10-03#29531
GokulPrasad-Work wants to merge 1 commit intoAzure:mainfrom
GokulPrasad-Work:feature/monitor-workspace-2025-10-03-update

Conversation

@GokulPrasad-Work
Copy link
Copy Markdown
Member

@GokulPrasad-Work GokulPrasad-Work commented May 7, 2026

Description

Update the Az.MonitorWorkspace module to use the 2025-10-03 API version from the TypeSpec-generated swagger.

Cmdlet design review: (pending)

Changes

  • Regenerated MonitorWorkspace.Autorest from the 2025-10-03 stable swagger
  • Added support for Issues child resource (CRUD, alerts, investigation results, background visualization)
  • Added support for MetricsContainers child resource (CRUD)
  • Added -MetricEnableAccessUsingResourcePermission parameter for enabling access using resource permissions
  • Updated Az.Monitor.psd1 to export new cmdlets
  • Added help documentation and real examples for all new cmdlets

New Cmdlets

  • New/Get/Remove/Update-AzMonitorWorkspaceIssue
  • Add/Get/Update-AzMonitorWorkspaceIssueAlert
  • Add/Get/Update-AzMonitorWorkspaceIssueResource
  • Add-AzMonitorWorkspaceIssueInvestigationResult
  • Invoke-AzMonitorWorkspaceFetchIssueBackgroundVisualization
  • Invoke-AzMonitorWorkspaceFetchIssueInvestigationResult
  • New/Get/Set/Update-AzMonitorWorkspaceMetricsContainer
  • Set-AzMonitorWorkspace
  • Set-AzMonitorWorkspaceIssueBackgroundVisualization

Testing

  • Verified locally: module builds, loads, and all 23 cmdlets are functional
  • Live-tested Create/Get/Update/Delete AMW with enableAccessUsingResourcePermissions toggle (true false)

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately Updated
  • SHOULD regenerate markdown help files if there is cmdlet API change. Regenerated
  • SHOULD have proper test coverage for changes in pull request. Test stubs generated
  • SHOULD NOT adjust version of module manually in pull request Not adjusted

Copilot AI review requested due to automatic review settings May 7, 2026 17:41
@azure-client-tools-bot-prd
Copy link
Copy Markdown

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

Copy link
Copy Markdown
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

Updates the Az.MonitorWorkspace AutoRest-generated surface to the 2025-10-03 API version and wires the regenerated MonitorWorkspace project into the Az.Monitor module, including new cmdlets/resources (Issues, MetricsContainers) plus regenerated UX metadata and help content.

Changes:

  • Regenerate MonitorWorkspace.Autorest against 2025-10-03 and add UX metadata for Issues/MetricsContainers.
  • Add new cmdlet help/docs/examples/tests for Issues/MetricsContainers operations.
  • Update Az.Monitor.psd1 exports and Monitor.sln project references to include the updated MonitorWorkspace project.

Reviewed changes

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

Show a summary per file
File Description
src/Monitor/MonitorWorkspace.Autorest/UX/Microsoft.Monitor/accounts.json Updates MonitorWorkspace UX metadata to API version 2025-10-03 and refreshes descriptions.
src/Monitor/MonitorWorkspace.Autorest/UX/Microsoft.Monitor/accounts-metricsContainers.json Adds UX metadata for MetricsContainers child resource.
src/Monitor/MonitorWorkspace.Autorest/UX/Microsoft.Monitor/accounts-issues.json Adds UX metadata for Issues child resource.
src/Monitor/MonitorWorkspace.Autorest/test/Update-AzMonitorWorkspaceMetricsContainer.Tests.ps1 Adds generated Pester scaffold for Update MetricsContainer cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Update-AzMonitorWorkspaceIssueResource.Tests.ps1 Adds generated Pester scaffold for Update IssueResource cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Update-AzMonitorWorkspaceIssueAlert.Tests.ps1 Adds generated Pester scaffold for Update IssueAlert cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Update-AzMonitorWorkspaceIssue.Tests.ps1 Adds generated Pester scaffold for Update Issue cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Set-AzMonitorWorkspaceMetricsContainer.Tests.ps1 Adds generated Pester scaffold for Set MetricsContainer cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Set-AzMonitorWorkspaceIssueBackgroundVisualization.Tests.ps1 Adds generated Pester scaffold for Set Issue background visualization cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Set-AzMonitorWorkspace.Tests.ps1 Adds generated Pester scaffold for Set MonitorWorkspace cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Remove-AzMonitorWorkspaceIssue.Tests.ps1 Adds generated Pester scaffold for Remove Issue cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/New-AzMonitorWorkspaceMetricsContainer.Tests.ps1 Adds generated Pester scaffold for New MetricsContainer cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/New-AzMonitorWorkspaceIssue.Tests.ps1 Adds generated Pester scaffold for New Issue cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Invoke-AzMonitorWorkspaceFetchIssueInvestigationResult.Tests.ps1 Adds generated Pester scaffold for fetching investigation results.
src/Monitor/MonitorWorkspace.Autorest/test/Invoke-AzMonitorWorkspaceFetchIssueBackgroundVisualization.Tests.ps1 Adds generated Pester scaffold for fetching background visualization.
src/Monitor/MonitorWorkspace.Autorest/test/Get-AzMonitorWorkspaceMetricsContainer.Tests.ps1 Adds generated Pester scaffold for Get/List MetricsContainer cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Get-AzMonitorWorkspaceIssueResource.Tests.ps1 Adds generated Pester scaffold for listing Issue resources.
src/Monitor/MonitorWorkspace.Autorest/test/Get-AzMonitorWorkspaceIssueAlert.Tests.ps1 Adds generated Pester scaffold for listing Issue alerts.
src/Monitor/MonitorWorkspace.Autorest/test/Get-AzMonitorWorkspaceIssue.Tests.ps1 Adds generated Pester scaffold for Get/List Issue cmdlet.
src/Monitor/MonitorWorkspace.Autorest/test/Add-AzMonitorWorkspaceIssueResource.Tests.ps1 Adds generated Pester scaffold for adding Issue resources.
src/Monitor/MonitorWorkspace.Autorest/test/Add-AzMonitorWorkspaceIssueInvestigationResult.Tests.ps1 Adds generated Pester scaffold for adding investigation results.
src/Monitor/MonitorWorkspace.Autorest/test/Add-AzMonitorWorkspaceIssueAlert.Tests.ps1 Adds generated Pester scaffold for adding Issue alerts.
src/Monitor/MonitorWorkspace.Autorest/README.md Updates AutoRest configuration to the new swagger path/API version.
src/Monitor/MonitorWorkspace.Autorest/Properties/AssemblyInfo.cs Bumps assembly version to 7.0.0.
src/Monitor/MonitorWorkspace.Autorest/generate-info.json Removes generate-info.json (no longer present after regeneration).
src/Monitor/MonitorWorkspace.Autorest/examples/Update-AzMonitorWorkspaceMetricsContainer.md Adds example stub file for Update MetricsContainer.
src/Monitor/MonitorWorkspace.Autorest/examples/Update-AzMonitorWorkspaceIssueResource.md Adds example stub file for Update IssueResource.
src/Monitor/MonitorWorkspace.Autorest/examples/Update-AzMonitorWorkspaceIssueAlert.md Adds example stub file for Update IssueAlert.
src/Monitor/MonitorWorkspace.Autorest/examples/Update-AzMonitorWorkspaceIssue.md Adds example stub file for Update Issue.
src/Monitor/MonitorWorkspace.Autorest/examples/Set-AzMonitorWorkspaceMetricsContainer.md Adds example stub file for Set MetricsContainer.
src/Monitor/MonitorWorkspace.Autorest/examples/Set-AzMonitorWorkspaceIssueBackgroundVisualization.md Adds example stub file for Set background visualization.
src/Monitor/MonitorWorkspace.Autorest/examples/Set-AzMonitorWorkspace.md Adds example stub file for Set MonitorWorkspace.
src/Monitor/MonitorWorkspace.Autorest/examples/Remove-AzMonitorWorkspaceIssue.md Adds example stub file for Remove Issue.
src/Monitor/MonitorWorkspace.Autorest/examples/New-AzMonitorWorkspaceMetricsContainer.md Adds example stub file for New MetricsContainer.
src/Monitor/MonitorWorkspace.Autorest/examples/New-AzMonitorWorkspaceIssue.md Adds example stub file for New Issue.
src/Monitor/MonitorWorkspace.Autorest/examples/Invoke-AzMonitorWorkspaceFetchIssueInvestigationResult.md Adds example stub file for fetching investigation results.
src/Monitor/MonitorWorkspace.Autorest/examples/Invoke-AzMonitorWorkspaceFetchIssueBackgroundVisualization.md Adds example stub file for fetching background visualization.
src/Monitor/MonitorWorkspace.Autorest/examples/Get-AzMonitorWorkspaceMetricsContainer.md Adds example stub file for Get/List MetricsContainer.
src/Monitor/MonitorWorkspace.Autorest/examples/Get-AzMonitorWorkspaceIssueResource.md Adds example stub file for listing Issue resources.
src/Monitor/MonitorWorkspace.Autorest/examples/Get-AzMonitorWorkspaceIssueAlert.md Adds example stub file for listing Issue alerts.
src/Monitor/MonitorWorkspace.Autorest/examples/Get-AzMonitorWorkspaceIssue.md Adds example stub file for Get/List Issues.
src/Monitor/MonitorWorkspace.Autorest/examples/Add-AzMonitorWorkspaceIssueResource.md Adds example stub file for adding Issue resources.
src/Monitor/MonitorWorkspace.Autorest/examples/Add-AzMonitorWorkspaceIssueInvestigationResult.md Adds example stub file for adding investigation results.
src/Monitor/MonitorWorkspace.Autorest/examples/Add-AzMonitorWorkspaceIssueAlert.md Adds example stub file for adding Issue alerts.
src/Monitor/MonitorWorkspace.Autorest/docs/Update-AzMonitorWorkspaceMetricsContainer.md Adds generated reference help for Update MetricsContainer.
src/Monitor/MonitorWorkspace.Autorest/docs/Update-AzMonitorWorkspaceIssueResource.md Adds generated reference help for Update IssueResource.
src/Monitor/MonitorWorkspace.Autorest/docs/Update-AzMonitorWorkspaceIssueAlert.md Adds generated reference help for Update IssueAlert.
src/Monitor/MonitorWorkspace.Autorest/docs/Update-AzMonitorWorkspaceIssue.md Adds generated reference help for Update Issue.
src/Monitor/MonitorWorkspace.Autorest/docs/Update-AzMonitorWorkspace.md Updates generated reference help for Update MonitorWorkspace parameters/behavior.
src/Monitor/MonitorWorkspace.Autorest/docs/Set-AzMonitorWorkspaceMetricsContainer.md Adds generated reference help for Set MetricsContainer.
src/Monitor/MonitorWorkspace.Autorest/docs/Set-AzMonitorWorkspaceIssueBackgroundVisualization.md Adds generated reference help for Set background visualization.
src/Monitor/MonitorWorkspace.Autorest/docs/Set-AzMonitorWorkspace.md Adds generated reference help for Set MonitorWorkspace.
src/Monitor/MonitorWorkspace.Autorest/docs/Remove-AzMonitorWorkspaceIssue.md Adds generated reference help for Remove Issue.
src/Monitor/MonitorWorkspace.Autorest/docs/Remove-AzMonitorWorkspace.md Updates generated reference help for Remove MonitorWorkspace.
src/Monitor/MonitorWorkspace.Autorest/docs/New-AzMonitorWorkspaceMetricsContainer.md Adds generated reference help for New MetricsContainer.
src/Monitor/MonitorWorkspace.Autorest/docs/New-AzMonitorWorkspaceIssue.md Adds generated reference help for New Issue.
src/Monitor/MonitorWorkspace.Autorest/docs/New-AzMonitorWorkspace.md Updates generated reference help for New MonitorWorkspace parameters/behavior.
src/Monitor/MonitorWorkspace.Autorest/docs/Invoke-AzMonitorWorkspaceFetchIssueInvestigationResult.md Adds generated reference help for fetching investigation results.
src/Monitor/MonitorWorkspace.Autorest/docs/Invoke-AzMonitorWorkspaceFetchIssueBackgroundVisualization.md Adds generated reference help for fetching background visualization.
src/Monitor/MonitorWorkspace.Autorest/docs/Get-AzMonitorWorkspaceMetricsContainer.md Adds generated reference help for Get/List MetricsContainer.
src/Monitor/MonitorWorkspace.Autorest/docs/Get-AzMonitorWorkspaceIssueResource.md Adds generated reference help for listing Issue resources.
src/Monitor/MonitorWorkspace.Autorest/docs/Get-AzMonitorWorkspaceIssueAlert.md Adds generated reference help for listing Issue alerts.
src/Monitor/MonitorWorkspace.Autorest/docs/Get-AzMonitorWorkspaceIssue.md Adds generated reference help for Get/List Issues.
src/Monitor/MonitorWorkspace.Autorest/docs/Get-AzMonitorWorkspace.md Updates generated reference help for Get MonitorWorkspace.
src/Monitor/MonitorWorkspace.Autorest/docs/Az.MonitorWorkspace.md Updates module cmdlet index and module GUID.
src/Monitor/MonitorWorkspace.Autorest/docs/Add-AzMonitorWorkspaceIssueResource.md Adds generated reference help for adding Issue resources.
src/Monitor/MonitorWorkspace.Autorest/docs/Add-AzMonitorWorkspaceIssueInvestigationResult.md Adds generated reference help for adding investigation results.
src/Monitor/MonitorWorkspace.Autorest/docs/Add-AzMonitorWorkspaceIssueAlert.md Adds generated reference help for adding Issue alerts.
src/Monitor/Monitor/help/Update-AzMonitorWorkspace.md Updates Az.Monitor help content for Update-AzMonitorWorkspace.
src/Monitor/Monitor/help/Remove-AzMonitorWorkspace.md Updates Az.Monitor help content for Remove-AzMonitorWorkspace.
src/Monitor/Monitor/help/New-AzMonitorWorkspace.md Updates Az.Monitor help content for New-AzMonitorWorkspace.
src/Monitor/Monitor/help/Get-AzMonitorWorkspace.md Updates Az.Monitor help content for Get-AzMonitorWorkspace.
src/Monitor/Monitor/Az.Monitor.psd1 Exports new MonitorWorkspace-related functions and updates manifest metadata.
src/Monitor/Monitor.sln Updates solution project references to point to the regenerated MonitorWorkspace project.

Comment thread src/Monitor/Monitor/Az.Monitor.psd1
Comment thread src/Monitor/MonitorWorkspace.Autorest/README.md
@VeryEarly
Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@GokulPrasad-Work GokulPrasad-Work force-pushed the feature/monitor-workspace-2025-10-03-update branch from d448f56 to b072a89 Compare May 7, 2026 18:43
- Regenerate MonitorWorkspace.Autorest from 2025-10-03 stable swagger
- Add support for Issues child resource (CRUD, alerts, investigation results, background visualization)
- Add support for MetricsContainers child resource (CRUD)
- Add MetricEnableAccessUsingResourcePermission parameter
- Add real examples for all new cmdlets
- Fix VariablesToExport to not use wildcard
- Use full commit SHA in README.md for reproducible generation
- Update Az.Monitor.psd1 to export new cmdlets
- Add help documentation for all new cmdlets

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 7, 2026 19:14
@GokulPrasad-Work GokulPrasad-Work force-pushed the feature/monitor-workspace-2025-10-03-update branch from b072a89 to 54de9f0 Compare May 7, 2026 19:14
Copy link
Copy Markdown
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

Copilot reviewed 94 out of 94 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (5)

src/Monitor/MonitorWorkspace.Autorest/test/New-AzMonitorWorkspaceIssue.Tests.ps1:1

  • The new cmdlet test files are currently fully skipped and only assert that a NotImplementedException is not thrown (because the test body never runs). This effectively provides no coverage and can mask regressions; please implement at least one non-skipped “happy path” Pester test per new cmdlet (ideally using the recording framework already being wired up) and remove the placeholder throw blocks.
    src/Monitor/MonitorWorkspace.Autorest/test/New-AzMonitorWorkspaceIssue.Tests.ps1:1
  • This directory-walk loop can become infinite if HttpPipelineMocking.ps1 is not found (e.g., Split-Path -Parent can return the same path at filesystem root), causing the test runner to hang. Add an explicit termination condition (e.g., break when parent equals current or when reaching a known repo root) and/or throw a clear error when the mocking script cannot be located.
    src/Monitor/MonitorWorkspace.Autorest/docs/Get-AzMonitorWorkspace.md:1
  • The parameter set headings were swapped to “List (Default)” vs “List1”, but the corresponding Az.Monitor help file still uses the opposite naming (default “List1” for subscription-wide listing). This inconsistency will confuse users and suggests the help generation pipeline is out of sync—please make sure both the Autorest docs and Az.Monitor help agree on parameter set names for Get-AzMonitorWorkspace.
    src/Monitor/MonitorWorkspace.Autorest/docs/Get-AzMonitorWorkspace.md:1
  • The parameter set headings were swapped to “List (Default)” vs “List1”, but the corresponding Az.Monitor help file still uses the opposite naming (default “List1” for subscription-wide listing). This inconsistency will confuse users and suggests the help generation pipeline is out of sync—please make sure both the Autorest docs and Az.Monitor help agree on parameter set names for Get-AzMonitorWorkspace.
    src/Monitor/MonitorWorkspace.Autorest/docs/Update-AzMonitorWorkspaceIssueAlert.md:1
  • The synopsis text “Add or add alerts in the issue” is grammatically incorrect and appears semantically wrong for an Update-* cmdlet (the examples indicate replacement semantics). Please correct this synopsis (and the equivalent text for IssueResource) to accurately describe the operation (e.g., “Add or update …” or “Replace …”), and ensure the same corrected wording is propagated to the Az.Monitor help and module index.

```

### -ProgressAction
{{ Fill ProgressAction Description }}

## SYNTAX

### CreateExpanded (Default)
Comment on lines +23 to +24
[assembly: System.Reflection.AssemblyFileVersionAttribute("7.0.0")]
[assembly: System.Reflection.AssemblyVersionAttribute("7.0.0")]
@YanaXu
Copy link
Copy Markdown
Contributor

YanaXu commented May 9, 2026

/azp run

@azure-pipelines
Copy link
Copy Markdown
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants