Python-alkalmazás létrehozása a Pythonhoz készült Azure SDK-val

Cikk
11/08/2023

Ez a dokumentum példákat mutat be arra, hogyan használhatja a Pythonhoz készült Azure SDK-t az adatok elérésére Azure-alkalmazás Konfigurációban.

Tipp.

Az Alkalmazáskonfiguráció egy Python-szolgáltatói kódtárat kínál, amely a Python SDK-ra épül, és úgy lett kialakítva, hogy könnyebben használható legyen a gazdagabb funkciókkal. Lehetővé teszi a konfigurációs beállítások szótárként való használatát, és más funkciókat is kínál, például a több címkéből álló konfigurációösszeállítást, a kulcsnév-vágást és a Key Vault-hivatkozások automatikus feloldását. További információért lépjen a Python rövid útmutatójához .

Előfeltételek

Azure-előfizetés – hozzon létre egyet ingyenesen
Python 3.8 vagy újabb – a Python Windowson való beállításával kapcsolatos információkért tekintse meg a Python windowsos dokumentációját
Alkalmazáskonfigurációs áruház. Hozzon létre egy áruházat.

Kulcs-érték létrehozása

Adja hozzá a következő kulcsértéket az Alkalmazáskonfigurációs áruházhoz, és hagyja meg a címke és a tartalomtípus alapértelmezett értékeit. Ha többet szeretne tudni arról, hogyan adhat hozzá kulcsértékeket egy áruházhoz az Azure Portal vagy a parancssori felület használatával, lépjen a Kulcs-érték létrehozása elemre.

Kulcs	Érték
TestApp:Gépház:Message	Adatok Azure-alkalmazás konfigurációjából

A Python-alkalmazás beállítása

Hozzon létre egy új könyvtárat az app-configuration-example nevű projekthez.
```
mkdir app-configuration-example
```
Váltson az újonnan létrehozott alkalmazáskonfigurációs példakönyvtárra .
```
cd app-configuration-example
```
Telepítse a Azure-alkalmazás konfigurációs ügyfélkódtárat a pip install parancs használatával.
```
pip install azure-appconfiguration
```

Hozzon létre egy app-configuration-example.py nevű új fájlt az app-configuration-example könyvtárban, és adja hozzá a következő kódot:

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)

Feljegyzés

A példában szereplő kódrészletek segítenek a Python alkalmazáskonfigurációs ügyfélkódtárának használatbavételében. Az alkalmazás esetében érdemes megfontolnia a kivételek igény szerinti kezelését is. A kivételkezeléssel kapcsolatos további információkért tekintse meg a Python SDK dokumentációját.

Az alkalmazáskonfigurációs kapcsolati sztring konfigurálása

Állítson be egy AZURE_APPCONFIG_CONNECTION_STRING nevű környezeti változót, és állítsa be az Alkalmazáskonfigurációs áruház kapcsolati sztring. Futtassa a következő parancsot a parancssorban:
Ha helyileg szeretné futtatni az alkalmazást a Windows parancssorával, futtassa a következő parancsot, és cserélje le <app-configuration-store-connection-string> az alkalmazáskonfigurációs áruház kapcsolati sztring:
```
setx AZURE_APPCONFIG_CONNECTION_STRING "connection-string-of-your-app-configuration-store"
```
Windows PowerShell használata esetén futtassa a következő parancsot, és cserélje le <app-configuration-store-connection-string> az alkalmazáskonfigurációs áruház kapcsolati sztring:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "<app-configuration-store-connection-string>"
```
MacOS használata esetén futtassa a következő parancsot, és cserélje le <app-configuration-store-connection-string> az alkalmazáskonfigurációs áruház kapcsolati sztring:
```
export AZURE_APPCONFIG_CONNECTION_STRING='<app-configuration-store-connection-string>'
```
Linux használata esetén futtassa a következő parancsot, és cserélje le <app-configuration-store-connection-string> az alkalmazáskonfigurációs áruház kapcsolati sztring:
```
export AZURE_APPCONFIG_CONNECTION_STRING='<app-configuration-store-connection-string>'
```
Nyomtassa ki a környezeti változó értékét annak ellenőrzéséhez, hogy megfelelően van-e beállítva az alábbi paranccsal.
A Windows parancssorával indítsa újra a parancssort a módosítás érvénybe lépésének engedélyezéséhez, és futtassa a következő parancsot:
```
echo %AZURE_APPCONFIG_CONNECTION_STRING%
```
Windows PowerShell használata esetén futtassa a következő parancsot:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING
```
MacOS használata esetén futtassa a következő parancsot:
```
echo "$AZURE_APPCONFIG_CONNECTION_STRING"
```
Linux használata esetén futtassa a következő parancsot:
```
echo "$AZURE_APPCONFIG_CONNECTION_STRING"
```

Kódminták

Az ebben a szakaszban található mintakódrészletek bemutatják, hogyan hajthat végre gyakori műveleteket a Python alkalmazáskonfigurációs ügyfélkódtárával. Adja hozzá ezeket a kódrészleteket a try korábban létrehozott app-configuration-example.py fájl blokkjába.

Feljegyzés

Az Alkalmazáskonfiguráció ügyfélkódtár egy kulcs-érték objektumra hivatkozik.ConfigurationSetting Ezért ebben a cikkben az App Configuration Store kulcsértékei konfigurációs beállításoknak lesznek nevezve.

