How to use the command 'az config' (with examples)

The az config command is used to manage Azure CLI configuration. It allows you to view, set, and unset different configurations. This article will illustrate each of the different use cases of this command.

Use case 1: Print all configurations

Code:

az config get

Motivation: The motivation for using this example is to print all the configurations set in the Azure CLI, including the default values for each configuration.

Explanation: No argument is provided in this command. It simply displays all the configurations and their values, including the default values.

Example output:

{
  "core": {
    "only_show_errors": false,
    "output": "json",
    "collect_telemetry": true
  },
  "managed_services": {
    "open_browser": true
  }
}

Use case 2: Print configurations for a specific section

Code:

az config get core

Motivation: The motivation for using this example is to print only the configurations for a specific section, such as the “core” section.

Explanation: In this command, the argument provided is the section_name. By specifying the section_name, you can limit the output to only the configurations in that particular section.

Example output:

{
  "core": {
    "only_show_errors": false,
    "output": "json",
    "collect_telemetry": true
  }
}

Use case 3: Set a configuration

Code:

az config set core.only_show_errors=true

Motivation: The motivation for using this example is to set a specific configuration to a desired value. This can be useful for customizing the behavior of the Azure CLI.

Explanation: In this command, the argument provided is the configuration_name=value. By specifying the configuration_name and its corresponding value, you can set a specific configuration to the desired value.

Example output:

{
  "core": {
    "only_show_errors": true,
    "output": "json",
    "collect_telemetry": true
  }
}

Use case 4: Unset a configuration

Code:

az config unset core.only_show_errors

Motivation: The motivation for using this example is to remove a specific configuration from the Azure CLI. This can be useful if you want to revert back to the default value or remove a custom configuration.

Explanation: In this command, the argument provided is the configuration_name. By specifying the configuration_name, you can unset and remove a specific configuration from the Azure CLI.

Example output:

{
  "core": {
    "output": "json",
    "collect_telemetry": true
  }
}

Conclusion:

The az config command provides a convenient way to manage Azure CLI configuration. Whether you want to view all configurations, print configurations for a specific section, set a configuration, or unset a configuration, this command offers the necessary functionality. Use the examples provided to customize your Azure CLI experience to suit your needs.