Quickstart: Een Python-app maken met Azure App Configuration

In deze quickstart gaat u met Azure App Configuration de opslag en het beheer van toepassingsinstellingen centraliseren met behulp van de Azure App Configuration-clientbibliotheek voor Python.

Vereisten

• Azure-abonnement: u kunt een gratis abonnement nemen
• Python 2.7 of 3.6 of hoger: zie de documentatie over Python op Windows voor meer informatie over het instellen van Python op Windows

Een App Configuration-archief maken

1. Als u een nieuw App Configuration-archief wilt maken, moet u zich eerst aanmelden bij de Azure-portal. Selecteer in de linkerbovenhoek van de startpagina de optie Een resource maken. Voer in het vak Marketplace doorzoeken App Configuration in en selecteer Invoeren.

   

2. Selecteer App Configuration in de zoekresultaten en selecteer vervolgens Maken.

   

3. Voer in het deelvenster App Configuration maken de volgende instellingen in:

   Instelling	Voorgestelde waarde	Beschrijving
   Abonnement	Uw abonnement	Selecteer het Azure-abonnement dat u wilt gebruiken om App Configuration te testen. Als uw account maar één abonnement heeft, wordt dit automatisch geselecteerd en wordt de lijst Abonnement niet weergegeven.
   Resourcegroep	AppConfigTestResources	Selecteer of maak een resourcegroep voor de resource van het App Configuration-archief. Deze groep is handig voor het ordenen van meerdere resources die u mogelijk op een bepaald moment wilt verwijderen door resourcegroep te verwijderen. Zie Resourcegroepen gebruiken om Azure-resources te beheren voor meer informatie.
   Resourcenaam	Wereldwijd unieke naam	Voer een unieke resourcenaam in voor de resource van het App Configuration-archief. De naam moet een tekenreeks zijn van 5 tot 50 tekens en mag alleen cijfers, letters en - bevatten. De naam mag niet beginnen of eindigen met -.
   Locatie	US - centraal	Gebruik Locatie om de geografische locatie op te geven waar het app-configuratiearchief wordt gehost. Voor de beste prestaties maakt u de resource in dezelfde regio als de andere onderdelen van uw toepassing.
   Prijscategorie	Gratis	Selecteer de gewenste prijscategorie. Ga voor meer informatie naar de pagina met prijzen voor App Configuration.

4. Selecteer Beoordelen en maken om de instellingen te valideren.

5. Selecteer Maken. De implementatie kan enkele minuten duren.

6. Als de implementatie is voltooid, gaat u naar de resource App Configuration. Selecteer Instellingen > Toegangssleutels. Noteer de verbindingsreeks van de primaire alleen-lezensleutel. U hebt de verbindingsreeks later nodig voor de configuratie van uw toepassing, zodat deze kan communiceren met het App Configuration-archief dat u hebt gemaakt.

7. Selecteer Configuratieverkenner > Maken > Sleutelwaarde om de volgende sleutel-waardeparen toe te voegen:

   Sleutel	Waarde
   TestApp:Settings:Message	Gegevens van Azure App Configuration

   Laat Label en Inhoudstype nog even leeg.

8. Selecteer Toepassen.

De Python-app instellen

1. In deze zelfstudie maakt u een nieuwe map voor het project, met de naam app-configuration-quickstart.

   mkdir app-configuration-quickstart
   

2. Schakel over naar de zojuist gemaakte map app-configuration-quickstart.

   cd app-configuration-quickstart
   

3. Installeer de Azure App Configuration-clientbibliotheek met behulp van de opdracht pip install.

   pip install azure-appconfiguration
   

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

   import os
   from azure.appconfiguration import AzureAppConfigurationClient, ConfigurationSetting
   
   try:
       print("Azure App Configuration - Python Quickstart")
       # Quickstart code goes here
   except Exception as ex:
       print('Exception:')
       print(ex)
   

Uw App Configuration-verbindingsreeks configureren

1. Stel een omgevingsvariabele in met de naam AZURE_APP_CONFIG_CONNECTION_STRING en stel deze in op de toegangssleutel van het App Configuration-archief. Voer op de opdrachtregel de volgende opdracht uit:

   setx AZURE_APP_CONFIG_CONNECTION_STRING "connection-string-of-your-app-configuration-store"
   

   Als u Windows PowerShell gebruikt, voert u de volgende opdracht uit:

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

   Als u macOS of Linux gebruikt, voert u de volgende opdracht uit:

   export AZURE_APP_CONFIG_CONNECTION_STRING='connection-string-of-your-app-configuration-store'
   

