Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Azure CLI preview stores user-scope configuration in a global JSON file.
Configuration follows strict precedence: command args > environment variables > global config > defaults.
Valid configuration keys
| Key | Type | Default | Notes |
|---|---|---|---|
core.logging.level |
string | warn |
Log level: debug, info, warn, error. The CLI writes diagnostics (warn/info/verbose/debug) to stderr and command results to stdout. For more information, see CLI usage. |
core.output.color |
string | auto |
CLI color rendering mode: auto (respect env vars and redirection), always (force color on), never (force color off). NO_COLOR and FORCE_COLOR env vars still take precedence over this setting. CLI-scoped; PowerShell coloring is controlled by the PS host. |
core.http.maxRetries |
int | 3 |
Max HTTP request retries |
core.http.maxRetriesFor429 |
int | 5 |
Max retries for 429 (rate limit) responses |
core.engine.extensionIndexCacheSize |
int | 512 |
LFU cache capacity for extension index (entry count) |
assemblyLoading.installedExtensionsRoot |
string | (system) | Root directory for extensions installed via az extension add. Controls where DLLs land, where registry.json is written (as <root>/registry.json), and every az extension add/list/show/pin/remove/update read/write path. Default: ~/.azclips/extensions. Changing this key does not migrate existing state — move registry.json and the <pkg>/<version>/ payload folders manually if needed. |
assemblyLoading.extensionFolderPrefix |
string | (see notes) | Extension assembly folder prefix; Microsoft.Azure.Azclips.Extensions. (DEBUG), empty (Release) |
telemetry.enabled |
bool | true |
Enable telemetry |
agent.enabled |
bool | false |
Enable AI agent fallback (opt-in: az config set --key agent.enabled --value true) |
agent.provider |
string | builtin |
Agent model provider: builtin (default, Microsoft's AOAI deployment via APIM, requires az login) | github (user's Copilot subscription, requires Copilot login) |
agent.sessionStyle |
string | oneshot |
Agent interaction mode: oneshot (single plan, then stop) or interactive (multi-turn) |
agent.interactive.verbose |
bool | false |
In interactive mode, also show internal tool details (getcommand / find* args and output), not just shell commands. Off by default to keep the session clean |
agent.trace.enabled |
bool | false |
Write a JSONL trace of each agent session (events, tool I/O) for local debugging/evaluation |
agent.trace.path |
string | ~/.azclips/trace |
Directory for agent trace files (used when agent.trace.enabled is true; created on first write) |
completion.enabled |
bool | true |
Enable az shell tab-completion; set false to stop suggestions even while the completion script stays sourced |
extensions.resources.arm.apiVersionOverride |
string | (empty) | Override ARM API version |
clients.cli.output.format |
string | json |
Default --output format when the flag isn't passed: json, jsonc, table, tsv, yaml, yamlc. jsonc/yamlc are the colorized variants, subject to core.output.color's gating. table/tsv drop nested object/array columns entirely (matches classic az). --output overrides this per invocation. |
clients.cli.output.simpleFormat |
string | tsv |
Default --output format for scalar (string/number/bool/null) results, e.g. after a --query that narrows to a single field. Same allowed values as clients.cli.output.format; that key still governs object/array results. --output overrides both. |
defaults.group |
string | (empty) | Default resource group |
defaults.location |
string | (empty) | Default location |
defaults.web |
string | (empty) | Default web app name |
defaults.vm |
string | (empty) | Default VM name |
defaults.vmss |
string | (empty) | Default VMSS name |
defaults.acr |
string | (empty) | Default ACR name |
CLI usage
core.logging.level controls runtime host logging verbosity in CLI sessions. Use --debug to force debug-level output for a single invocation; this override does not persist to config.
Stream routing
az follows the POSIX/GNU convention shared with every Azure-family and general-purpose CLI (Azure CLI Python, Az PowerShell, AWS CLI, git, kubectl, docker, terraform):
- stdout — command results only (JSON payloads, table rows, resource IDs). Safe to pipe.
- stderr — every diagnostic level:
error,warn,info,verbose,debug. Each line is prefixed withLEVEL:(uppercase word, single colon, single space) — matching Azure CLI Python'sWARNING:output, the Pythonloggingdefault formatter, and the way the PowerShell host renderscmdlet.WriteWarning(...).
Because diagnostics never touch stdout, az foo --output json 2>/dev/null stays parseable even when warnings fire mid-command.
The default level is warn — matches Azure CLI Python (console default Warning) and Az PowerShell (effective Warning + Error baseline). Under warn, warn/error surface on stderr and info/verbose/debug stay hidden; --debug (or core.logging.level=debug) opens the full stream.
Use explicit parameter names for CLI config commands:
--keyfor configuration key--valuefor configuration value
Get configuration values or sections
# Retrieve a single key
az config get --key core.logging.level
# Output: core.logging.level = warn [default]
# Retrieve a section (text output)
az config get --key core
# Example output:
# logging.level = warn
# engine.extensionIndexCacheSize = 512
# http.maxRetries = 3
# http.maxRetriesFor429 = 5
# Retrieve a subsection as JSON
az config get --key core.logging --json
# Example output:
# {
# "level": "warn"
# }
# Retrieve a section as nested JSON
az config get --key core --json
Set a configuration value
# Set a key
az config set --key core.logging.level --value debug
# Set with force (allows unknown keys)
az config set --key core.logging.level --value debug --force
# Output: Set core.logging.level = debug
List all configuration
# List user config only
az config list
# List with defaults (shows all keys with their current values)
az config list --all
# Output as JSON
az config list --all --json
Delete a configuration value
# Delete a key
az config delete --key core.logging.level
# Delete with force (allows unknown keys)
az config delete --key core.logging.level --force
# Output: Deleted core.logging.level
View schema information
# Output schema metadata as JSON
az config info
# Output only key names (JSON array)
az config info --keys-only
Telemetry
The Azure CLI preview sends usage telemetry by default. Telemetry is controlled by the telemetry.enabled key. AI-based error recovery records its own usage telemetry, which this key also controls. For more information about what AI-based error recovery collects, see What data is used and collected?.
Check the current setting:
az config get --key telemetry.enabled
Turn telemetry off:
az config set --key telemetry.enabled --value false
Turn telemetry back on:
az config set --key telemetry.enabled --value true
Environment variable mappings
You can override configuration using environment variables:
| Environment Variable | Maps to |
|---|---|
AZCLIPS_LOG_LEVEL |
core.logging.level |
Configuration file location
Configuration is stored at:
- Windows:
%USERPROFILE%\.azclips\config.json - Linux/macOS:
$HOME/.azclips/config.json
Verification
1) Run defaults resolver test
dotnet test tests/Cli.Tests/Cli.Tests.csproj -c Release --filter "FullyQualifiedName~ConfigurationServiceTests.ResolveDefaultParameterAsync_ShouldReturnDefaultsValue_WhenConfigured"
Expected result:
defaults.*values are resolved for parameter defaults when configured
2) Optional full config regression pass
dotnet test tests/Cli.Tests/Cli.Tests.csproj -c Release
This confirms defaults handling and command-surface regressions as a bundle.
Examples
Workflow: Enable debug logging
az config set --key core.logging.level --value debug --force
az config get --key core.logging.level
Workflow: Check all settings with defaults
az config list --all
Workflow: Reset to defaults
# Delete all user-set config
az config list | grep -v '\[default\]' | awk '{print $1}' | while read key; do
az config delete --key "$key" --force
done