How to Use the Command 'az config' (with Examples)

The az config command is an integral part of the Azure Command-Line Interface (CLI), commonly known as az. This command is used to manage and manipulate different configurations within the Azure CLI, allowing you to tailor and streamline your Azure CLI experience. Whether you need to view, set, or unset configurations, this command lets you customize your CLI environment effortlessly. By using az config, users can optimize their workflow and ensure that their CLI is set up to meet their specific needs and preferences.

Use Case 1: Print All Configurations

Code:

az config get

Motivation:

When working with Azure CLI, it’s often necessary to understand the current configuration setup. You might need to troubleshoot an issue, ensure that your environment is set correctly, or document your existing configuration for future reference. Using the az config get command is a straightforward way to retrieve and display all current configurations. This can be especially useful in a team environment where multiple people might have access to a shared system and need to verify settings for collaboration.

Explanation:

• az: This is the Azure CLI, a tool to manage Azure resources and services directly from the command line.
• config: This specifies that the command is dealing with configuration settings.
• get: This action fetches and displays the current configurations available within your Azure CLI setup.

Example Output:

{
  "defaults": {
    "group": "<YourResourceGroup>",
    "location": "<YourLocation>"
  },
  "logging": {
    "enable": true,
    "level": "info"
  }
}

This output provides a structured view of all configuration settings, showing defaults like resource group and location, as well as logging preferences.

Use Case 2: Print Configurations for a Specific Section

Code:

az config get section_name

Motivation:

Sometimes, you might only be interested in a specific subset of your configurations instead of viewing everything. By targeting a particular section, you can quickly and efficiently retrieve only the relevant details. This is especially useful when you want to ensure that a specific configuration section, such as defaults or logging parameters, is set correctly without sifting through unrelated information.

Explanation:

• az: This is the Azure CLI command.
• config: Specifies that the operation is concerned with configurations.
• get: Initiates a fetch operation to list configuration settings.
• section_name: Represents a placeholder for the actual name of the section you want to query. Replace this with the desired section, such as defaults or logging.

Example Output:

{
  "group": "<YourResourceGroup>",
  "location": "<YourLocation>"
}

Here, the output focuses only on the defaults section, displaying specific defaults set in the CLI.

Use Case 3: Set a Configuration

Code:

az config set configuration_name=value

Motivation:

Adjusting settings to align with your project requirements is crucial in any development and operational environment. The az config set command allows users to modify existing configurations or add new ones, thereby customizing their Azure CLI tool to better fit their tasks. This use case is ideal for setting default resource groups, changing logging levels, or adjusting any other configuration option that can streamline your workflow and improve efficiency.

Explanation:

• az: The Azure Command-Line Interface.
• config: Indicates the configuration domain.
• set: This action sets or updates a particular configuration setting.
• configuration_name=value: Here, configuration_name is the placeholder for the specific configuration you wish to modify, and value is the new value you are assigning to that configuration.

Example Output:

Configuration 'defaults.group' set to '<NewResourceGroup>'. 

This output confirms that the system has successfully set a new default resource group.

Use Case 4: Unset a Configuration

Code:

az config unset configuration_name

Motivation:

There are instances when you need to remove a configuration from your CLI environment, perhaps because it’s no longer relevant or it’s causing conflicts. The az config unset command is designed to delete existing configurations, which can help in maintaining a clean and efficient environment. This is useful when old settings might interfere with new workflows or when you need to reset a particular aspect of your environment to its default state.

Explanation:

• az: Azure CLI is being used here.
• config: This specifies the context is configuration settings.
• unset: This command will remove the specified configuration.
• configuration_name: Represents the specific configuration setting you wish to remove from your CLI setup.

Example Output:

Configuration 'defaults.group' unset.

The output indicates successful removal of the specified configuration, confirming that the CLI will no longer use that particular setting.

Conclusion:

The az config command is a powerful utility in the Azure CLI arsenal, allowing users to view, set, and unset configurations. This level of configurability supports a personalized, efficient workflow and makes managing Azure resources through the CLI a more tailored experience. Understanding how to leverage each of these use cases can significantly enhance your capability to work with Azure services effectively and efficiently.