Quickstart: Create a Python app with Azure App Configuration

Article
12/20/2024

In this quickstart, you will use the Python provider for Azure App Configuration to centralize storage and management of application settings using the Azure App Configuration Python provider client library.

The Python App Configuration provider is a library running on top of the Azure SDK for Python, helping Python developers easily consume the App Configuration service. It enables configuration settings to be used like a dictionary.

Prerequisites

An Azure account with an active subscription. Create a trial subscription.
An App Configuration store. Create a store.
Python 3.8 or later - for information on setting up Python on Windows, see the Python on Windows documentation

Add key-values

Add the following key-values to the App Configuration store. For more information about how to add key-values to a store using the Azure portal or the CLI, go to Create a key-value.

Key	Value	Label	Content type
message	Hello	Leave empty	Leave empty
test.message	Hello test	Leave empty	Leave empty
my_json	{"key":"value"}	Leave empty	application/json

Console applications

In this section, you will create a console application and load data from your App Configuration store.

Connect to App Configuration

Create a new directory for the project named app-configuration-quickstart.
```
mkdir app-configuration-quickstart
```
Switch to the newly created app-configuration-quickstart directory.
```
cd app-configuration-quickstart
```
Install the Azure App Configuration provider by using the pip install command.
```
pip install azure-appconfiguration-provider
```

Create a new file called app-configuration-quickstart.py in the app-configuration-quickstart directory and add the following code:

Microsoft Entra ID (recommended)
Connection string

You use the DefaultAzureCredential to authenticate to your App Configuration store. Follow the instructions to assign your credential the App Configuration Data Reader role. Be sure to allow sufficient time for the permission to propagate before running your application.

from azure.appconfiguration.provider import (
    load,
    SettingSelector
)
from azure.identity import DefaultAzureCredential
import os

endpoint = os.environ.get("AZURE_APPCONFIG_ENDPOINT")

# Connect to Azure App Configuration using a connection string.
config = load(endpoint=endpoint, credential=credential)
credential = DefaultAzureCredential()

# Find the key "message" and print its value.
print(config["message"])
# Find the key "my_json" and print the value for "key" from the dictionary.
print(config["my_json"]["key"])

# Connect to Azure App Configuration using a connection string and trimmed key prefixes.
trimmed = {"test."}
config = load(endpoint=endpoint, credential=credential, trim_prefixes=trimmed)
# From the keys with trimmed prefixes, find a key with "message" and print its value.
print(config["message"])

# Connect to Azure App Configuration using SettingSelector.
selects = {SettingSelector(key_filter="message*", label_filter="\0")}
config = load(endpoint=endpoint, credential=credential, selects=selects)

# Print True or False to indicate if "message" is found in Azure App Configuration.
print("message found: " + str("message" in config))
print("test.message found: " + str("test.message" in config))

from azure.appconfiguration.provider import (
    load,
    SettingSelector
)
import os

connection_string = os.environ.get("AZURE_APPCONFIG_CONNECTION_STRING")

# Connect to Azure App Configuration using a connection string.
config = load(connection_string=connection_string)

# Find the key "message" and print its value.
print(config["message"])
# Find the key "my_json" and print the value for "key" from the dictionary.
print(config["my_json"]["key"])

# Connect to Azure App Configuration using a connection string and trimmed key prefixes.
trimmed = {"test."}
config = load(connection_string=connection_string, trim_prefixes=trimmed)
# From the keys with trimmed prefixes, find a key with "message" and print its value.
print(config["message"])

# Connect to Azure App Configuration using SettingSelector.
selects = {SettingSelector(key_filter="message*", label_filter="\0")}
config = load(connection_string=connection_string, selects=selects)

# Print True or False to indicate if "message" is found in Azure App Configuration.
print("message found: " + str("message" in config))
print("test.message found: " + str("test.message" in config))

Run the application

Set an environment variable.
- Microsoft Entra ID (recommended)
- Connection string
Set the environment variable named AZURE_APPCONFIG_ENDPOINT to the endpoint of your App Configuration store found under the Overview of your store in the Azure portal.

If you use the Windows command prompt, run the following command and restart the command prompt to allow the change to take effect:
```
setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
```
If you use PowerShell, run the following command:
```
$Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
```
If you use macOS or Linux, run the following command:
```
export AZURE_APPCONFIG_ENDPOINT='endpoint-of-your-app-configuration-store'
```
Set the environment variable named AZURE_APPCONFIG_CONNECTION_STRING to the read-only connection string of your App Configuration store found under Access keys of your store in the Azure portal.

If you use the Windows command prompt, run the following command and restart the command prompt to allow the change to take effect:
```
setx AZURE_APPCONFIG_CONNECTION_STRING "connection-string-of-your-app-configuration-store"
```
If you use PowerShell, run the following command:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
If you use macOS or Linux, run the following command:
```
export AZURE_APPCONFIG_CONNECTION_STRING='connection-string-of-your-app-configuration-store'
```
After the environment variable is properly set, run the following command to run the app locally:
```
python app-configuration-quickstart.py
```
You should see the following output:
```
Hello
value
Hello test
message found: True
test.message found: False
```

Web applications

The App Configuration provider loads data into a Mapping object, accessible as a dictionary, which can be used in combination with the existing configuration of various Python frameworks. This section shows how to use the App Configuration provider in popular web frameworks like Flask and Django.

Flask
Django

You can use Azure App Configuration in your existing Flask web apps by updating its in-built configuration. You can do this by passing your App Configuration provider object to the update function of your Flask app instance in app.py:

azure_app_config = load(endpoint=os.environ.get("AZURE_APPCONFIG_ENDPOINT"), credential=credential)

# NOTE: This will override all existing configuration settings with the same key name.
app.config.update(azure_app_config)

# Access a configuration setting directly from within Flask configuration
message = app.config.get("message")

You can use Azure App Configuration in your existing Django web apps by adding the following lines of code into your settings.py file

AZURE_APPCONFIGURATION = load(endpoint=os.environ.get("AZURE_APPCONFIG_ENDPOINT"), credential=credential)

To access individual configuration settings in the Django views, you can reference them from the provider object created in Django settings. For example, in views.py:

# Import Django settings
from django.conf import settings

# Access a configuration setting from Django settings instance.
MESSAGE = settings.AZURE_APPCONFIGURATION.get("message")

Full code samples on how to use Azure App Configuration in Python web applications can be found in the Azure App Configuration GitHub repo.

Clean up resources

If you don't want to continue using the resources created in this article, delete the resource group you created here to avoid charges.

Important

Deleting a resource group is irreversible. The resource group and all the resources in it are permanently deleted. Ensure that you don't accidentally delete the wrong resource group or resources. If you created the resources for this article inside a resource group that contains other resources you want to keep, delete each resource individually from its respective pane instead of deleting the resource group.

Sign in to the Azure portal, and select Resource groups.
In the Filter by name box, enter the name of your resource group.
In the result list, select the resource group name to see an overview.
Select Delete resource group.
You're asked to confirm the deletion of the resource group. Enter the name of your resource group to confirm, and select Delete.

After a few moments, the resource group and all its resources are deleted.

Next steps

In this quickstart, you created a new App Configuration store and learned how to access key-values from a Python app.

For additional code samples, visit:

Django Sample Flask Sample Azure App Configuration Python provider