Improve help documentation for 5 monitor commands#33198
Closed
RenSilvaAU wants to merge 1 commit intoAzure:devfrom
Closed
Improve help documentation for 5 monitor commands#33198RenSilvaAU 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 log-analytics workspace list-link-targetmonitor activity-log list-categoriesmonitor log-profiles deletemonitor log-profiles listOriginal help (score: 2.0/10)
Improved help (score: 7/10)
type: command
short-summary: List all log profiles in your Azure account.
long-summary: |
Log profiles define and manage the settings and destinations for your activity logs.
They provide insights into the operations performed within your Azure resources.
examples:
text: az monitor log-profiles list
text: az monitor log-profiles list --output table
text: az monitor log-profiles list --output json
monitor diagnostic-settings subscription listOriginal help (score: 4.0/10)
Improved help (score: 7/10)
type: command
short-summary: List all active diagnostic settings for a specified subscription.
parameters:
short-summary: The unique identifier of the Azure subscription to list the diagnostic settings for.
examples:
text: |
az monitor diagnostic-settings subscription list --subscription-id 12345-abcde-6789-fghij-0123456789
text: |
az monitor diagnostic-settings subscription list --subscription-id $AZURE_SUBSCRIPTION_ID
monitor log-analytics workspace list-link-targetOriginal help (score: 4.0/10)
Improved help (score: 7/10)
type: command
short-summary: List workspaces where the user is an administrator and are not linked to any Azure Subscription.
parameters:
short-summary: Specify the change reference ID related to this operation.
short-summary: Automatically acquire an Azure Policy token for this operation.
examples:
text: |
az monitor log-analytics workspace list-link-target
text: |
az monitor log-analytics workspace list-link-target --change-reference myChangeRefId
text: |
az monitor log-analytics workspace list-link-target --acquire-policy-token
monitor activity-log list-categoriesOriginal help (score: 4.0/10)
Improved help (score: 5/10)
type: command
short-summary: List available event categories in the Azure Activity Logs Service.
parameters:
short-summary: Specify the change reference ID related to this resource operation.
short-summary: Automatically acquire an Azure Policy token for this resource operation.
examples:
text: az monitor activity-log list-categories
text: az monitor activity-log list-categories --change-reference actual_change_reference_id
text: az monitor activity-log list-categories --acquire-policy-token
monitor log-profiles deleteOriginal help (score: 5.0/10)
Improved help (score: 6/10)
type: command
short-summary: Delete a log profile.
parameters:
short-summary: The change reference ID associated with this resource operation.
short-summary: Automatically acquire an Azure Policy token for this resource operation.
short-summary: The name of the log profile to delete.
examples:
text: |
az monitor log-profiles delete --name MyLogProfile
Generated by: Azure CLI Help Improver