2. Start de opdrachtprompt opnieuw op om de wijziging door te voeren. Druk de waarde van de omgevingsvariabele af om te controleren of deze correct is ingesteld.

Codevoorbeelden

De voorbeeldcodefragmenten in deze sectie laten zien hoe u veelgebruikte bewerkingen kunt uitvoeren met de App Configuration-clientbibliotheek voor Python. Voeg deze codefragmenten toe aan het blok try in het bestand app-configuration-quickstart.py dat u eerder hebt gemaakt.

• Verbinding maken met een App Configuration-archief
• Een configuratie-instelling ophalen
• Een configuratie-instelling toevoegen
• Een lijst met configuratie-instellingen ophalen
• Een configuratie-instelling vergrendelen
• Een configuratie-instelling ontgrendelen
• Een configuratie-instelling bijwerken
• Een configuratie-instelling verwijderen

Verbinding maken met een App Configuration-archief

Met het volgende codefragment maakt u een instantie van AzureAppConfigurationClient met behulp van de in uw omgevingsvariabelen opgeslagen verbindingsreeks.

    connection_string = os.getenv('AZURE_APP_CONFIG_CONNECTION_STRING')
    app_config_client = AzureAppConfigurationClient.from_connection_string(connection_string)

Een configuratie-instelling ophalen

Met het volgende codefragment wordt een configuratie-instelling opgehaald met de key-naam.

    retrieved_config_setting = app_config_client.get_configuration_setting(key='TestApp:Settings:Message')
    print("\nRetrieved configuration setting:")
    print("Key: " + retrieved_config_setting.key + ", Value: " + retrieved_config_setting.value)

Een configuratie-instelling toevoegen

Met het volgende codefragment maakt u een ConfigurationSetting-object met de velden key en value en roept u de methode add_configuration_setting aan. Deze methode genereert een uitzondering als u probeert een configuratie-instelling toe te voegen die al in uw archief voorkomt. Als u deze uitzondering wilt voorkomen, kunt u in plaats daarvan de methode set_configuration_setting gebruiken.

    config_setting = ConfigurationSetting(
        key='TestApp:Settings:NewSetting',
        value='New setting value'
    )
    added_config_setting = app_config_client.add_configuration_setting(config_setting)
    print("\nAdded configuration setting:")
    print("Key: " + added_config_setting.key + ", Value: " + added_config_setting.value)

Een lijst met configuratie-instellingen ophalen

Met het volgende codefragment wordt een lijst met configuratie-instellingen opgehaald. De argumenten key_filter en label_filter kunnen worden opgegeven om sleutel-waarden te filteren op basis van key respectievelijk label. Zie configuratie-instellingen opvragen voor meer informatie over filteren.

    filtered_settings_list = app_config_client.list_configuration_settings(key_filter="TestApp*")
    print("\nRetrieved list of configuration settings:")
    for item in filtered_settings_list:
        print("Key: " + item.key + ", Value: " + item.value)

Een configuratie-instelling vergrendelen

De vergrendelingsstatus van een sleutel-waarde in App Configuration wordt aangeduid met het kenmerk read_only van het object ConfigurationSetting. Als read_only Trueis, is de instelling vergrendeld. De methode set_read_only kan worden aangeroepen met het argument read_only=True om de configuratie-instelling te vergrendelen.

    locked_config_setting = app_config_client.set_read_only(added_config_setting, read_only=True)
    print("\nRead-only status for " + locked_config_setting.key + ": " + str(locked_config_setting.read_only))

Een configuratie-instelling ontgrendelen

Als het read_only-kenmerk van een ConfigurationSetting de waarde False heeft, is de instelling ontgrendeld. De methode set_read_only kan worden aangeroepen met het argument read_only=False om de configuratie-instelling te ontgrendelen.

    unlocked_config_setting = app_config_client.set_read_only(locked_config_setting, read_only=False)
    print("\nRead-only status for " + unlocked_config_setting.key + ": " + str(unlocked_config_setting.read_only))

Een configuratie-instelling bijwerken

De methode set_configuration_setting kan worden gebruikt om een bestaande instelling bij te werken of een nieuwe instelling te maken. Met het volgende codefragment wordt de waarde van een bestaande configuratie-instelling gewijzigd.

    added_config_setting.value = "Value has been updated!"
    updated_config_setting = app_config_client.set_configuration_setting(added_config_setting)
    print("\nUpdated configuration setting:")
    print("Key: " + updated_config_setting.key + ", Value: " + updated_config_setting.value)

