az self-help solution
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 solution 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
Solution command will help you create solutions for azure resources.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 solution create
Command group 'az self-help solution' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a solution for the specific Azure resource or subscription using the triggering criteria from discovery solutions.
az self-help solution create --scope
--solution-name
[--content]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--parameters]
[--provisioning-state {Canceled, Failed, Succeeded}]
[--replacement-maps]
[--sections]
[--solution-id]
[--title]
[--trigger-criteria]Examples
Create Solution at Resource Level
az self-help solution create --solution-name solution-name --trigger-criteria [{name:solutionid,value:apollo-cognitve-search-custom-skill}] --parameters {} --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.
Solution resource Name.
Optional Parameters
The HTML content that needs to be rendered and shown to customer.
Do not wait for the long-running operation to finish.
Client input parameters to run Solution Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Status of solution provisioning.
Solution replacement maps. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of section object. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Solution Id to identify single solution.
The title.
Solution request trigger criteria Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 solution show
Command group 'az self-help solution' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the solution using the applicable solutionResourceName while creating the solution.
az self-help solution show --scope
--solution-nameExamples
Show Solution at Resource Level
az self-help solution show --solution-name solution-name --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.
Solution 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 solution update
Command group 'az self-help solution' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update a solution for the specific Azure resource or subscription using the triggering criteria from discovery solutions.
az self-help solution update --scope
--solution-name
[--add]
[--content]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--parameters]
[--provisioning-state {Canceled, Failed, Succeeded}]
[--remove]
[--replacement-maps]
[--sections]
[--set]
[--solution-id]
[--title]
[--trigger-criteria]Examples
Update Solution at Resource Level
az self-help solution update --solution-name solution-name --trigger-criteria [{name:ReplacementKey,value:<!--56ee7509-92e1-4b9e-97c2-dda53065294c-->}] --parameters {SearchText:CanNotRDP,SymptomId:KeyVaultVaultNotFoundInsight} --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.
Solution resource Name.
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
The HTML content that needs to be rendered and shown to customer.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Do not wait for the long-running operation to finish.
Client input parameters to run Solution Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Status of solution provisioning.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Solution replacement maps. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of section object. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Solution Id to identify single solution.
The title.
Solution request trigger criteria Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 solution wait
Command group 'az self-help solution' 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 solution wait --scope
--solution-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Required Parameters
This is an extension resource provider and only resource level extension is supported at the moment.
Solution resource Name.
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.
az self-help solution warmup
Command group 'az self-help solution' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Warmup a solution for the specific Azure resource or subscription using the parameters needed to run the diagnostics in the solution.
az self-help solution warmup --scope
--solution-name
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--parameters]Examples
Warmup Solution at Resource Level
az self-help solution warmup --solution-name solution-name --parameters {} --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.
Solution resource Name.
Optional Parameters
Do not wait for the long-running operation to finish.
Client input parameters to run Solution Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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