Vytvoření aplikace v Pythonu pomocí sady Azure SDK pro Python

  • Článek

Tento dokument ukazuje příklady použití sady Azure SDK pro Python pro přístup k datům v konfiguraci Aplikace Azure.

Tip

App Configuration nabízí knihovnu poskytovatelů Pythonu, která je postavená na sadě Python SDK a je navržená tak, aby byla jednodušší používat s bohatšími funkcemi. Umožňuje používat nastavení konfigurace, jako je slovník, a nabízí další funkce, jako je složení konfigurace z více popisků, oříznutí názvu klíče a automatické rozlišení odkazů na Key Vault. Další informace najdete v rychlém startu Pythonu.

Požadavky

Vytvoření hodnoty klíče

Přidejte do obchodu App Configuration následující klíč-hodnota a ponechte popisek a typ obsahu s výchozími hodnotami. Další informace o tom, jak přidat hodnoty klíčů do úložiště pomocí webu Azure Portal nebo rozhraní příkazového řádku, najdete v tématu Vytvoření hodnoty klíče.

Key Hodnota
TestApp:Settings:Message Data z konfigurace Aplikace Azure

Nastavení aplikace v Pythonu

  1. Vytvořte nový adresář pro projekt s názvem app-configuration-example.

    mkdir app-configuration-example

  2. Přepněte do nově vytvořeného adresáře s ukázkou konfigurace aplikace.

    cd app-configuration-example

  3. Pomocí příkazu nainstalujte klientskou knihovnu pip install Aplikace Azure Configuration.

    pip install azure-appconfiguration

  4. V ukázkovém adresáři konfigurace aplikace vytvořte nový soubor s názvem app-configuration-example.py a přidejte následující kód:

    import os
from azure.appconfiguration import AzureAppConfigurationClient, ConfigurationSetting

try:
    print("Azure App Configuration - Python example")
    # Example code goes here
except Exception as ex:
    print('Exception:')
    print(ex)

Poznámka:

Fragmenty kódu v tomto příkladu vám pomůžou začít s klientskou knihovnou App Configuration pro Python. U aplikace byste také měli zvážit zpracování výjimek podle vašich potřeb. Další informace o zpracování výjimek najdete v naší dokumentaci k sadě Python SDK.

Konfigurace připojovací řetězec konfigurace aplikace

  1. Nastavte proměnnou prostředí s názvem AZURE_APPCONFIG_CONNECTION_STRING a nastavte ji na připojovací řetězec vašeho App Configuration Storu. Na příkazovém řádku spusťte následující příkaz:

    Pokud chcete aplikaci spustit místně pomocí příkazového řádku Windows, spusťte následující příkaz a nahraďte <app-configuration-store-connection-string> připojovací řetězec úložiště konfigurace aplikací:

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

  2. Vytiskněte hodnotu proměnné prostředí, abyste ověřili, že je správně nastavená pomocí následujícího příkazu.

    Pomocí příkazového řádku systému Windows restartujte příkazový řádek, aby se změna projevila, a spusťte následující příkaz:

    echo %AZURE_APPCONFIG_CONNECTION_STRING%

Ukázky kódu

Ukázkové fragmenty kódu v této části ukazují, jak provádět běžné operace s klientskou knihovnou App Configuration pro Python. Přidejte tyto fragmenty kódu do try bloku v souboru app-configuration-example.py , který jste vytvořili dříve.

Poznámka:

Klientská knihovna App Configuration odkazuje na objekt klíč-hodnota jako ConfigurationSetting. V tomto článku se proto hodnoty klíčů v App Configuration Storu označují jako nastavení konfigurace.

Přečtěte si následující postupy:

Připojení ke službě App Configuration Store

Následující fragment kódu vytvoří instanci AzureAppConfigurationClient pomocí připojovací řetězec uložené v proměnných prostředí.

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

Získání nastavení konfigurace

Následující fragment kódu načte nastavení konfigurace podle key názvu.

    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)

Přidání nastavení konfigurace

