az config
Manage local Azure CLI configuration settings and preferences.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az config delete |
Delete a configuration value. |
Core | Preview |
| az config get |
Retrieve a configuration value. |
Core | Preview |
| az config info |
Display information about valid configuration keys. |
Core | Preview |
| az config list |
List all configuration settings. |
Core | Preview |
| az config set |
Set or update a configuration value. |
Core | Preview |
az config delete
Delete a configuration value.
Remove a configuration setting by key. Once deleted, the setting reverts to its default value (if one exists). Unknown keys are rejected unless --force is specified.
az config delete --key
[--force]
Examples
Delete a configuration setting
az config delete --key clients.cli.output.format
Force delete without validation
az config delete --key custom.mykey --force
Required Parameters
Configuration key in dot notation.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Allow unknown keys.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az config get
Retrieve a configuration value.
Get the current value of a configuration setting by key. Configuration keys use dot notation (e.g., clients.cli.output.format, core.logging.level). If the key is not found, an error is displayed.
az config get --key
Examples
Get output format setting
az config get --key clients.cli.output.format
Get output as JSON
az config get --key clients.cli.output.format --output json
Get output as a table
az config get --key clients.cli.output.format --output table
Query the configuration value
az config get --key clients.cli.output.format --query "value"
Required Parameters
Configuration key in dot notation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az config info
Display information about valid configuration keys.
Show metadata about available configuration keys including their descriptions, default values, and allowed value constraints. Use --keys-only to show only valid key names.
az config info [--keys-only]
Examples
Display configuration schema
az config info
Display only valid configuration key names
az config info --keys-only
Display configuration schema as a table
az config info --output table
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Return only valid keys.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az config list
List all configuration settings.
Display all current configuration values. By default, only explicitly-set values are shown. Use --all to include default values. Standard output formats such as JSON, table, TSV, and YAML are supported.
az config list [--all]
Examples
List current configuration values
az config list
List all configuration including defaults
az config list --all
List configuration as JSON
az config list --output json
List configuration as a table
az config list --output table
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 default values.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.
az config set
Set or update a configuration value.
Set a configuration value using dot notation keys. If the key already exists, it will be updated. Unknown keys are rejected unless --force is specified.
az config set --key
--value
[--force]
Examples
Set output format to JSON
az config set --key clients.cli.output.format --value json
Set a custom configuration key with force flag
az config set --key custom.mykey --value myvalue --force
Required Parameters
Configuration key in dot notation.
Configuration value.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Allow unknown keys.
Global Parameters
Increase logging verbosity to show all debug logs.
Show help for the command or group and exit.
Bypass the extension discovery cache and reload extensions from disk.
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, table, tsv, yaml, yamlc |
JMESPath query string to filter/project the command result before rendering.