Improve help documentation for 5 monitor commands

help-improvements/monitor_activity-log_list-categories.md

@@ -0,0 +1,5 @@
+```json
+{
+  "rewritten_help": "# monitor activity-log list-categories\n\n## Description\n**monitor activity-log list-categories**: Retrieve a list of available event categories that are supported by the Azure Activity Logs Service. These categories help in filtering and understanding the types of events generated in your activity logs.\n\n## Parameters\n\n- **--change-reference**: Specify the change reference ID related to this resource operation if applicable. This helps in tracking changes that require reference-based validations or checks.\n\n- **--acquire-policy-token**: Automatically acquire an Azure Policy token for the resource operation, which is useful for ensuring the necessary policy permissions are met when listing categories.\n\n## Examples\n\n1. **List all event categories available in the Activity Logs**:\n   ```bash\n   az monitor activity-log list-categories\n   ```\n   Retrieve all available event categories without additional parameters.\n\n2. **List event categories with a change reference**:\n   ```bash\n   az monitor activity-log list-categories --change-reference 12345\n   ```\n   Use a specified change reference ID to assist in tracking resource operations related to specific changes.\n\n3. **List event categories while acquiring a policy token**:\n   ```bash\n   az monitor activity-log list-categories --acquire-policy-token\n   ```\n   Ensure that all necessary policies are applied by automatically acquiring a policy token for the operation.\n"
+}
+```

help-improvements/monitor_autoscale_profile_list-timezones.md

@@ -0,0 +1,5 @@
+```json
+{
+  "rewritten_help": "# monitor autoscale profile list-timezones\n\n## Description\nLook up available time zone information for Azure Monitor autoscale profiles. This command returns a list of time zones that can be used when configuring autoscaling settings in Azure.\n\n## Parameters\n\n- **--change-reference**: Provide a change reference ID related to this resource operation.\n\n- **--acquire-policy-token**: Automatically acquire an Azure Policy token required for this resource operation.\n\n- **--offset**: Filter time zones based on their UTC hour offset.\n\n- **--search-query (-q)**: Search for a specific time zone using query text.\n\n## Examples\n\n1. **List all time zones without any filters**\n   ```shell\n   az monitor autoscale profile list-timezones\n   ```\n\n2. **Find time zones with a specific UTC offset**\n   ```shell\n   az monitor autoscale profile list-timezones --offset +5\n   ```\n\n3. **Search for time zones containing 'Pacific' in their name**\n   ```shell\n   az monitor autoscale profile list-timezones --search-query \"Pacific\"\n   ```"
+}
+```

help-improvements/monitor_diagnostic-settings_subscription_list.md

@@ -0,0 +1,5 @@
+```json
+{
+  "rewritten_help": "# monitor diagnostic-settings subscription list\n\n## Description\nRetrieve a list of active diagnostic settings for a specified Azure subscription. Diagnostic settings enable you to collect resource logs and metrics for inspection.\n\n## Parameters\n- `--subscription-id`: The unique identifier (ID) of the Azure subscription for which you want to list the diagnostic settings. This parameter is required.\n\n## Examples\n\n### Example 1: List diagnostic settings for a subscription\nList all active diagnostic settings for a subscription identified by a given subscription ID.\n\n```bash\naz monitor diagnostic-settings subscription list --subscription-id <your-subscription-id>\n```\n\n### Example 2: Use a specific subscription context\nIf you are working in a scenario with multiple subscriptions, specify the active subscription context to list diagnostic settings.\n\n```bash\naz monitor diagnostic-settings subscription list --subscription-id <your-subscription-id>\n```\n\n### Example 3: Displaying output in a specific format\nRetrieve the diagnostic settings list and display it in table format for better readability.\n\n```bash\naz monitor diagnostic-settings subscription list --subscription-id <your-subscription-id> --output table\n```\n\n## Return Type\nReturns `SubscriptionDiagnosticSettingsResourceCollection`, which includes details on each diagnostic setting within the subscription.\n\n## Error Handling\n- Raises `HttpResponseError` if the request to the Azure service fails. This might occur due to network issues or incorrect subscription ID."
+}
+```

help-improvements/monitor_log-analytics_workspace_list-link-target.md

@@ -0,0 +1,5 @@
+```json
+{
+  "rewritten_help": "## monitor log-analytics workspace list-link-target\n\n**Description**\n\nThis command lists all Log Analytics workspaces where you, the current user, have administrator privileges and that are not linked to any Azure Subscription.\n\n**Parameters**\n\n- `--change-reference`\n  - Description: Provide a change reference ID associated with this resource operation. This is useful for tracking changes or debugging the command operation.\n\n- `--acquire-policy-token`\n  - Description: Automatically acquires an Azure Policy token for the resource operation, streamlining the process of ensuring compliance with policy requirements.\n\n**Examples**\n\n1. **List Log Analytics Workspaces with Admin Privileges**\n   \n   List all workspaces where you have administrative access and that are not linked to any Azure Subscription:\n   \n   ```bash\n   az monitor log-analytics workspace list-link-target\n   ```\n\n2. **List Workspaces with a Specific Change Reference**\n   \n   Use a change reference ID to list specific workspaces. Replace `<change-reference-id>` with your specific ID:\n   \n   ```bash\n   az monitor log-analytics workspace list-link-target --change-reference <change-reference-id>\n   ```\n\n3. **List Workspaces While Acquiring Policy Token**\n   \n   Automatically acquire a policy token during the operation:\n   \n   ```bash\n   az monitor log-analytics workspace list-link-target --acquire-policy-token\n   ```"
+}
+```

help-improvements/monitor_log-profiles_list.md

@@ -0,0 +1,5 @@
+```json
+{
+  "rewritten_help": "# monitor log-profiles list\n\n## Description\n\nRetrieve a list of all log profiles within your Azure subscription. Log profiles define the Azure Monitor log settings, including where logs are saved.\n\n## Usage\n\nUse this command to view all the existing log profiles that are configured in your Azure environment.\n\n## Examples\n\n- **List all log profiles**\n\n  To retrieve a comprehensive list of log profiles, execute the command:\n\n  ```bash\n  az monitor log-profiles list\n  ```\n\n  This command outputs a list of all log profiles, displaying details about each log profile's settings and configuration.\n\n## Additional Notes\n\nNo parameters are required for this command. Simply run the command to get the list of log profiles."
+}
+```