Rychlý start: Vytvoření aplikace v Pythonu pomocí Azure App Configuration

Článek
11/24/2021
7 min ke čtení

V tomto rychlém startu použijete Azure App Configuration centralizaci úložiště a správy nastavení aplikace pomocí klientské knihovny Azure App Configuration pro Python.

Požadavky

Předplatné Azure – vytvořte si ho zdarma.
Python 2.7 nebo 3.6 nebo novější – informace o nastavení Pythonu na Windows najdete v dokumentaci k Pythonu na Windows.

Vytvoření App Configuration úložiště

Pokud chcete vytvořit nové úložiště konfigurace aplikace, přihlaste se k Azure Portal. V levém horním rohu domovské stránky vyberte vytvořit prostředek. Do pole Hledat na Marketplace zadejte Konfigurace aplikace a vyberte ENTER.
Ve výsledcích hledání vyberte Konfigurace aplikace a pak vyberte vytvořit.

V podokně vytvořit konfiguraci aplikace zadejte následující nastavení:

Nastavení	Navrhovaná hodnota	Popis
Předplatné	Vaše předplatné	Vyberte předplatné Azure, které chcete použít k testování konfigurace aplikace. Pokud má váš účet jenom jedno předplatné, vybere se automaticky a seznam předplatných se nezobrazí.
Skupina prostředků	AppConfigTestResources	Vyberte nebo vytvořte skupinu prostředků pro prostředek úložiště konfigurace aplikace. Tato skupina je užitečná k organizování více prostředků, které můžete chtít odstranit současně odstraněním skupiny prostředků. Další informace najdete v tématu použití skupin prostředků ke správě prostředků Azure.
Název prostředku	Globálně jedinečný název	Zadejte jedinečný název prostředku, který se má použít pro prostředek úložiště konfigurace aplikace. Název musí být řetězec o 5 až 50 znaků a obsahovat pouze čísla, písmena a `-` znak. Název nesmí začínat ani končit `-` znakem.
Umístění	USA – střed	Umístění použijte k určení geografického umístění, ve kterém je úložiště konfigurace aplikace hostované. Nejlepšího výkonu dosáhnete vytvořením prostředku ve stejné oblasti jako jiné součásti aplikace.
Cenová úroveň	Free	Vyberte požadovanou cenovou úroveň. Další informace najdete na stránce s cenami konfigurace aplikací.

Vyberte zkontrolovat + vytvořit a ověřte nastavení.
Vyberte Vytvořit. Nasazení může trvat několik minut.
Po dokončení nasazení přejděte do prostředku konfigurace aplikace. Vyberte Nastavení > Přístupové klíče. Poznamenejte si primární připojovací řetězec klíče jen pro čtení. Pomocí tohoto připojovacího řetězce později nakonfigurujete aplikaci tak, aby komunikovala s úložištěm konfigurace aplikace, které jste vytvořili.

Výběrem možnosti Configuration Explorer Create Key-value (Vytvořit > > klíč-hodnotu) přidejte následující páry klíč-hodnota:

Klíč Hodnota

TestApp:Nastavení:Message Data z Azure App Configuration

Pole Label (Popisek) a Content Type (Typ obsahu) nechte v seznamu prázdné.
Vyberte Použít.

Klíč	Hodnota
TestApp:Nastavení:Message	Data z Azure App Configuration

Nastavení aplikace v Pythonu

V tomto kurzu vytvoříte nový adresář pro projekt s názvem app-configuration-quickstart.
```
mkdir app-configuration-quickstart
```
Přepněte do nově vytvořeného adresáře app-configuration-quickstart.
```
cd app-configuration-quickstart
```
Nainstalujte Azure App Configuration klientskou knihovnu pomocí pip install příkazu .
```
pip install azure-appconfiguration
```

Vytvořte nový soubor s názvem app-configuration-quickstart.py v adresáři app-configuration-quickstart a přidejte následující kód:

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)

Poznámka

Fragmenty kódu v tomto rychlém startu vám pomůžou začít s klientskou knihovnou App Configuration pro Python. Pro vaši aplikaci 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ího App Configuration vašeho klienta

Nastavte proměnnou prostředí AZURE_APP_CONFIG_CONNECTION_STRING a nastavte ji na přístupový klíč k vašemu App Configuration úložiště. Na příkazovém řádku spusťte následující příkaz:
```
setx AZURE_APP_CONFIG_CONNECTION_STRING "connection-string-of-your-app-configuration-store"
```
Pokud používáte Windows PowerShell, spusťte následující příkaz:
```
$Env:AZURE_APP_CONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
Pokud používáte macOS nebo Linux, spusťte následující příkaz:
```
export AZURE_APP_CONFIG_CONNECTION_STRING='connection-string-of-your-app-configuration-store'
```
Restartujte příkazový řádek, aby se změna mohla projeví. Vytiskněte hodnotu proměnné prostředí, abyste ověřili, že je správně nastavená.

Ukázky kódů

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

Poznámka

Klientská App Configuration odkazuje na objekt klíč-hodnota jako ConfigurationSetting na . Proto v tomto článku se klíč-hodnoty v App Configuration budou označovat jako nastavení konfigurace.

Připojení do App Configuration úložiště
Získání nastavení konfigurace
Přidání nastavení konfigurace
Získání seznamu nastavení konfigurace
Uzamčení nastavení konfigurace
Odemknutí nastavení konfigurace
Aktualizace nastavení konfigurace
Odstranění nastavení konfigurace

Připojení do App Configuration úložiště

Následující fragment kódu vytvoří instanci AzureAppConfigurationClient pomocí připojovacího řetězce uloženého ve vašich proměnných prostředí.

    connection_string = os.getenv('AZURE_APP_CONFIG_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ří objekt s poli a a ConfigurationSetting key vyvolá value add_configuration_setting metodu . Tato metoda vyvolá výjimku, pokud se pokusíte přidat nastavení konfigurace, které už ve vašem obchodě existuje. Pokud se chcete této výjimce vyhnout, set_configuration_setting použít metodu .

    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 lze zadat pro filtrování hodnot klíčů na základě a v uvedeném label_filter key label pořadí. Další informace o filtrování najdete v tématu 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 ConfigurationSetting objektu. Pokud read_only je , nastavení je True uzamčeno. Metodu set_read_only je možné vyvolat s read_only=True argumentem 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

Pokud read_only je ConfigurationSetting atributem False , nastavení se odemkne. Metodu set_read_only je možné vyvolat s read_only=False argumentem 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 můžete použít k aktualizaci existujícího nastavení nebo k 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)

Spuštění aplikace

V tomto rychlém startu jste vytvořili aplikaci v Pythonu, která pomocí klientské knihovny Azure App Configuration načte nastavení konfigurace vytvořené prostřednictvím Azure Portal, přidá nové nastavení, načte seznam existujících nastavení, uzamkne a odemkne nastavení, aktualizuje nastavení a nakonec odstraní nastavení.

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

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)

V okně konzoly přejděte do adresáře obsahujícího soubor app-configuration-quickstart.py a spusťte následující příkaz pythonu, který aplikaci spustí:

python app-configuration-quickstart.py

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

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!

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 předešli 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 nechtěně neodstraníte nesprávnou skupinu prostředků nebo prostředky. Pokud jste vytvořili prostředky pro tento článek v rámci skupiny prostředků, která obsahuje další prostředky, které chcete zachovat, odstraňte všechny prostředky jednotlivě z příslušného podokna, místo aby se odstranila skupina prostředků.

Přihlaste se k Azure Portala vyberte skupiny prostředků.
Do pole filtrovat podle názvu zadejte název vaší skupiny prostředků.
V seznamu výsledků vyberte název skupiny prostředků, aby se zobrazil přehled.
Vyberte Odstranit skupinu prostředků.
Zobrazí se výzva k potvrzení odstranění skupiny prostředků. Zadejte název vaší skupiny prostředků, který chcete potvrdit, a vyberte Odstranit.

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

Další kroky

V tomto rychlém startu jste vytvořili nový App Configuration store a naučili jste se přistupovat k hodnotám klíčů z aplikace v Pythonu.

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

Azure App Configuration ukázek klientské knihovny