Schnellstart: Erstellen einer Python-App mit Azure App Configuration

Artikel
12/18/2024

In dieser Schnellstartanleitung verwenden Sie den Python-Anbieter von Azure App Configuration zum Zentralisieren der Speicherung und Verwaltung von Anwendungseinstellungen mithilfe der Clientbibliothek des Python-Anbieters von Azure App Configuration.

Der Python-Anbieter von App Configuration ist eine Bibliothek, die auf dem Azure SDK für Python ausgeführt wird und Python-Entwicklern hilft, den Dienst App Configuration problemlos zu nutzen. Er ermöglicht die Verwendung von Konfigurationseinstellungen wie ein Wörterbuch.

Voraussetzungen

Ein Azure-Konto mit einem aktiven Abonnement. Erstellen Sie ein kostenloses Konto.
Ein App Configuration-Speicher. Erstellen Sie einen Speicher.
Python 3.8 oder höher: Informationen zum Einrichten von Python unter Windows finden Sie in der Dokumentation zu Python unter Windows.

Schlüsselwerte hinzufügen

Fügen Sie dem App Configuration-Speicher die folgenden Schlüsselwerte hinzu. Weitere Informationen zum Hinzufügen von Schlüssel-Wert-Paaren zu einem Speicher mithilfe des Azure-Portals oder der CLI finden Sie unter Erstellen eines Schlüssel-Wert-Paars.

Schlüssel	Wert	Bezeichnung	Inhaltstyp
Nachricht	Hello	Leer lassen	Leer lassen
test.message	Hello test	Leer lassen	Leer lassen
my_json	{"key":"value"}	Leer lassen	Anwendung/json

Konsolenanwendungen

In diesem Abschnitt werden Sie eine Konsolenanwendung erstellen und laden Daten aus Ihrem App Configuration-Speicher.

Herstellen einer Verbindung mit App Configuration

Erstellen Sie ein neues Verzeichnis für das Projekt mit dem Namen app-configuration-quickstart.
```
mkdir app-configuration-quickstart
```
Wechseln Sie zum neu erstellten Verzeichnis app-configuration-quickstart.
```
cd app-configuration-quickstart
```
Installieren Sie den Azure App Configuration-Anbieter mit dem Befehl pip install.
```
pip install azure-appconfiguration-provider
```

Erstellen Sie im Verzeichnis app-configuration-quickstart eine neue Datei mit dem Namen app-configuration-quickstart.py, und fügen Sie ihr den folgenden Code hinzu:

Microsoft Entra ID (empfohlen)
Verbindungszeichenfolge

Sie verwenden die DefaultAzureCredential für die Authentifizierung beim App Configuration-Speicher. Befolgen Sie die Anweisungen, um Ihre Anmeldeinformationen der Rolle App Configuration-Datenleser zuzuweisen. Achten Sie darauf, ausreichend Zeit für die Verteilung der Berechtigung zu warten, bevor Sie Ihre Anwendung ausführen.

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))

Ausführen der Anwendung

Legen Sie eine Umgebungsvariable fest.
- Microsoft Entra ID (empfohlen)
- Verbindungszeichenfolge
Legen Sie die Umgebungsvariable AZURE_APPCONFIG_ENDPOINT auf den Endpunkt Ihres App Configuration-Speichers fest, den Sie in der Übersicht Ihres Speichers im Azure-Portal finden.

Führen Sie bei Verwendung einer Windows-Eingabeaufforderung den folgenden Befehl aus, und starten Sie die Eingabeaufforderung neu, damit die Änderung wirksam wird:
```
setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
```
Wenn Sie PowerShell verwenden, und führen Sie den folgenden Befehl aus:
```
$Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
```
Führen Sie bei Verwendung von macOS oder Linux den folgenden Befehl aus:
```
export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
```
Legen Sie die Umgebungsvariable AZURE_APPCONFIG_CONNECTION_STRING auf die schreibgeschützte Verbindungszeichenfolge Ihres App Configuration-Speichers fest, die Sie unter Zugriffsschlüssel Ihres Speichers im Azure-Portal finden.

