Skip to content

[MONITOR] Improve help documentation for 10 commands#33358

Draft
RenSilvaAU wants to merge 1 commit into
Azure:devfrom
RenSilvaAU:improve-help-monitor-20260512-045333
Draft

[MONITOR] Improve help documentation for 10 commands#33358
RenSilvaAU wants to merge 1 commit into
Azure:devfrom
RenSilvaAU:improve-help-monitor-20260512-045333

Conversation

@RenSilvaAU
Copy link
Copy Markdown
Contributor

@RenSilvaAU RenSilvaAU commented May 12, 2026

AI-generated code

Azure CLI Help Documentation Improvements

This PR improves help documentation for commands with the lowest quality scores.

Summary

Command Type Original Score New Score
monitor diagnostic-settings subscription list New 2.0/10 3/10
monitor log-analytics workspace list-link-target New 3.0/10 6/10
monitor activity-log list-categories New 3.0/10 6/10
monitor log-analytics workspace list-available-service-tier New 4.0/10 7/10
monitor log-analytics workspace data-export list New 4.0/10 7/10
monitor log-profiles list New 4.0/10 5/10
monitor action-group list New 5.0/10 8/10
monitor action-group delete New 5.0/10 7/10
monitor metrics alert show New 5.0/10 6/10
monitor log-analytics workspace list New 5.0/10 7/10

monitor diagnostic-settings subscription list (New entry)

Command metadata (score: 2.0/10) 
Command: monitor diagnostic-settings subscription list
======================================================================
name: monitor diagnostic-settings subscription list
is_aaz: True
desc: Gets the active subscription diagnostic settings list for the specified subscriptionId. :keyword callable cls: A custom type or function that will be passed the direct response:return: SubscriptionDiagnosticSettingsResourceCollection or the result of cls(response):rtype:  ~$(python-base-namespace).v2017_05_01_preview.models.SubscriptionDiagnosticSettingsResourceCollection:raises ~azure.core.exceptions.HttpResponseError:.
parameters:
New help (score: 3/10) 
type: command
short-summary: List the active subscription diagnostic settings for a specified subscription.

monitor log-analytics workspace list-link-target (New entry)

Command metadata (score: 3.0/10) 
Command: monitor log-analytics workspace list-link-target
======================================================================
name: monitor log-analytics workspace list-link-target
is_aaz: True
desc: List a list of workspaces which the current user has administrator privileges and are not associated with an Azure Subscription.
parameters:
  Item 1:
    name: _change_reference
    options:
      - --change-reference
    desc: The related change reference ID for this resource operation
  Item 2:
    name: _acquire_policy_token
    options:
      - --acquire-policy-token
    desc: Acquiring an Azure Policy token automatically for this resource operation
New help (score: 6/10) 
type: command
short-summary: List workspaces which the current user administers and are not linked to an Azure Subscription.
parameters:
  - name: --change-reference
    short-summary: The related change reference ID for this resource operation.
  - name: --acquire-policy-token
    short-summary: Acquiring an Azure Policy token automatically for this resource operation.
examples:
  - name: List link targets with specific change reference ID
    text: |
        az monitor log-analytics workspace list-link-target --change-reference CHG12345
  - name: List link targets and acquire Azure Policy token
    text: |
        az monitor log-analytics workspace list-link-target --acquire-policy-token

monitor activity-log list-categories (New entry)

Command metadata (score: 3.0/10) 
Command: monitor activity-log list-categories
======================================================================
name: monitor activity-log list-categories
is_aaz: True
desc: List the list of available event categories supported in the Activity Logs Service.
parameters:
  Item 1:
    name: _change_reference
    options:
      - --change-reference
    desc: The related change reference ID for this resource operation
  Item 2:
    name: _acquire_policy_token
    options:
      - --acquire-policy-token
    desc: Acquiring an Azure Policy token automatically for this resource operation
New help (score: 6/10) 
type: command
short-summary: List the available event categories in the Activity Logs Service.
parameters:
  - name: --change-reference
    short-summary: The related change reference ID for this resource operation.
  - name: --acquire-policy-token
    short-summary: Acquiring an Azure Policy token automatically for this resource operation.
examples:
  - name: List event categories with a specific change reference
    text: |
        az monitor activity-log list-categories --change-reference MyChangeRefID
  - name: List event categories while acquiring a policy token
    text: |
        az monitor activity-log list-categories --acquire-policy-token

monitor log-analytics workspace list-available-service-tier (New entry)

