Snabbstart: Skapa en Python-app med Azure App Configuration

I den här snabbstarten använder du Python-providern för Azure App Configuration för att centralisera lagring och hantering av programinställningar med hjälp av Klientbiblioteket för Azure App Configuration Python-providern.

Python App Configuration-providern är ett bibliotek som körs ovanpå Azure SDK för Python, vilket hjälper Python-utvecklare att enkelt använda appkonfigurationstjänsten. Det gör att konfigurationsinställningar kan användas som en ordlista.

Förutsättningar

• Ett Azure-konto med en aktiv prenumeration. Skapa en kostnadsfritt.
• Ett appkonfigurationsarkiv. Skapa en butik.
• Python 3.8 eller senare – information om hur du konfigurerar Python i Windows finns i dokumentationen om Python i Windows

Lägga till nyckelvärden

Lägg till följande nyckelvärden i App Configuration Store. Mer information om hur du lägger till nyckelvärden i ett arkiv med hjälp av Azure Portal eller CLI finns i Skapa ett nyckelvärde.

Tangent	Värde	Etikett	Innehållstyp
meddelande	Hello (Hej)	Lämna tom	Lämna tom
test.message	Hello-test	Lämna tom	Lämna tom
my_json	{"key":"value"}	Lämna tom	application/json

Konsolprogram

I det här avsnittet skapar du ett konsolprogram och läser in data från appkonfigurationsarkivet.

Ansluta till appkonfiguration

1. Skapa en ny katalog för projektet med namnet app-configuration-quickstart.

   mkdir app-configuration-quickstart
   

2. Växla till den nyligen skapade katalogen app-configuration-quickstart .

   cd app-configuration-quickstart
   

3. Installera Azure App Configuration-providern med hjälp pip install av kommandot .

   pip install azure-appconfiguration-provider
   

4. Skapa en ny fil med namnet app-configuration-quickstart.py i katalogen app-configuration-quickstart och lägg till följande kod:

   Microsoft Entra-ID (rekommenderas)

   Du använder för att autentisera DefaultAzureCredential till appkonfigurationsarkivet. Följ anvisningarna för att tilldela dina autentiseringsuppgifter rollen App Configuration Data Reader. Se till att ge tillräckligt med tid för att behörigheten ska spridas innan du kör programmet.

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

   Anslutningssträng

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

Kör appen

1. Ange en miljövariabel.

   Microsoft Entra-ID (rekommenderas)

   Ange miljövariabeln med namnet AZURE_APPCONFIG_ENDPOINT till slutpunkten för appkonfigurationsarkivet som finns under Översikt över din butik i Azure Portal.

   Om du använder Windows-kommandotolken kör du följande kommando och startar om kommandotolken så att ändringen börjar gälla:

   setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
   

   Om du använder PowerShell kör du följande kommando:

   $Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
   

   Om du använder macOS eller Linux kör du följande kommando:

   export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
   

   Anslutningssträng

   Ange miljövariabeln med namnet AZURE_APPCONFIG_CONNECTION_STRING till den skrivskyddade anslutningssträng i appkonfigurationsarkivet som finns under Åtkomstnycklar för din butik i Azure Portal.

   Om du använder Windows-kommandotolken kör du följande kommando och startar om kommandotolken så att ändringen börjar gälla:

   setx AZURE_APPCONFIG_CONNECTION_STRING "<connection-string-of-your-app-configuration-store>"
   

   Om du använder PowerShell kör du följande kommando:

   $Env:AZURE_APPCONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
   

   Om du använder macOS eller Linux kör du följande kommando:

   export AZURE_APPCONFIG_CONNECTION_STRING='<connection-string-of-your-app-configuration-store>'
   

2. När miljövariabeln har angetts korrekt kör du följande kommando för att köra appen lokalt:

   python app-configuration-quickstart.py
   

   Du bör se följande utdata:

   Hello
   value
   Hello test
   message found: True
   test.message found: False
   

Webbprogram

Appkonfigurationsprovidern läser in data i ett Mapping objekt som är tillgängligt som en ordlista, som kan användas i kombination med den befintliga konfigurationen av olika Python-ramverk. Det här avsnittet visar hur du använder appkonfigurationsprovidern i populära webbramverk som Flask och Django.

Flaska

Du kan använda Azure App Configuration i dina befintliga Flask-webbappar genom att uppdatera den inbyggda konfigurationen. Du kan göra detta genom att skicka appkonfigurationsproviderobjektet till funktionen för flaskappinstansen update i 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")

Django

Du kan använda Azure App Configuration i dina befintliga Django-webbappar genom att lägga till följande kodrader i settings.py filen

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

Om du vill komma åt enskilda konfigurationsinställningar i Django-vyerna kan du referera till dem från providerobjektet som skapats i Django-inställningarna. Till exempel i views.py:

# Import Django settings
from django.conf import settings

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

Fullständiga kodexempel på hur du använder Azure App Configuration i Python-webbprogram finns på GitHub-lagringsplatsen för Azure App Configuration .

Rensa resurser

Om du inte vill fortsätta använda resurserna som skapas i den här artikeln tar du bort resursgruppen som du skapade här för att undvika avgifter.

Viktigt!

Att ta bort en resursgrupp kan inte ångras. Resursgruppen och alla resurser i den tas bort permanent. Se till att du inte oavsiktligt tar bort fel resursgrupp eller resurser. Om du har skapat resurserna för den här artikeln i en resursgrupp som innehåller andra resurser som du vill behålla tar du bort varje resurs individuellt från respektive fönster i stället för att ta bort resursgruppen.

1. Logga in på Azure Portal och välj Resursgrupper.
2. I rutan Filtrera efter namn anger du namnet på resursgruppen.
3. I resultatlistan väljer du resursgruppens namn för att se en översikt.
4. Välj Ta bort resursgrupp.
5. Du blir ombedd att bekräfta borttagningen av resursgruppen. Ange namnet på resursgruppen för att bekräfta och välj Ta bort.

Efter en liten stund tas resursgruppen och alla dess resurser bort.

Nästa steg

I den här snabbstarten skapade du ett nytt appkonfigurationsarkiv och lärde dig att komma åt nyckelvärden från en Python-app.

Ytterligare kodexempel finns i:

Django Exempelpå Flask Exempel påAzure App Configuration Python-provider