快速入門：使用 Azure 應用程式組態建立 Python 應用程式

發行項
12/18/2024

在本快速入門中，您將使用 Azure 應用程式組態 Python 提供者用戶端程式庫，利用 Azure 應用程式組態 Python 提供者來集中儲存和管理應用程式設定。

Python 應用程式組態提供者是在適用於 Python 的 Azure SDK 之上執行的程式庫，可協助 Python 開發人員輕鬆取用應用程式組態服務。其讓組態設定可以像字典一樣使用。

必要條件

具有有效訂用帳戶的 Azure 帳戶。免費建立一個。
應用程式組態存放區。建立存放區。
Python 3.8 或更新版本 - 如需在 Windows 上設定 Python 的詳細資訊，請參閱 Windows 上的 Python 文件

新增金鑰值

將下列索引鍵/值新增至應用程式組態存放區。如需如何使用 Azure 入口網站或 CLI 將索引鍵/值新增至存放區的詳細資訊，請移至建立索引鍵/值。

機碼	值	標籤	內容類型
message	您好	保留空白	保留空白
test.message	Hello 測試	保留空白	保留空白
my_json	{"key":"value"}	保留空白	application/json

主控台應用程式

在本節中，您將建立主控台應用程式，並從應用程式組態存放區載入資料。

連線至應用程式組態

為專案建立名為 app-configuration-quickstart 的新目錄。
```
mkdir app-configuration-quickstart
```
切換至新建立的 app-configuration-quickstart 目錄。
```
cd app-configuration-quickstart
```
使用 pip install 命令安裝 Azure 應用程式組態提供者。
```
pip install azure-appconfiguration-provider
```

在 app-configuration-quickstart 目錄中，建立名為 app-configuration-quickstart.py 的新檔案，並新增下列程式碼：

Microsoft Entra ID (建議)
連接字串

您可以使用 DefaultAzureCredential 來向應用程式組態存放區進行驗證。請依照指示將認證指派給 應用程式組態數據讀取者角色。在執行應用程式之前，請務必允許足夠的時間來傳播許可權。

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

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

執行應用程式

設定環境變數。
- Microsoft Entra ID (建議)
- 連接字串
將名為 AZURE_APPCONFIG_ENDPOINT 的環境變數設定為應用程式組態存放區端點，該存放區位於 Azure 入口網站的市集概觀底下。

如果您使用 Windows 命令提示字元，請執行下列命令，然後重新啟動命令提示字元以讓變更生效：
```
setx AZURE_APPCONFIG_ENDPOINT "endpoint-of-your-app-configuration-store"
```
如果您使用 PowerShell，請執行下列命令：
```
$Env:AZURE_APPCONFIG_ENDPOINT = "endpoint-of-your-app-configuration-store"
```
如果您使用 macOS 或 Linux，請執行下列命令：
```
export AZURE_APPCONFIG_ENDPOINT='<endpoint-of-your-app-configuration-store>'
```
將名為 AZURE_APPCONFIG_CONNECTION_STRING 的環境變數設定為 Azure 入口網站中存放區 [存取金鑰] 底下找到之應用程式組態存放區的唯讀連接字串。

如果您使用 Windows 命令提示字元，請執行下列命令，然後重新啟動命令提示字元以讓變更生效：
```
setx AZURE_APPCONFIG_CONNECTION_STRING "<connection-string-of-your-app-configuration-store>"
```
如果您使用 PowerShell，請執行下列命令：
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
如果您使用 macOS 或 Linux，請執行下列命令：
```
export AZURE_APPCONFIG_CONNECTION_STRING='<connection-string-of-your-app-configuration-store>'
```
正確設定環境變數之後，請執行下列命令，在本機執行應用程式：
```
python app-configuration-quickstart.py
```
您應該會看見下列輸出：
```
Hello
value
Hello test
message found: True
test.message found: False
```

Web 應用程式

應用程式組態提供者會將資料載入 Mapping 物件，以字典的形式存取，可與各種 Python 架構的現有設定搭配使用。本節說明如何在 Flask 和 Django 等熱門 Web 架構中使用應用程式組態提供者。

Flask
Django

您可以藉由更新內建的設定，在現有的 Flask Web 應用程式中使用 Azure 應用程式組態。若要更新內建設定，您可以將應用程式組態提供者物件傳遞至 app.py 中 Flask 應用程式執行個體的 update 函式：

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

您可以在 settings.py 檔案中新增下列幾行程式碼，就可以在現有的 Django Web 應用程式中使用 Azure 應用程式組態

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

若要在 Django 檢視中存取個別組態設定，您可以從 Django 設定中建立的提供者對象參考它們。例如，在 views.py 中：

# Import Django settings
from django.conf import settings

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

如需如何在 Python Web 應用程式中使用 Azure 應用程式組態的完整程式碼範例，請參閱 Azure 應用程式組態 GitHub 存放庫。

清除資源

如果您不想繼續使用本文中建立的資源，請刪除在此處建立的資源群組，以避免產生費用。

重要

刪除資源群組是無法回復的動作。資源群組和其中的所有資源都將被永久刪除。請確定您不會誤刪錯誤的資源群組或資源。如果您是在包含需保留其他資源的資源群組內部，建立本文的資源，則可以從每個資源各自的窗格中個別刪除每個資源，而不必刪除整個資源群組。

登入 Azure 入口網站，然後選取 [資源群組]。
在 [依名稱篩選] 方塊中，輸入您資源群組的名稱。
在結果清單中，選取資源群組名稱以查看概觀。
選取 [刪除資源群組]。
系統將會要求您確認是否刪除資源群組。輸入您資源群組的名稱以進行確認，然後選取 [刪除]。

不久後，系統便會刪除該資源群組及其所有的資源。

下一步

在本快速入門中，您已建立新的應用程式組態存放區，並學會如何從 Python 應用程式存取索引鍵/值。

如需其他程式碼範例，請造訪：

Django 範例 Flask 範例 Azure 應用程式組態 Python 提供者

共用方式為