Command metadata (score: 4.0/10) 
Command: monitor log-analytics workspace list-available-service-tier
======================================================================
name: monitor log-analytics workspace list-available-service-tier
is_aaz: True
desc: List the available service tiers for the workspace.
parameters:
  Item 1:
    name: _change_reference
    options:
      - --change-reference
    desc: The related change reference ID for this resource operation
  Item 2:
    name: _acquire_policy_token
    options:
      - --acquire-policy-token
    desc: Acquiring an Azure Policy token automatically for this resource operation
  Item 3:
    name: resource_group
    options:
      - --resource-group
      - -g
    required: True
    id_part: resource_group
    has_completer: True
    desc: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
    aaz_type: string
    type: string
  Item 4:
    name: workspace_name
    options:
      - --workspace-name
      - -n
    required: True
    id_part: name
    desc: The name of the workspace.
    aaz_type: string
    type: string
New help (score: 7/10) 
type: command
short-summary: List the available service tiers for the workspace.
parameters:
  - name: --resource-group -g
    short-summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
  - name: --workspace-name -n
    short-summary: The name of the workspace.
examples:
  - name: List available service tiers for a specific workspace
    text: |
        az monitor log-analytics workspace list-available-service-tier --resource-group MyResourceGroup --workspace-name MyWorkspace

monitor log-analytics workspace data-export list (New entry)

Command metadata (score: 4.0/10) 
Command: monitor log-analytics workspace data-export list
======================================================================
name: monitor log-analytics workspace data-export list
is_aaz: True
desc: List all data export ruleses for a given workspace.
parameters:
  Item 1:
    name: resource_group
    options:
      - --resource-group
      - -g
    required: True
    id_part: resource_group
    has_completer: True
    desc: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
    aaz_type: string
    type: string
  Item 2:
    name: workspace_name
    options:
      - --workspace-name
    required: True
    desc: The name of the workspace.
    aaz_type: string
    type: string
New help (score: 7/10) 
type: command
short-summary: List all data export rules for a given workspace.
parameters:
  - name: --resource-group -g
    short-summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
  - name: --workspace-name
    short-summary: The name of the workspace.
examples:
  - name: List all data export rules for a workspace
    text: |
      az monitor log-analytics workspace data-export list --resource-group MyResourceGroup --workspace-name MyWorkspace

monitor log-profiles list (New entry)

Command metadata (score: 4.0/10) 
Command: monitor log-profiles list
======================================================================
name: monitor log-profiles list
is_aaz: True
desc: List the log profiles.
parameters:
New help (score: 5/10) 
type: command
short-summary: List the log profiles.
examples:
  - name: List all log profiles
    text: |
        az monitor log-profiles list

monitor action-group list (New entry)

Command metadata (score: 5.0/10) 
Command: monitor action-group list
======================================================================
name: monitor action-group list
is_aaz: True
desc: List action groups under a resource group or the current subscription.
parameters:
  Item 1:
    name: resource_group
    options:
      - --resource-group
      - -g
    id_part: resource_group
    has_completer: True
    desc: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
    aaz_type: string
    type: string
New help (score: 8/10) 
type: command
short-summary: List action groups under a resource group or the current subscription.
parameters:
  - name: --resource-group -g
    short-summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
examples:
  - name: List all action groups in a specific resource group
    text: |
        az monitor action-group list --resource-group MyResourceGroup
  - name: List all action groups in the current subscription
    text: |
        az monitor action-group list

monitor action-group delete (New entry)

Command metadata (score: 5.0/10) 
Command: monitor action-group delete
======================================================================
name: monitor action-group delete
is_aaz: True
desc: Delete an action group.
parameters:
  Item 1:
    name: _change_reference
    options:
      - --change-reference
    desc: The related change reference ID for this resource operation
  Item 2:
    name: _acquire_policy_token
    options:
      - --acquire-policy-token
    desc: Acquiring an Azure Policy token automatically for this resource operation
  Item 3:
    name: action_group_name
    options:
      - --action-group-name
      - --name
      - -n
    required: True
    id_part: name
    desc: The name of the action group.
    aaz_type: string
    type: string
  Item 4:
    name: resource_group
    options:
      - --resource-group
      - -g
    required: True
    id_part: resource_group
    has_completer: True
    desc: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
    aaz_type: string
    type: string
New help (score: 7/10) 
type: command
short-summary: Delete an action group.
parameters:
  - name: --change-reference
    short-summary: The related change reference ID for this resource operation.
  - name: --acquire-policy-token
    short-summary: Acquiring an Azure Policy token automatically for this resource operation.
  - name: --action-group-name --name -n
    short-summary: The name of the action group.
  - name: --resource-group -g
    short-summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
