az config
This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage Azure CLI configuration.
Available since Azure CLI 2.10.0.
Commands
Name | Description | Type | Status |
---|---|---|---|
az config get |
Get a configuration. |
Core | Experimental |
az config param-persist |
Manage parameter persistence. |
Core | Experimental |
az config param-persist delete |
Delete parameter persistence data. |
Core | Experimental |
az config param-persist off |
Turn off parameter persistence. |
Core | Experimental |
az config param-persist on |
Turn on parameter persistence. |
Core | Experimental |
az config param-persist show |
Show parameter persistence data. |
Core | Experimental |
az config set |
Set a configuration. |
Core | Experimental |
az config unset |
Unset a configuration. |
Core | Experimental |
az config get
Command group 'config' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get a configuration.
az config get [--local]
[]
Examples
Get all configurations.
az config get
Get configurations in `core` section.
az config get core
Get the configuration of key `core.no_color`.
az config get core.no_color
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Include local configuration. Scan from the working directory up to the root drive, then the global configuration and return the first occurrence.
Property | Value |
---|---|
Default value: | False |
The configuration to get. If not provided, all sections and configurations will be listed. If section
is provided, all configurations under the specified section will be listed. If <section>.<key>
is provided, only the corresponding configuration is shown.
Property | Value |
---|---|
Parameter group: | Positional |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az config set
Command group 'config' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Set a configuration.
For available configuration options, see https://learn.microsoft.com/cli/azure/azure-cli-configuration.
By default without specifying --local, the configuration will be saved to ~/.azure/config
.
az config set [--local]
[]
Examples
Disable color with `core.no_color`.
az config set core.no_color=true
Hide warnings and only show errors with `core.only_show_errors`.
az config set core.only_show_errors=true
Turn on client-side telemetry.
az config set core.collect_telemetry=true
Turn on file logging and set its location.
az config set logging.enable_log_file=true
az config set logging.log_dir=~/az-logs
Set the default location to `westus2` and default resource group to `myRG`.
az config set defaults.location=westus2 defaults.group=MyResourceGroup
Set the default resource group to `myRG` on a local scope.
az config set defaults.group=myRG --local
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Set as a local configuration in the working directory.
Property | Value |
---|---|
Default value: | False |
Space-separated configurations in the form of <section>.<key>=<value>
.
Property | Value |
---|---|
Parameter group: | Positional |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az config unset
Command group 'config' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Unset a configuration.
az config unset [--local]
[]
Examples
Unset the configuration of key `core.no_color`.
az config unset core.no_color
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Include local configuration. Scan from the working directory up to the root drive, then the global configuration and unset the first occurrence.
Property | Value |
---|---|
Default value: | False |
The configuration to unset, in the form of <section>.<key>
.
Property | Value |
---|---|
Parameter group: | Positional |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |