クイックスタート: Azure App Configuration を使用した Python アプリの作成

このクイックスタートでは、Azure App Configuration Python プロバイダー クライアント ライブラリを使用して、Azure App Configuration 用の Python プロバイダーでアプリケーション設定のストレージと管理を一元化します。

Python App Configuration プロバイダーは、Azure SDK for Python 上で実行されているライブラリで、Python 開発者が App Configuration サービスを簡単に使用するのに役立ちます。 これにより、構成設定をディクショナリのように使用できます。

前提条件

• アクティブなサブスクリプションが含まれる Azure アカウント。 無料で作成できます。
• App Configuration ストア。 ストアを作成する。
• Python 3.8 以降 - Windows での Python の設定について詳しくは、Windows での Python に関するドキュメントをご覧ください

キーと値を追加する

App Configuration ストアに次のキーと値を追加します。 Azure portal または CLI を使用してストアにキーと値を追加する方法の詳細については、「キーと値を作成する」を参照してください。

キー	値	Label	Content type
message	Hello	空のままにします	空のままにします
test.message	Hello test	空のままにします	空のままにします
my_json	{"key":"value"}	空のままにします	application/json

コンソール アプリケーション

このセクションでは、コンソール アプリケーションを作成し、App Configuration ストアからデータを読み込みます。

App Configuration に接続する

1. プロジェクト用に app-configuration-quickstart という名前の新しいディレクトリを作成します。

   mkdir app-configuration-quickstart
   

2. 新しく作成した app-configuration-quickstart ディレクトリに切り替えます。

   cd app-configuration-quickstart
   

3. pip install コマンドを使用して、Azure App Configuration プロバイダーをインストールします。

   pip install azure-appconfiguration-provider
   

4. app-configuration-quickstart ディレクトリに app-configuration-quickstart.py という名前の新しいファイルを作成し、次のコードを追加します。

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

アプリケーションの実行

1. AZURE_APPCONFIG_CONNECTION_STRING という名前の環境変数を設定し、それを App Configuration ストアへの接続文字列に設定します。 コマンド ラインで次のコマンドを実行します。

   Windows コマンド プロンプト

   ローカル環境で Windows コマンド プロンプトを使用してアプリを実行するには、次のコマンドを実行します。<app-configuration-store-connection-string> を実際のアプリ構成ストアの接続文字列に置き換えてください。

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

   PowerShell

   Windows PowerShell を使う場合は、次のコマンドを実行し、<app-configuration-store-connection-string> を実際のアプリ構成ストアの接続文字列に置き換えます。

   $Env:AZURE_APPCONFIG_CONNECTION_STRING = "<app-configuration-store-connection-string>"
   

   macOS

   macOS を使う場合は、次のコマンドを実行し、<app-configuration-store-connection-string> を実際のアプリ構成ストアの接続文字列に置き換えます。

   export AZURE_APPCONFIG_CONNECTION_STRING='<app-configuration-store-connection-string>'
   

   Linux

   Linux を使う場合は、次のコマンドを実行し、<app-configuration-store-connection-string> を実際のアプリ構成ストアの接続文字列に置き換えます。

   export AZURE_APPCONFIG_CONNECTION_STRING='<app-configuration-store-connection-string>'
   

2. 次のコマンドを使って環境変数の値を出力し、正しく設定されていることを確認します。

   Windows コマンド プロンプト

   Windows コマンド プロンプトを使用し、コマンド プロンプトを再起動して変更を反映させ、次のコマンドを実行します。

   echo %AZURE_APPCONFIG_CONNECTION_STRING%
   

   PowerShell

   Windows PowerShell を使用する場合は、次のコマンドを実行します。

   $Env:AZURE_APPCONFIG_CONNECTION_STRING
   

   macOS

   MacOS を使用する場合は、次のコマンドを実行します。

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

   Linux

   Linux を使用する場合は、次のコマンドを実行します。

   echo "$AZURE_APPCONFIG_CONNECTION_STRING"
   

3. 環境変数が適切に設定されたら、次のコマンドを実行してアプリをローカルで実行します。

   python app-configuration-quickstart.py
   

   次の出力が表示されます。

   Hello
   value
   Hello test
   message found: True
   test.message found: False
   

Web アプリケーション

App Configuration プロバイダーは、ディクショナリとしてアクセスできる Mapping オブジェクトにデータを読み込みます。これは、さまざまな Python フレームワークの既存の構成と組み合わせて使用できます。 このセクションでは、Flask や Django などの一般的な Web フレームワークで App Configuration プロバイダーを使用する方法について説明します。

Flask

既存の Flask Web アプリで Azure App Configuration を使用するには、組み込みの構成を更新します。 これを行うには、app.py で、App Configuration プロバイダー オブジェクトを Flask アプリ インスタンスの update 関数に渡します。

azure_app_config = load(connection_string=os.environ.get("AZURE_APPCONFIG_CONNECTION_STRING"))

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

Django

既存の Django Web アプリで Azure App Configuration を使用するには、次のコード行を settings.py ファイルに追加します。

AZURE_APPCONFIGURATION = load(connection_string=os.environ.get("AZURE_APPCONFIG_CONNECTION_STRING"))

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 App Configuration を使用する方法に関する完全なコード サンプルについては、Azure App Configuration の GitHub リポジトリを参照してください。

リソースをクリーンアップする

この記事で作成したリソースを継続して使用しない場合は、ここで作成したリソース グループを削除して課金されないようにしてください。

重要

リソース グループを削除すると、元に戻すことができません。 リソース グループとそのすべてのリソースは完全に削除されます。 間違ったリソース グループやリソースをうっかり削除しないようにしてください。 この記事のリソースを、保持したい他のリソースを含むリソース グループ内に作成した場合は、リソース グループを削除する代わりに、各リソースをそれぞれのペインから個別に削除します。

1. Azure portal にサインインし、 [リソース グループ] を選択します。
2. [名前でフィルター] ボックスにリソース グループの名前を入力します。
3. 結果一覧でリソース グループ名を選択し、概要を表示します。
4. [リソース グループの削除] を選択します。
5. リソース グループの削除の確認を求めるメッセージが表示されます。 確認のためにリソース グループの名前を入力し、 [削除] を選択します。

しばらくすると、リソース グループとそのすべてのリソースが削除されます。

次のステップ

このクイックスタートでは、新しい App Configuration ストアを作成して、Python アプリのキー値を操作する方法について学習しました。

その他のコード サンプルについては、次を参照してください。

Django サンプルFlask サンプルAzure App Configuration Python プロバイダー