examples:
  - name: Delete an action group in a specific resource group
    text: |
        az monitor action-group delete --action-group-name MyActionGroup --resource-group MyResourceGroup
  - name: Delete an action group with change reference
    text: |
        az monitor action-group delete --action-group-name MyActionGroup --resource-group MyResourceGroup --change-reference 12345

monitor metrics alert show (New entry)

Command metadata (score: 5.0/10) 
Command: monitor metrics alert show
======================================================================
name: monitor metrics alert show
is_aaz: True
examples:
  Item 1:
    name: Show a metrics-based alert rule.
    text: az --name MyAlertRule --resource-group MyResourceGroup
desc: Show a metrics-based alert rule.
parameters:
  Item 1:
    name: resource_group
    options:
      - --resource-group
      - -g
    required: True
    id_part: resource_group
    has_completer: True
    desc: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
    aaz_type: string
    type: string
  Item 2:
    name: name
    options:
      - --name
      - -n
    required: True
    id_part: name
    desc: Name of the alert rule.
    aaz_type: string
    type: string
New help (score: 6/10) 
type: command
short-summary: Show a metrics-based alert rule.
parameters:
  - name: --resource-group -g
    short-summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
  - name: --name -n
    short-summary: Name of the alert rule.
examples:
  - name: Show a metrics-based alert rule.
    text: |
        az monitor metrics alert show --name MyAlertRule --resource-group MyResourceGroup

monitor log-analytics workspace list (New entry)

