Démarrage rapide : Créer une application Python avec Azure App Configuration

Article
12/18/2024

Dans ce guide de démarrage rapide, vous utilisez le fournisseur Python pour Azure App Configuration afin de centraliser le stockage et la gestion des paramètres d’une application à l’aide de la bibliothèque de client du fournisseur Python Azure App Configuration.

Le fournisseur Python App Configuration est une bibliothèque qui s’exécute sur le SDK Azure pour Python et aide les développeurs Python à consommer facilement le service App Configuration. Il permet d’utiliser les paramètres de configuration comme un dictionnaire.

Prérequis

Compte Azure avec un abonnement actif. Créez-en un gratuitement.
Un magasin App Configuration. Créez un magasin.
Python 3.8 ou version ultérieure : pour plus d’informations sur la configuration de Python sur Windows, consultez la documentation de Python sur Windows

Ajouter des clés-valeurs

Ajoutez les valeurs de clés suivantes au magasin App Configuration. Pour plus d’informations sur l’ajout de clés-valeurs à un magasin avec le Portail Azure ou la CLI, consultez Créer une clé-valeur.

Clé	Valeur	Étiquette	Type de contenu
message	Bonjour	Laissez ce champ vide	Laissez ce champ vide
test.message	Test Hello	Laissez ce champ vide	Laissez ce champ vide
my_json	{"key":"value"}	Laissez ce champ vide	application/json

Applications console

Dans cette section, vous allez créer une application console et charger des données à partir de votre magasin App Configuration.

Se connecter à App Configuration

Créez un répertoire pour le projet nommé app-configuration-quickstart.
```
mkdir app-configuration-quickstart
```
Basculez vers le répertoire app-configuration-quickstart.
```
cd app-configuration-quickstart
```
Installez le fournisseur Azure App Configuration à l’aide de la commande pip install.
```
pip install azure-appconfiguration-provider
```

Créez un fichier appelé app-configuration-quickstart.py dans le répertoire app-configuration-quickstart, puis ajoutez le code suivant :

Microsoft Entra ID (recommandé)
Chaîne de connexion

Vous utilisez le DefaultAzureCredential pour vous authentifier auprès de votre magasin App Configuration. Suivez les instructions pour attribuer à votre identifiant le rôle de lecteur de données de configuration de l'application. Veillez à laisser suffisamment de temps pour que l’autorisation se propage avant d’exécuter votre 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))

Exécution de l'application

Définissez une variable d’environnement.
- Microsoft Entra ID (recommandé)
- Chaîne de connexion
Définissez la variable d’environnement nommée AZURE_APPCONFIG_ENDPOINT sur le point de terminaison de votre magasin App Configuration qui se trouve sous la Vue d’ensemble de votre magasin dans le Portail Azure.

Si vous utilisez l’invite de commandes Windows, exécutez la commande suivante et redémarrez l’invite pour que la modification soit prise en compte :
```
setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
```
Si vous utilisez PowerShell, utilisez la commande suivante :
```
$Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
```
Si vous utilisez macOS ou Linux, exécutez la commande suivante :
```
export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
```
Définissez la variable d’environnement nommée AZURE_APPCONFIG_CONNECTION_STRING sur la chaîne de connexion en lecture seule de votre magasin App Configuration qui se trouve sous Clés d’accès de votre magasin dans le Portail Azure.

Si vous utilisez l’invite de commandes Windows, exécutez la commande suivante et redémarrez l’invite pour que la modification soit prise en compte :
```
setx AZURE_APPCONFIG_CONNECTION_STRING "<connection-string-of-your-app-configuration-store>"
```
Si vous utilisez PowerShell, utilisez la commande suivante :
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
Si vous utilisez macOS ou Linux, exécutez la commande suivante :
```
export AZURE_APPCONFIG_CONNECTION_STRING='<connection-string-of-your-app-configuration-store>'
```
Après la définition correcte de la variable d’environnement, exécutez la commande suivante afin d’effectuer l’exécution locale de l’application :
```
python app-configuration-quickstart.py
```
Vous devez normalement voir la sortie suivante.
```
Hello
value
Hello test
message found: True
test.message found: False
```

Applications web

Le fournisseur App Configuration charge des données dans un objet Mapping, accessible en tant que dictionnaire, qui peut être utilisé en combinaison avec la configuration existante de différents frameworks Python. Cette section montre comment utiliser le fournisseur App Configuration dans des frameworks web populaires comme Flask et Django.

Flask
Django

Vous pouvez utiliser Azure App Configuration dans vos applications web Flask existantes en mettant à jour sa configuration intégrée. Pour ce faire, passez votre objet fournisseur App Configuration à la fonction update de votre instance d’application Flask dans 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")

Vous pouvez utiliser Azure App Configuration dans vos applications web Django existantes en ajoutant les lignes de code suivantes dans votre fichier settings.py.

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

Pour accéder aux paramètres de configuration individuels dans les vues Django, vous pouvez les référencer à partir de l’objet fournisseur créé dans les paramètres Django. Par exemple, dans views.py :

# Import Django settings
from django.conf import settings

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

Vous trouverez des exemples de code complets sur l’utilisation d’Azure App Configuration dans les applications web Python dans le dépôt GitHub Azure App Configuration.

Nettoyer les ressources

Si vous ne souhaitez plus utiliser les ressources créées dans cet article, supprimez le groupe de ressources que vous avez créé ici afin d’éviter des frais.

Important

La suppression d’un groupe de ressources est irréversible. Le groupe de ressources et toutes les ressources qu’il contient sont supprimés définitivement. Veillez à ne pas supprimer accidentellement les mauvaises ressources ou le mauvais groupe de ressources. Si vous avez créé les ressources pour cet article dans un groupe de ressources contenant d’autres ressources que vous souhaitez conserver, supprimez chaque ressource individuellement à partir de son volet, au lieu de supprimer l’intégralité du groupe de ressources.

Connectez-vous au portail Azure, puis sélectionnez Groupes de ressources.
Dans la zone Filtrer par nom, entrez le nom de votre groupe de ressources.
Dans la liste de résultats, sélectionnez le nom du groupe de ressources pour afficher une vue d’ensemble.
Sélectionnez Supprimer le groupe de ressources.
Vous êtes invité à confirmer la suppression du groupe de ressources. Entrez le nom de votre groupe de ressources à confirmer, puis sélectionnez Supprimer.

Après quelques instants, le groupe de ressources et toutes ses ressources sont supprimés.

Étapes suivantes

Dans ce guide de démarrage rapide, vous avez créé un magasin App Configuration et découvert comment accéder aux paires clé/valeur à partir d’une application Python.

Pour obtenir des exemples de code supplémentaires, visitez :

Exemple Django Exemple Flask Fournisseur Python Azure App Configuration

Partager via