Führen Sie bei Verwendung einer Windows-Eingabeaufforderung den folgenden Befehl aus, und starten Sie die Eingabeaufforderung neu, damit die Änderung wirksam wird:
```
setx AZURE_APPCONFIG_CONNECTION_STRING "<connection-string-of-your-app-configuration-store>"
```
Wenn Sie PowerShell verwenden, und führen Sie den folgenden Befehl aus:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
Führen Sie bei Verwendung von macOS oder Linux den folgenden Befehl aus:
```
export AZURE_APPCONFIG_CONNECTION_STRING='<connection-string-of-your-app-configuration-store>'
```
Nachdem die Umgebungsvariable ordnungsgemäß festgelegt wurde, führen Sie den folgenden Befehl aus, um die App lokal auszuführen:
```
python app-configuration-quickstart.py
```
Die folgende Ausgabe wird angezeigt.
```
Hello
value
Hello test
message found: True
test.message found: False
```

Webanwendungen

Der App Configuration-Anbieter lädt Daten in ein Mapping-Objekt, das als Wörterbuch zugänglich ist und in Kombination mit der vorhandenen Konfiguration verschiedener Python-Frameworks verwendet werden kann. Dieser Abschnitt zeigt, wie Sie den App Configuration-Anbieter in beliebten Webframeworks wie Flask und Django verwenden.

Flask
Django

Sie können Azure App Configuration in Ihren vorhandenen Flask-Web-Apps verwenden, indem Sie deren integrierte Konfiguration aktualisieren. Hierzu können Sie Ihr App Configuration-Anbieterobjekt an die update-Funktion Ihrer Flask-App-Instanz in app.py übergeben:

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")

Sie können Azure App Configuration in Ihren vorhandenen Django-Web-Apps verwenden, indem Sie Ihrer settings.py-Datei die folgenden Codezeilen hinzufügen

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

Um auf einzelne Konfigurationseinstellungen in den Django-Ansichten zuzugreifen, können Sie über das in den Django-Einstellungen erstellte Anbieterobjekt auf diese verweisen. Gehen Sie beispielsweise in views.py folgendermaßen vor:

# Import Django settings
from django.conf import settings

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

Vollständige Codebeispiele zur Verwendung Azure App Configuration in Python-Webanwendungen finden Sie im GitHub-Repository für Azure App Configuration.

Bereinigen von Ressourcen

Wenn Sie die in diesem Artikel erstellten Ressourcen nicht mehr verwenden möchten, löschen Sie die erstellte Ressourcengruppe, um Kosten zu vermeiden.

Wichtig

Das Löschen einer Ressourcengruppe kann nicht rückgängig gemacht werden. Die Ressourcengruppe und alle darin enthaltenen Ressourcen werden unwiderruflich gelöscht. Achten Sie daher darauf, dass Sie nicht versehentlich die falsche Ressourcengruppe oder die falschen Ressourcen löschen. Falls Sie die Ressourcen für diesen Artikel in einer Ressourcengruppe erstellt haben, die andere beizubehaltende Ressourcen enthält, löschen Sie die Ressourcen einzeln über den entsprechenden Bereich, statt die Ressourcengruppe zu löschen.

Melden Sie sich beim Azure-Portal an, und klicken Sie auf Ressourcengruppen.
Geben Sie im Feld Nach Name filtern den Namen Ihrer Ressourcengruppe ein.
Wählen Sie in der Ergebnisliste den Ressourcengruppennamen aus, um eine Übersicht anzuzeigen.
Wählen Sie die Option Ressourcengruppe löschen.
Sie werden aufgefordert, das Löschen der Ressourcengruppe zu bestätigen. Geben Sie zur Bestätigung den Namen Ihrer Ressourcengruppe ein, und klicken Sie auf Löschen.

Daraufhin werden die Ressourcengruppe und alle darin enthaltenen Ressourcen gelöscht.

Nächste Schritte

In dieser Schnellstartanleitung haben Sie einen neuen App Configuration-Speicher erstellt und gelernt, wie Sie aus einer Python-App auf Schlüsselwerte zugreifen.

Weitere Codebeispiele finden Sie unter:

Beispiel für Django Beispiel für Flask Python-Anbieter für Azure App Configuration

Freigeben über