Command metadata (score: 5.0/10) 
Command: monitor log-analytics workspace list
======================================================================
name: monitor log-analytics workspace list
is_aaz: True
desc: Get a list of workspaces under a resource group or a subscription.
parameters:
  Item 1:
    name: resource_group
    options:
      - --resource-group
      - -g
    id_part: resource_group
    has_completer: True
    desc: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`
    aaz_type: string
    type: string
New help (score: 7/10) 
type: command
short-summary: List workspaces under a resource group or a subscription.
parameters:
  - name: --resource-group -g
    short-summary: Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
examples:
  - name: List all workspaces in a specific resource group
    text: |
        az monitor log-analytics workspace list --resource-group MyResourceGroup
  - name: List all workspaces in the current subscription
    text: |
        az monitor log-analytics workspace list

Generated by: Azure CLI Help Improver

@azure-client-tools-bot-prd
Copy link
Copy Markdown

azure-client-tools-bot-prd Bot commented May 12, 2026 •
edited
Loading

️✔️AzureCLI-FullTest
️✔️acr
️✔️latest
️✔️3.12
️✔️3.13
️✔️acs
️✔️latest
️✔️3.12
️✔️3.13
️✔️advisor
️✔️latest
️✔️3.12
️✔️3.13
️✔️ams
️✔️latest
️✔️3.12
️✔️3.13
️✔️apim
️✔️latest
️✔️3.12
️✔️3.13
️✔️appconfig
️✔️latest
️✔️3.12
️✔️3.13
️✔️appservice
️✔️latest
️✔️3.12
️✔️3.13
️✔️aro
️✔️latest
️✔️3.12
️✔️3.13
️✔️backup
️✔️latest
️✔️3.12
️✔️3.13
️✔️batch
️✔️latest
️✔️3.12
️✔️3.13
️✔️batchai
️✔️latest
️✔️3.12
️✔️3.13
️✔️billing
️✔️latest
️✔️3.12
️✔️3.13
️✔️botservice
️✔️latest
️✔️3.12
️✔️3.13
️✔️cdn
️✔️latest
️✔️3.12
️✔️3.13
️✔️cloud
️✔️latest
️✔️3.12
️✔️3.13
️✔️cognitiveservices
️✔️latest
️✔️3.12
️✔️3.13
️✔️compute_recommender
️✔️latest
️✔️3.12
️✔️3.13
️✔️computefleet
️✔️latest
️✔️3.12
️✔️3.13
️✔️config
️✔️latest
️✔️3.12
️✔️3.13
️✔️configure
️✔️latest
️✔️3.12
️✔️3.13
️✔️consumption
️✔️latest
️✔️3.12
️✔️3.13
️✔️container
️✔️latest
️✔️3.12
️✔️3.13
️✔️containerapp
️✔️latest
️✔️3.12
️✔️3.13
️✔️core
️✔️latest
️✔️3.12
️✔️3.13
️✔️cosmosdb
️✔️latest
️✔️3.12
️✔️3.13
️✔️databoxedge
️✔️latest
️✔️3.12
️✔️3.13
️✔️dls
️✔️latest
️✔️3.12
️✔️3.13
️✔️dms
️✔️latest
️✔️3.12
️✔️3.13
️✔️eventgrid
️✔️latest
️✔️3.12
️✔️3.13
️✔️eventhubs
️✔️latest
️✔️3.12
️✔️3.13
️✔️feedback
️✔️latest
️✔️3.12
️✔️3.13
️✔️find
️✔️latest
️✔️3.12
️✔️3.13
️✔️hdinsight
️✔️latest
️✔️3.12
️✔️3.13
️✔️identity
️✔️latest
️✔️3.12
️✔️3.13
️✔️iot
️✔️latest
️✔️3.12
️✔️3.13
️✔️keyvault
️✔️latest
️✔️3.12
️✔️3.13
️✔️lab
️✔️latest
️✔️3.12
️✔️3.13
️✔️managedservices
️✔️latest
️✔️3.12
️✔️3.13
️✔️maps
️✔️latest
️✔️3.12
️✔️3.13
️✔️marketplaceordering
️✔️latest
️✔️3.12
️✔️3.13
️✔️monitor
️✔️latest
️✔️3.12
️✔️3.13
️✔️mysql
️✔️latest
️✔️3.12
️✔️3.13
️✔️netappfiles
️✔️latest
️✔️3.12
️✔️3.13
️✔️network
️✔️latest
️✔️3.12
️✔️3.13
️✔️policyinsights
️✔️latest
️✔️3.12
️✔️3.13
️✔️postgresql
️✔️latest
️✔️3.12
️✔️3.13
️✔️privatedns
️✔️latest
️✔️3.12
️✔️3.13
️✔️profile
️✔️latest
️✔️3.12
️✔️3.13
️✔️rdbms
️✔️latest
️✔️3.12
️✔️3.13
️✔️redis
️✔️latest
️✔️3.12
️✔️3.13
️✔️relay
️✔️latest
️✔️3.12
️✔️3.13
️✔️resource
️✔️latest
️✔️3.12
️✔️3.13
️✔️role
️✔️latest
️✔️3.12
️✔️3.13
️✔️search
️✔️latest
️✔️3.12
️✔️3.13
️✔️security
️✔️latest
️✔️3.12
️✔️3.13
️✔️servicebus
️✔️latest
️✔️3.12
️✔️3.13
️✔️serviceconnector
️✔️latest
️✔️3.12
️✔️3.13
️✔️servicefabric
️✔️latest
️✔️3.12
️✔️3.13
️✔️signalr
️✔️latest
️✔️3.12
️✔️3.13
️✔️sql
️✔️latest
️✔️3.12
️✔️3.13
️✔️sqlvm
️✔️latest
️✔️3.12
️✔️3.13
️✔️storage
️✔️latest
️✔️3.12
️✔️3.13
️✔️synapse
️✔️latest
️✔️3.12
️✔️3.13
️✔️telemetry
️✔️latest
️✔️3.12
️✔️3.13
️✔️util
️✔️latest
️✔️3.12
️✔️3.13
️✔️vm
️✔️latest
️✔️3.12
️✔️3.13

@azure-client-tools-bot-prd
Copy link
Copy Markdown

azure-client-tools-bot-prd Bot commented May 12, 2026 •
edited
Loading

️✔️AzureCLI-BreakingChangeTest
️✔️Non Breaking Changes

@yonzhan
Copy link
Copy Markdown
Collaborator

yonzhan commented May 12, 2026

Thank you for your contribution! We will review the pull request and get back to you soon.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 12, 2026

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

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

Reviewers

@yonzhan yonzhan Awaiting requested review from yonzhan

@NoriZC NoriZC Awaiting requested review from NoriZC NoriZC will be requested when the pull request is marked ready for review NoriZC is a code owner

@yanzhudd yanzhudd Awaiting requested review from yanzhudd yanzhudd will be requested when the pull request is marked ready for review yanzhudd is a code owner

@teresaritorto teresaritorto Awaiting requested review from teresaritorto teresaritorto will be requested when the pull request is marked ready for review teresaritorto is a code owner

Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

At least 1 approving review is required to merge this pull request.

Assignees

@RenSilvaAU RenSilvaAU

Labels

None yet

Projects

None yet

Milestone

June 2026 (2026-06-02)

Development

Successfully merging this pull request may close these issues.

2 participants

@RenSilvaAU @yonzhan