Share via

az advisor configuration

Manage Azure Advisor configuration.

Commands

Name Description Type Status
az advisor configuration list

List Azure Advisor configuration for the entire subscription.

 Core GA
az advisor configuration show

Show Azure Advisor configuration for the given subscription or resource group.

 Core GA
az advisor configuration update

Update Azure Advisor configuration.

 Core GA

az advisor configuration list

Edit

List Azure Advisor configuration for the entire subscription.

az advisor configuration list
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az advisor configuration show

Edit

Show Azure Advisor configuration for the given subscription or resource group.

az advisor configuration show [--resource-group]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az advisor configuration update

Edit

Update Azure Advisor configuration.

az advisor configuration update [--add]
                                [--configuration-name]
                                [--exclude]
                                [--force-string]
                                [--include]
                                [--low-cpu-threshold {10, 15, 20, 5}]
                                [--remove]
                                [--resource-group]
                                [--set]

Examples

Update low CPU threshold for a given subscription to 20%.

az advisor configuration update -l 20

Exclude a given resource group from recommendation generation.

az advisor configuration update -g myRG -e

Update Azure Advisor configuration. (autogenerated)

az advisor configuration update --include --resource-group myRG

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--configuration-name

Advisor configuration name. Value must be "default".

--exclude -e

Exclude from recommendation generation.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Default value: False
--include -i

Include in recommendation generation.

--low-cpu-threshold -l

Value for low CPU threshold.

Property Value
Accepted values: 10, 15, 20, 5
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False