Quickstart: Een Python-app maken met Azure-app-configuratie

Artikel
12/18/2024

In deze quickstart gebruikt u de Python-provider voor Azure-app Configuratie om de opslag en het beheer van toepassingsinstellingen te centraliseren met behulp van de clientbibliotheek van de Azure-app configuratieclient van de Python-provider.

De Python App Configuration-provider is een bibliotheek die wordt uitgevoerd boven op de Azure SDK voor Python, zodat Python-ontwikkelaars de App Configuration-service eenvoudig kunnen gebruiken. Hiermee kunnen configuratie-instellingen worden gebruikt als een woordenlijst.

Vereisten

Een Azure-account met een actief abonnement. Maak gratis een account.
Een App Configuration-archief. Een winkel maken.
Python 3.8 of hoger: zie de Documentatie voor Python in Windows voor meer informatie over het instellen van Python in Windows

Sleutelwaarden toevoegen

Voeg de volgende sleutelwaarden toe aan het App Configuration-archief. Ga naar Een sleutelwaarde maken voor meer informatie over het toevoegen van sleutelwaarden aan een archief met behulp van Azure Portal of de CLI.

Sleutel	Waarde	Label	Inhoudstype
bericht	Hello (Hallo)	Leeg laten	Leeg laten
test.message	Hallo test	Leeg laten	Leeg laten
my_json	{"key":"value"}	Leeg laten	application/json

Consoletoepassingen

In deze sectie maakt u een consoletoepassing en laadt u gegevens uit uw App Configuration-archief.

Verbinding maken met App Configuration

Maak een nieuwe map voor het project met de naam app-configuration-quickstart.
```
mkdir app-configuration-quickstart
```
Schakel over naar de zojuist gemaakte map app-configuration-quickstart.
```
cd app-configuration-quickstart
```
Installeer de Azure-app Configuration-provider met behulp van de pip install opdracht.
```
pip install azure-appconfiguration-provider
```

Maak een nieuw bestand met de naam app-configuration-quickstart.py in de map app-configuration-quickstart en voeg de volgende code toe:

Microsoft Entra-id (aanbevolen)
Verbindingsreeks

U gebruikt de DefaultAzureCredential app om u te verifiëren bij uw App Configuration-archief. Volg de instructies om uw referenties toe te wijzen aan de rol App Configuration Data Reader . Zorg ervoor dat u voldoende tijd hebt om de machtiging door te geven voordat u de toepassing uitvoert.

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

De toepassing uitvoeren

Stel een omgevingsvariabele in.
- Microsoft Entra-id (aanbevolen)
- Verbindingsreeks
Stel de omgevingsvariabele met de naam AZURE_APPCONFIG_ENDPOINT in op het eindpunt van uw App Configuration-archief in het overzicht van uw winkel in Azure Portal.

Als u de Windows-opdrachtprompt gebruikt, voert u de volgende opdracht uit en start u de opdrachtprompt opnieuw om de wijziging door te voeren:
```
setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
```
Als u PowerShell gebruikt, voert u de volgende opdracht uit:
```
$Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
```
Als u macOS of Linux gebruikt, voert u de volgende opdracht uit:
```
export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
```
Stel de omgevingsvariabele met de naam AZURE_APPCONFIG_CONNECTION_STRING in op de alleen-lezen verbindingsreeks van uw App Configuration-archief onder Toegangssleutels van uw archief in Azure Portal.

Als u de Windows-opdrachtprompt gebruikt, voert u de volgende opdracht uit en start u de opdrachtprompt opnieuw om de wijziging door te voeren:
```
setx AZURE_APPCONFIG_CONNECTION_STRING "<connection-string-of-your-app-configuration-store>"
```
Als u PowerShell gebruikt, voert u de volgende opdracht uit:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
Als u macOS of Linux gebruikt, voert u de volgende opdracht uit:
```
export AZURE_APPCONFIG_CONNECTION_STRING='<connection-string-of-your-app-configuration-store>'
```
Nadat de omgevingsvariabele juist is ingesteld, voert u de volgende opdracht uit om de app lokaal uit te voeren:
```
python app-configuration-quickstart.py
```
U moet de volgende uitvoer zien:
```
Hello
value
Hello test
message found: True
test.message found: False
```

Webtoepassingen

De App Configuration-provider laadt gegevens in een Mapping object, toegankelijk als een woordenlijst, die kan worden gebruikt in combinatie met de bestaande configuratie van verschillende Python-frameworks. In deze sectie wordt beschreven hoe u de App Configuration-provider gebruikt in populaire webframeworks zoals Flask en Django.

Flask
Django

U kunt Azure-app configuratie gebruiken in uw bestaande Flask-web-apps door de ingebouwde configuratie bij te werken. U kunt dit doen door uw App Configuration-providerobject door te geven aan de update functie van uw Flask-app-exemplaar 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")

U kunt Azure-app Configuratie in uw bestaande Django-web-apps gebruiken door de volgende regels code toe te voegen aan uw settings.py bestand

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

Als u toegang wilt krijgen tot afzonderlijke configuratie-instellingen in de Django-weergaven, kunt u ernaar verwijzen vanuit het providerobject dat is gemaakt in Django-instellingen. Bijvoorbeeld 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")

Volledige codevoorbeelden voor het gebruik van Azure-app Configuratie in Python-webtoepassingen vindt u in de GitHub-opslagplaats voor Azure-app Configuration.

Resources opschonen

Als u de resources die in dit artikel zijn gemaakt niet wilt blijven gebruiken, verwijdert u de resourcegroep die u hier hebt gemaakt om kosten te voorkomen.

Belangrijk

Het verwijderen van een resourcegroep kan niet ongedaan worden gemaakt. De resourcegroep en alle resources daarin worden permanent verwijderd. Zorg ervoor dat u niet per ongeluk de verkeerde resourcegroep of resources verwijdert. Als u de resources voor dit artikel in een resourcegroep hebt gemaakt die andere resources bevat die u wilt behouden, moet u elke resource afzonderlijk verwijderen uit het deelvenster in plaats van dat u de resourcegroep verwijdert.

Meld u aan bij de Azure-portal en selecteer Resourcegroepen.
Voer de naam van de resourcegroep in het vak Filteren op naam in.
Selecteer in de resultatenlijst de resourcegroepnaam om een overzicht te bekijken.
Selecteer Resourcegroep verwijderen.
U wordt gevraagd om het verwijderen van de resourcegroep te bevestigen. Voer de naam van de resourcegroep in ter bevestiging en selecteer Verwijderen.

Na enkele ogenblikken worden de resourcegroep en alle bijbehorende resources verwijderd.

Volgende stappen

In deze quickstart hebt u een nieuw App Configuration-archief gemaakt en geleerd hoe u toegang krijgt tot sleutelwaarden vanuit een Python-app.

Ga voor meer codevoorbeelden naar:

Django Sample Flask Sample Azure-app Configuration Python-provider

Delen via