Improve help documentation for 5 monitor commands#33197
Closed
RenSilvaAU wants to merge 1 commit intoAzure:devfrom
Closed
Improve help documentation for 5 monitor commands#33197RenSilvaAU wants to merge 1 commit intoAzure:devfrom
RenSilvaAU wants to merge 1 commit intoAzure:devfrom
Conversation
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
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). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
|
Azure Pipelines: Successfully started running 3 pipeline(s). |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Azure CLI Help Documentation Improvements
This PR improves help documentation for commands with the lowest quality scores.
Summary
monitor log-profiles listmonitor diagnostic-settings subscription listmonitor activity-log list-categoriesmonitor log-profiles showmonitor diagnostic-settings subscription showmonitor log-profiles listOriginal help (score: 3.0/10)
Improved help (score: 7/10)
Azure CLI Command:
monitor log-profiles listDescription
The
monitor log-profiles listcommand retrieves a list of all log profiles in your Azure account. Log profiles define and manage the settings and destinations for your activity logs, providing insights into operations performed within your Azure resources.Usage
Run this command to view all log profiles configured in your account. This helps in auditing, monitoring, and analyzing activities across different Azure services.
Examples
Example 1: List all log profiles
This command lists all log profiles without any filtering or additional parameters. Useful for getting an overview of all the log profile configurations in your Azure account.
Example 2: List log profiles with output formatted as table
This example lists all log profiles and formats the output as a table for a more readable display.
Example 3: List log profiles with output in JSON format
In this usage, the log profiles are displayed in JSON format, which can be useful for programmatic processing or when integrating with other tools.
Additional Information
--outputfor specifying JSON, table, TSV, etc.For more comprehensive usage details, refer to the Azure CLI documentation for the
monitor log-profiles listcommand.monitor diagnostic-settings subscription listOriginal help (score: 3.0/10)
Improved help (score: 8/10)
Azure CLI Command:
monitor diagnostic-settings subscription listDescription
Retrieves the list of active diagnostic settings for a specified subscription ID in Azure Monitor.
Usage
Use this command to list all diagnostic settings configured for your Azure subscription. This can help you audit configuration and ensure proper logging and monitoring are set up.
Command Syntax
Parameters
--subscription-id(required): The unique identifier of the Azure subscription for which you want to list the diagnostic settings.Examples
List Diagnostic Settings for a Subscription
Retrieves all diagnostic settings for the subscription specified by the subscription ID
12345-abcde-6789-fghij-0123456789.Using Environment Variable for Subscription ID
Uses the environment variable
AZURE_SUBSCRIPTION_IDto specify the subscription ID, providing a convenient method for scripting or automation setups.Notes
aazcommands.Errors
HttpResponseError: Occurs if there is a problem with the HTTP response, such as issues with permissions or an incorrect subscription ID.monitor activity-log list-categoriesOriginal help (score: 3.0/10)
Improved help (score: 7/10)
Azure CLI -
monitor activity-log list-categoriesDescription
The
monitor activity-log list-categoriescommand retrieves a list of available event categories supported in the Azure Activity Logs Service. This information can help you understand what types of activities are logged in your Azure environment.Parameters
Examples
Example 1: Basic Use
List all event categories available in the Activity Logs Service.
Example 2: Specifying a Change Reference
Retrieve the event categories using a specific change reference ID.
Example 3: Acquiring Policy Token
Acquire an Azure Policy token automatically while listing event categories.
monitor log-profiles showOriginal help (score: 4.0/10)
Improved help (score: 7/10)
monitor log-profiles show
Description
Retrieve a specific log profile from Azure Monitor.
Parameters
--name | -n
Examples
Example 1: Retrieve a log profile by name
Example 2: Retrieve a log profile using short option
Important Notes
monitor diagnostic-settings subscription showOriginal help (score: 4.0/10)
Improved help (score: 6/10)
monitor diagnostic-settings subscription show
Description
Retrieve the active diagnostic settings for a subscription-level resource.
Parameters
Examples
Show the diagnostic settings for a subscription resource:
Using the short-form parameter:
Use this command to obtain details about diagnostic settings, which help in monitoring and diagnosing the health and performance of subscription resources.
Generated by: Azure CLI Help Improver