az self-help diagnostic
Note
This reference is part of the self-help extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az self-help diagnostic command. Learn more about extensions.
Command group 'az self-help' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Diagnostic command will help you create diagnostics for azure resources.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az self-help diagnostic create |
Creates a diagnostics that will help you troubleshoot an issue with your azure resource. |
Extension | Preview |
| az self-help diagnostic show |
Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic. |
Extension | Preview |
| az self-help diagnostic wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az self-help diagnostic create
Command group 'az self-help diagnostic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Creates a diagnostics that will help you troubleshoot an issue with your azure resource.
az self-help diagnostic create --diagnostic-name
--scope
[--global-parameters]
[--insights]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Create Diagnostic at Resource Level
az self-help diagnostic create --diagnostic-name diagnostic-name --insights [{solutionId:Demo2InsightV2}] --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'Required Parameters
Unique resource name for insight resources.
This is an extension resource provider and only resource level extension is supported at the moment.
Optional Parameters
Global parameters that can be passed to all solutionIds. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
SolutionIds that are needed to be invoked. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az self-help diagnostic show
Command group 'az self-help diagnostic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
az self-help diagnostic show --diagnostic-name
--scopeExamples
Show Diagnostic at Resource Level
az self-help diagnostic show --diagnostic-name diagnostic-name --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'Required Parameters
Unique resource name for insight resources.
This is an extension resource provider and only resource level extension is supported at the moment.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az self-help diagnostic wait
Command group 'az self-help diagnostic' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az self-help diagnostic wait --diagnostic-name
--scope
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Required Parameters
Unique resource name for insight resources.
This is an extension resource provider and only resource level extension is supported at the moment.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for