config.yml

### YamlMime:AzureCLIGroup
uid: az_config
name: az config
summary: |-
  Manage Azure CLI configuration.
description: |-
  Available since Azure CLI 2.10.0.
status: Experimental
isExperimental: true
previewOrExperimentalInfo: 'This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus'
sourceType: Core
directCommands:
- uid: az_config_get
  name: az config get
  summary: |-
    Get a configuration.
  status: Experimental
  isExperimental: true
  previewOrExperimentalInfo: "Command group 'config' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/config/_help.py
  syntax: >-
    az config get [--local]
                  []
  examples:
  - summary: |-
      Get all configurations.
    syntax: az config get
  - summary: |-
      Get configurations in `core` section.
    syntax: az config get core
  - summary: |-
      Get the configuration of key `core.no_color`.
    syntax: az config get core.no_color
  optionalParameters:
  - name: --local
    defaultValue: "False"
    summary: |-
      Include local configuration. Scan from the working directory up to the root drive, then the global configuration and return the first occurrence.
  - name: <KEY>
    summary: |-
      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.
    groupName: Positional
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_config_set
  name: az config set
  summary: |-
    Set a configuration.
  description: |-
    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`.
  status: Experimental
  isExperimental: true
  previewOrExperimentalInfo: "Command group 'config' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/config/_help.py
  syntax: >-
    az config set [--local]
                  []
  examples:
  - summary: |-
      Disable color with `core.no_color`.
    syntax: az config set core.no_color=true
  - summary: |-
      Hide warnings and only show errors with `core.only_show_errors`.
    syntax: az config set core.only_show_errors=true
  - summary: |-
      Turn on client-side telemetry.
    syntax: az config set core.collect_telemetry=true
  - summary: |-
      Turn on file logging and set its location.
    syntax: >-
      az config set logging.enable_log_file=true

      az config set logging.log_dir=~/az-logs
  - summary: |-
      Set the default location to `westus2` and default resource group to `myRG`.
    syntax: az config set defaults.location=westus2 defaults.group=MyResourceGroup
  - summary: |-
      Set the default resource group to `myRG` on a local scope.
    syntax: az config set defaults.group=myRG --local
  optionalParameters:
  - name: --local
    defaultValue: "False"
    summary: |-
      Set as a local configuration in the working directory.
  - name: <KEY_VALUE>
    summary: |-
      Space-separated configurations in the form of `<section>.<key>=<value>`.
    groupName: Positional
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_config_unset
  name: az config unset
  summary: |-
    Unset a configuration.
  status: Experimental
  isExperimental: true
  previewOrExperimentalInfo: "Command group 'config' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus"
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/config/_help.py
  syntax: >-
    az config unset [--local]
                    []
  examples:
  - summary: |-
      Unset the configuration of key `core.no_color`.
    syntax: az config unset core.no_color
  optionalParameters:
  - name: --local
    defaultValue: "False"
    summary: |-
      Include local configuration. Scan from the working directory up to the root drive, then the global configuration and unset the first occurrence.
  - name: <KEY>
    summary: |-
      The configuration to unset, in the form of `<section>.<key>`.
    groupName: Positional
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
commands:
- az_config_get
- az_config_param-persist
- az_config_param-persist_delete
- az_config_param-persist_off
- az_config_param-persist_on
- az_config_param-persist_show
- az_config_set
- az_config_unset
metadata:
  ms.date: 12/04/2024
  description: Available since Azure CLI 2.10.0.