az self-help troubleshooter
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 troubleshooter 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
Troubleshooter command will help you create troubleshooters for azure resources.
Commands
Name | Description | Type | Status |
---|---|---|---|
az self-help troubleshooter continue |
Uses stepId and responses as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name. |
Extension | Preview |
az self-help troubleshooter create |
Create the specific troubleshooter action under a resource or subscription. |
Extension | Preview |
az self-help troubleshooter end |
Ends the troubleshooter action. |
Extension | Preview |
az self-help troubleshooter restart |
Restarts the troubleshooter API using applicable troubleshooter resource name as the input. |
Extension | Preview |
az self-help troubleshooter show |
Get troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed. |
Extension | Preview |
az self-help troubleshooter continue
Command group 'az self-help troubleshooter' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Uses stepId and responses as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name.
az self-help troubleshooter continue --scope
--troubleshooter-name
[--responses]
[--step-id]
Examples
Continue Troubleshooter at Resource Level
az self-help troubleshooter continue --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789123 --step-id step-id --responses [] --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
Required Parameters
This is an extension resource provider and only resource level extension is supported at the moment.
Troubleshooter resource Name.
Optional Parameters
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Unique id of the result.
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 troubleshooter create
Command group 'az self-help troubleshooter' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create the specific troubleshooter action under a resource or subscription.
az self-help troubleshooter create --scope
--troubleshooter-name
[--parameters]
[--solution-id]
Examples
Create Troubleshooter at Resource Level
az self-help troubleshooter create --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789123 --solution-id e104dbdf-9e14-4c9f-bc78-21ac90382231 --parameters {ResourceUri:'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'} --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
Required Parameters
This is an extension resource provider and only resource level extension is supported at the moment.
Troubleshooter resource Name.
Optional Parameters
Client input parameters to run Troubleshooter Resource Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Solution Id to identify single troubleshooter.
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 troubleshooter end
Command group 'az self-help troubleshooter' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Ends the troubleshooter action.
az self-help troubleshooter end --scope
--troubleshooter-name
Examples
End Troubleshooter at Resource Level
az self-help troubleshooter end --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789123 --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
Required Parameters
This is an extension resource provider and only resource level extension is supported at the moment.
Troubleshooter resource Name.
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 troubleshooter restart
Command group 'az self-help troubleshooter' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Restarts the troubleshooter API using applicable troubleshooter resource name as the input.
az self-help troubleshooter restart --scope
--troubleshooter-name
Examples
Restart Troubleshooter at Resource Level
az self-help troubleshooter restart --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789123 --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
Required Parameters
This is an extension resource provider and only resource level extension is supported at the moment.
Troubleshooter resource Name.
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 troubleshooter show
Command group 'az self-help troubleshooter' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed.
az self-help troubleshooter show --scope
--troubleshooter-name
Examples
Show Troubleshooter at Resource Level
az self-help troubleshooter show --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789123 --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
Required Parameters
This is an extension resource provider and only resource level extension is supported at the moment.
Troubleshooter resource Name.
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.