Az alábbiakban megtudhatja, hogyan:

Csatlakozás alkalmazáskonfigurációs áruházba
Konfigurációs beállítás lekérése
Konfigurációs beállítás hozzáadása
Konfigurációs beállítások listájának lekérése
Konfigurációs beállítás zárolása
Konfigurációs beállítás zárolásának feloldása
Konfigurációs beállítás frissítése
Konfigurációs beállítás törlése

Csatlakozás alkalmazáskonfigurációs áruházba

Az alábbi kódrészlet létrehozza az AzureAppConfigurationClient egy példányát a környezeti változókban tárolt kapcsolati sztring használatával.

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

Konfigurációs beállítás lekérése

Az alábbi kódrészlet név szerint key kéri le a konfigurációs beállítást.

    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)

Konfigurációs beállítás hozzáadása

Az alábbi kódrészlet létrehoz egy ConfigurationSetting objektumot és value mezőket, key és meghívja a metódustadd_configuration_setting. Ez a módszer kivételt eredményez, ha olyan konfigurációs beállítást próbál hozzáadni, amely már létezik az áruházban. Ha el szeretné kerülni ezt a kivételt, a set_configuration_setting metódus használható helyette.

    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)

Konfigurációs beállítások listájának lekérése

Az alábbi kódrészlet lekéri a konfigurációs beállítások listáját. Az key_filter és label_filter az argumentumok megadhatóak a kulcsértékek alapján és label azok alapján key történő szűréséhez. A szűrésről további információt a konfigurációs beállítások lekérdezésével kapcsolatban talál.

    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)

Konfigurációs beállítás zárolása

Az Alkalmazáskonfiguráció kulcsértékének zárolási állapotát az read_onlyConfigurationSetting objektum attribútuma jelöli. Ha read_only igen True, a beállítás zárolva van. A set_read_only metódus argumentummal read_only=True hívható meg a konfigurációs beállítás zárolásához.

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

Konfigurációs beállítás zárolásának feloldása

Ha egy read_only attribútum ConfigurationSetting egy, Falsea beállítás feloldva. A set_read_only metódus argumentummal read_only=False hívható meg a konfigurációs beállítás feloldásához.

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

Konfigurációs beállítás frissítése

A set_configuration_setting metódus egy meglévő beállítás frissítésére vagy új beállítás létrehozására használható. Az alábbi kódrészlet megváltoztatja egy meglévő konfigurációs beállítás értékét.

    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)

Konfigurációs beállítás törlése

Az alábbi kódrészlet név szerint key törli a konfigurációs beállítást.


    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)

Az alkalmazás futtatása

Ebben a példában létrehozott egy Python-alkalmazást, amely a Azure-alkalmazás Configuration ügyfélkódtár használatával lekéri az Azure Portalon létrehozott konfigurációs beállítást, új beállítást ad hozzá, lekéri a meglévő beállítások listáját, zárolja és feloldja a beállításokat, frissít egy beállítást, és végül töröl egy beállítást.

Ekkor a app-configuration-example.py fájlnak a következő kóddal kell rendelkeznie:

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)

A konzolablakban keresse meg a app-configuration-example.py fájlt tartalmazó könyvtárat, és futtassa a következő Python-parancsot az alkalmazás futtatásához:

python app-configuration-example.py

A következő kimenetnek kell megjelennie:

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!

Az erőforrások eltávolítása

Ha nem szeretné folytatni a cikkben létrehozott erőforrások használatát, törölje az itt létrehozott erőforráscsoportot a díjak elkerülése érdekében.

Fontos

Az erőforráscsoport törlése nem vonható vissza. Az erőforráscsoport és a benne lévő összes erőforrás véglegesen törlődik. Győződjön meg arról, hogy nem véletlenül törli a rossz erőforráscsoportot vagy erőforrásokat. Ha a cikk erőforrásait olyan erőforráscsoporton belül hozta létre, amely más megtartani kívánt erőforrásokat tartalmaz, törölje az egyes erőforrásokat a megfelelő panelről az erőforráscsoport törlése helyett.

Jelentkezzen be az Azure Portalra, és válassza ki az Erőforráscsoportokat.
A Szűrés név szerint mezőbe írja be az erőforráscsoport nevét.
Az eredménylistában válassza ki az erőforráscsoport nevét az áttekintés megtekintéséhez.
Válassza az Erőforráscsoport törlése elemet.
A rendszer az erőforráscsoport törlésének megerősítését kéri. Adja meg a megerősítéshez az erőforráscsoport nevét, és válassza a Törlés lehetőséget.

Néhány pillanat múlva az erőforráscsoport és annak összes erőforrása törlődik.

Következő lépések

Ez az útmutató bemutatta, hogyan férhet hozzá az adatokhoz a Pythonhoz készült Azure SDK-val Azure-alkalmazás konfigurációban.

További kódmintákért látogasson el a következőre:

Azure-alkalmazás Konfigurációs ügyfélkódtár mintái

A Azure-alkalmazás-konfiguráció Python-alkalmazásokkal való használatáról a következő témakörben tájékozódhat:

Python-alkalmazás létrehozása Azure-alkalmazás konfigurációval

Megosztás a következőn keresztül: