How to use the command `az appconfig` (with examples)
The az appconfig command is used to manage App configurations on Azure. It is a part of the azure-cli (also known as az). This command allows users to create, delete, list, show properties, and update App Configurations in Azure.
Use case 1: Create an App Configuration
Code:
az appconfig create --name <name> --resource-group <group_name> --location <location>
Motivation: Creating an App Configuration is necessary when you want to store and manage configuration settings for your Azure applications. By using this command, you can create a new App Configuration with a specified name and add it to a specific resource group and location.
Explanation:
--name: Specifies the name of the App Configuration that will be created.--resource-group: Specifies the name of the resource group where the App Configuration will be added.--location: Specifies the Azure region where the App Configuration will be created.
Example output:
{
"etag": "W/\"xxx\"",
"id": "/subscriptions/xxx/resourceGroups/group_name/providers/Microsoft.AppConfiguration/configurationStores/name",
"location": "xxx",
"name": "name",
"primaryReadEndpoint": "https://name.azconfig.io",
"primaryWriteEndpoint": "https://name.azconfig.io",
"provisioningState": "Succeeded",
"resourceGroup": "group_name",
"sku": {
"name": "Free"
},
"tags": {},
"type": "Microsoft.AppConfiguration/ConfigurationStores"
}
Use case 2: Delete a specific App Configuration
Code:
az appconfig delete --resource-group <rg_name> --name <appconfig_name>
Motivation: If you need to remove an unnecessary or outdated App Configuration from Azure, you can use this command to delete it. It is important to specify the resource group and the name of the App Configuration to ensure the correct one is deleted.
Explanation:
--resource-group: Specifies the name of the resource group where the App Configuration is located.--name: Specifies the name of the App Configuration that will be deleted.
Example output:
No output. The command will complete without any errors if the App Configuration is successfully deleted.
Use case 3: List all App Configurations under the current subscription
Code:
az appconfig list
Motivation: When you have multiple App Configurations in your Azure subscription, it can be useful to list them all to get an overview of their names, locations, and resource groups. This command allows you to retrieve a list of all the App Configurations under the current subscription.
Explanation: No arguments needed for this command.
Example output:
[
{
"id": "/subscriptions/xxx/resourceGroups/group_name/providers/Microsoft.AppConfiguration/configurationStores/name1",
"location": "xxx",
"name": "name1",
"provisioningState": "Succeeded",
"resourceGroup": "group_name",
"sku": {
"name": "Free"
},
"tags": {},
"type": "Microsoft.AppConfiguration/ConfigurationStores"
},
{
"id": "/subscriptions/xxx/resourceGroups/group_name/providers/Microsoft.AppConfiguration/configurationStores/name2",
"location": "xxx",
"name": "name2",
"provisioningState": "Succeeded",
"resourceGroup": "group_name",
"sku": {
"name": "Free"
},
"tags": {},
"type": "Microsoft.AppConfiguration/ConfigurationStores"
},
...
]
Use case 4: List all App Configurations under a specific resource group
Code:
az appconfig list --resource-group <rg_name>
Motivation: If you want to retrieve a list of App Configurations under a specific resource group, you can use this command. It allows you to filter the results and only display App Configurations from the specified resource group.
Explanation:
--resource-group: Specifies the name of the resource group for which you want to list the App Configurations.
Example output:
[
{
"id": "/subscriptions/xxx/resourceGroups/group_name/providers/Microsoft.AppConfiguration/configurationStores/name1",
"location": "xxx",
"name": "name1",
"provisioningState": "Succeeded",
"resourceGroup": "group_name",
"sku": {
"name": "Free"
},
"tags": {},
"type": "Microsoft.AppConfiguration/ConfigurationStores"
},
{
"id": "/subscriptions/xxx/resourceGroups/group_name/providers/Microsoft.AppConfiguration/configurationStores/name2",
"location": "xxx",
"name": "name2",
"provisioningState": "Succeeded",
"resourceGroup": "group_name",
"sku": {
"name": "Free"
},
"tags": {},
"type": "Microsoft.AppConfiguration/ConfigurationStores"
},
...
]
Use case 5: Show properties of an App Configuration
Code:
az appconfig show --name <appconfig_name>
Motivation: To retrieve the properties and details of a specific App Configuration, you can use this command. It allows you to view information such as the name, location, primary endpoints, provisioning state, resource group, SKU, tags, and type of the App Configuration.
Explanation:
--name: Specifies the name of the App Configuration for which you want to show properties.
Example output:
{
"etag": "W/\"xxx\"",
"id": "/subscriptions/xxx/resourceGroups/group_name/providers/Microsoft.AppConfiguration/configurationStores/name",
"location": "xxx",
"name": "name",
"primaryReadEndpoint": "https://name.azconfig.io",
"primaryWriteEndpoint": "https://name.azconfig.io",
"provisioningState": "Succeeded",
"resourceGroup": "group_name",
"sku": {
"name": "Free"
},
"tags": {},
"type": "Microsoft.AppConfiguration/ConfigurationStores"
}
Use case 6: Update a specific App Configuration
Code:
az appconfig update --resource-group <rg_name> --name <appconfig_name>
Motivation: When you need to modify the properties or settings of an existing App Configuration, you can use this command to update it. By specifying the resource group and the name of the App Configuration, you can ensure that the correct one is updated.
Explanation:
--resource-group: Specifies the name of the resource group where the App Configuration is located.--name: Specifies the name of the App Configuration that will be updated.
Example output:
{
"etag": "W/\"xxx\"",
"id": "/subscriptions/xxx/resourceGroups/group_name/providers/Microsoft.AppConfiguration/configurationStores/name",
"location": "xxx",
"name": "name",
"primaryReadEndpoint": "https://name.azconfig.io",
"primaryWriteEndpoint": "https://name.azconfig.io",
"provisioningState": "Succeeded",
"resourceGroup": "group_name",
"sku": {
"name": "Free"
},
"tags": {},
"type": "Microsoft.AppConfiguration/ConfigurationStores"
}
Conclusion:
The az appconfig command is a powerful tool for managing App Configurations on Azure. It provides various functionalities to create, delete, list, show properties, and update App Configurations effectively. By using the provided examples, users can easily perform these actions to meet their configuration management needs.