Een configuratie-instelling verwijderen

Met het volgende codefragment wordt een configuratie-instelling met de key-naam.

    deleted_config_setting = app_config_client.delete_configuration_setting(key="TestApp:Settings:NewSetting")
    print("\nDeleted configuration setting:")
    print("Key: " + deleted_config_setting.key + ", Value: " + deleted_config_setting.value)

De app uitvoeren

In deze quickstart hebt u een Python-app gemaakt waarin gebruikgemaakt wordt van de Azure App Configuration-clientbibliotheek om een configuratie-instelling op te halen die is gemaakt via de Azure-portal, een nieuwe instelling toe te voegen, een lijst met bestaande instellingen op te halen, een instelling te vergrendelen en te ontgrendelen, een instelling bij te werken en ten slotte een instelling te verwijderen.

Op dit moment moet uw app-configuration-quickstart.py-bestand de volgende code bevatten:

import os
from azure.appconfiguration import AzureAppConfigurationClient, ConfigurationSetting

try:
    print("Azure App Configuration - Python Quickstart")
    # Quickstart code goes here

    connection_string = os.getenv('AZURE_APP_CONFIG_CONNECTION_STRING')
    app_config_client = AzureAppConfigurationClient.from_connection_string(connection_string)

    retrieved_config_setting = app_config_client.get_configuration_setting(key='TestApp:Settings:Message')
    print("\nRetrieved configuration setting:")
    print("Key: " + retrieved_config_setting.key + ", Value: " + retrieved_config_setting.value)

    config_setting = ConfigurationSetting(
        key='TestApp:Settings:NewSetting',
        value='New setting value'
    )
    added_config_setting = app_config_client.add_configuration_setting(config_setting)
    print("\nAdded configuration setting:")
    print("Key: " + added_config_setting.key + ", Value: " + added_config_setting.value)

    filtered_settings_list = app_config_client.list_configuration_settings(key_filter="TestApp*")
    print("\nRetrieved list of configuration settings:")
    for item in filtered_settings_list:
        print("Key: " + item.key + ", Value: " + item.value)

    locked_config_setting = app_config_client.set_read_only(added_config_setting, read_only=True)
    print("\nRead-only status for " + locked_config_setting.key + ": " + str(locked_config_setting.read_only))

    unlocked_config_setting = app_config_client.set_read_only(locked_config_setting, read_only=False)
    print("\nRead-only status for " + unlocked_config_setting.key + ": " + str(unlocked_config_setting.read_only))

    added_config_setting.value = "Value has been updated!"
    updated_config_setting = app_config_client.set_configuration_setting(added_config_setting)
    print("\nUpdated configuration setting:")
    print("Key: " + updated_config_setting.key + ", Value: " + updated_config_setting.value)

    deleted_config_setting = app_config_client.delete_configuration_setting(key="TestApp:Settings:NewSetting")
    print("\nDeleted configuration setting:")
    print("Key: " + deleted_config_setting.key + ", Value: " + deleted_config_setting.value)

except Exception as ex:
    print('Exception:')
    print(ex)

Navigeer in uw consolevenster naar de map die het bestand app-configuration-quickstart.py bevat en voer de volgende Python-opdracht uit om de app uit te voeren:

python app-configuration-quickstart.py

In dat geval moet de volgende uitvoer worden weergegeven:

Azure App Configuration - Python Quickstart

Retrieved configuration setting:
Key: TestApp:Settings:Message, Value: Data from Azure App Configuration

Added configuration setting:
Key: TestApp:Settings:NewSetting, Value: New setting value

Retrieved list of configuration settings:
Key: TestApp:Settings:Message, Value: Data from Azure App Configuration
Key: TestApp:Settings:NewSetting, Value: New setting value

Read-only status for TestApp:Settings:NewSetting: True

Read-only status for TestApp:Settings:NewSetting: False

Updated configuration setting:
Key: TestApp:Settings:NewSetting, Value: Value has been updated!

Deleted configuration setting:
Key: TestApp:Settings:NewSetting, Value: Value has been updated!

Resources opschonen

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

1. Meld u aan bij de Azure-portal en selecteer Resourcegroepen.
2. Voer de naam van de resourcegroep in het vak Filteren op naam in.
3. Selecteer in de resultatenlijst de resourcegroepnaam om een overzicht te bekijken.
4. Selecteer Resourcegroep verwijderen.
5. 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 nieuwe App Configuration store gemaakt en geleerd hoe u toegang krijgt tot sleutelwaarden vanuit een Python-app.

Ga voor meer codevoorbeelden naar: