az self-help

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 command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Azure SelfHelp will help you troubleshoot issues with Azure resources.

Commands

Name	Description	Type	Status
az self-help check-name-availability	This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solution.	Extension	Preview
az self-help diagnostic	Diagnostic command will help you create diagnostics for azure resources.	Extension	Preview
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 discovery-solution	Discovery-solution command will help you discover available solutions based on your resource type and problem classification Id.	Extension	Preview
az self-help discovery-solution list	List the relevant Azure diagnostics and solutions using problemClassificationId API.	Extension	Preview
az self-help discovery-solution list-nlp	List the relevant Azure diagnostics and solutions using issue summary.	Extension	Preview
az self-help discovery-solution list-nlp-subscription	List the relevant Azure diagnostics and solutions using issue summary.	Extension	Preview
az self-help simplified-solution	Simplified solution command will help you create simple solutions for azure resources.	Extension	Preview
az self-help simplified-solution create	Create a simplified solution for the specific Azure resource or subscription using solutionId from discovery solutions.	Extension	Preview
az self-help simplified-solution show	Get the solution using the applicable solutionResourceName while creating the solution.	Extension	Preview
az self-help simplified-solution wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az self-help solution	Solution command will help you create solutions for azure resources.	Extension	Preview
az self-help solution-self-help	Self Help solution command will help you create tenant level solutions for azure resources.	Extension	Preview
az self-help solution-self-help show	Get the self help solution using the applicable solutionId while creating the solution.	Extension	Preview
az self-help solution create	Create a solution for the specific Azure resource or subscription using the triggering criteria from discovery solutions.	Extension	Preview
az self-help solution show	Get the solution using the applicable solutionResourceName while creating the solution.	Extension	Preview
az self-help solution update	Update a solution for the specific Azure resource or subscription using the triggering criteria from discovery solutions.	Extension	Preview
az self-help solution wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az self-help solution warmup	Warmup a solution for the specific Azure resource or subscription using the parameters needed to run the diagnostics in the solution.	Extension	Preview
az self-help troubleshooter	Troubleshooter command will help you create troubleshooters for azure resources.	Extension	Preview
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 check-name-availability

Preview

Command group 'az self-help' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solution.

az self-help check-name-availability --scope
                                     [--name]
                                     [--type]

Examples

Check Resource Uniqueness

az self-help check-name-availability --scope subscriptions/00000000-0000-0000-0000-000000000000 --name diagnostic-name --type 'Microsoft.Help/diagnostics'
az self-help check-name-availability --scope subscriptions/00000000-0000-0000-0000-000000000000 --name solution-name --type 'Microsoft.Help/solutions'
az self-help check-name-availability --scope subscriptions/00000000-0000-0000-0000-000000000000 --name 12345678-BBBb-cCCCC-0000-123456789012 --type 'Microsoft.Help/troubleshooters'

Required Parameters

--scope

This is an extension resource provider and only resource level extension is supported at the moment.

Optional Parameters

--name

The name of the resource for which availability needs to be checked.

--type

The resource type.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.