Následující fragment kódu vytvoří ConfigurationSetting objekt s key poli a value vyvolá metodu add_configuration_setting . Tato metoda vyvolá výjimku, pokud se pokusíte přidat nastavení konfigurace, které již v úložišti existuje. Pokud se chcete této výjimce vyhnout, můžete místo toho použít metodu set_configuration_setting .

    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)

Získání seznamu nastavení konfigurace

Následující fragment kódu načte seznam nastavení konfigurace. Argumenty key_filter a label_filter hodnoty klíčů lze zadat k filtrování hodnot klíčů na key základě a label v uvedeném pořadí. Další informace o filtrování najdete v tématu o dotazování nastavení konfigurace.

    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)

Uzamčení nastavení konfigurace

Stav zámku klíč-hodnota v App Configuration je označen read_only atributem objektu ConfigurationSetting . Pokud read_only ano True, nastavení je uzamčeno. Metodu set_read_only lze vyvolat s argumentem read_only=True pro uzamčení nastavení konfigurace.

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

Odemknutí nastavení konfigurace

read_only Pokud je Falseatributem , ConfigurationSetting nastavení je odemknuté. Metodu set_read_only lze vyvolat pomocí read_only=False argumentu pro odemknutí nastavení konfigurace.

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

Aktualizace nastavení konfigurace

Metodu set_configuration_setting lze použít k aktualizaci existujícího nastavení nebo vytvoření nového nastavení. Následující fragment kódu změní hodnotu existujícího nastavení konfigurace.

    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)

Odstranění nastavení konfigurace

Následující fragment kódu odstraní nastavení konfigurace podle key názvu.


    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)

Spustit aplikaci

V tomto příkladu jste vytvořili aplikaci v Pythonu, která používá klientskou knihovnu Aplikace Azure Configuration k načtení nastavení konfigurace vytvořeného prostřednictvím webu Azure Portal, přidání nového nastavení, načtení seznamu existujících nastavení, uzamčení a odemknutí nastavení, aktualizaci nastavení a nakonec odstranění nastavení.

V tomto okamžiku by váš soubor app-configuration-example.py měl mít následující kód:

import os
from azure.appconfiguration import AzureAppConfigurationClient, ConfigurationSetting

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

    connection_string = os.getenv('AZURE_APPCONFIG_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)

V okně konzoly přejděte do adresáře obsahujícího soubor app-configuration-example.py a spusťte aplikaci spuštěním následujícího příkazu Pythonu:

python app-configuration-example.py

Měl by se zobrazit následující výstup:

Azure App Configuration - Python example

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!

Vyčištění prostředků

Pokud nechcete dál používat prostředky vytvořené v tomto článku, odstraňte skupinu prostředků, kterou jste tady vytvořili, abyste se vyhnuli poplatkům.

Důležité

Odstranění skupiny prostředků je nevratné. Skupina prostředků a všechny prostředky v ní se trvale odstraní. Ujistěte se, že omylem neodstraníte nesprávnou skupinu prostředků nebo prostředky. Pokud jste vytvořili prostředky pro tento článek ve skupině prostředků, která obsahuje další prostředky, které chcete zachovat, odstraňte jednotlivé prostředky z příslušného podokna místo odstranění skupiny prostředků.

  1. Přihlaste se k webu Azure Portal a vyberte skupiny prostředků.
  2. Do pole Filtrovat podle názvu zadejte název vaší skupiny prostředků.
  3. V seznamu výsledků vyberte název skupiny prostředků, abyste zobrazili přehled.
  4. Vyberte Odstranit skupinu prostředků.
  5. Zobrazí se výzva k potvrzení odstranění skupiny prostředků. Potvrďte název skupiny prostředků a vyberte Odstranit.

Po chvíli se skupina prostředků a všechny její prostředky odstraní.

Další kroky

Tato příručka vám ukázala, jak pomocí sady Azure SDK pro Python přistupovat k datům v konfiguraci Aplikace Azure.

Další ukázky kódu najdete zde:

Ukázky klientské knihovny Aplikace Azure Konfigurace

Pokud chcete zjistit, jak používat Aplikace Azure Konfigurace s aplikacemi v Pythonu, přejděte na:

Vytvoření aplikace v Pythonu s konfigurací Aplikace Azure