クイックスタート: Python アプリで Azure Cache for Redis を使用する

[アーティクル]
10/14/2024

このクイックスタートでは、Azure 内の任意のアプリケーションからアクセスできる安全な専用キャッシュにアクセスするために、Azure Cache for Redis を Python スクリプトに組み込みます。

この記事では、Python アプリを作成した後、コードを変更して最終的に動作するサンプルアプリにする方法について説明します。

コードをすぐに確認したい場合は、GitHub にある Python クイックスタートサンプルをご覧ください。

前提条件

Azure サブスクリプション。無料で作成できます
Python 3
- macOS または Linux の場合は、python.org からダウンロードします。
- Windows 11 の場合は、Microsoft Store を使用します。

キャッシュの作成

キャッシュを作成するには、Azure portal にサインインします。ポータルのメニューで、[リソースの作成] を選びます。
[作業の開始] ペインの検索バーに「Azure Cache for Redis」と入力します。検索結果で Azure Cache for Redis を見つけて、[作成] を選びます。

[新しい Redis Cache] ペインの [基本] タブで、以下のキャッシュの設定を構成します。

設定	アクション	説明
サブスクリプション	Azure サブスクリプションを選択します。	Azure Cache for Redis の新しいインスタンスの作成に使うサブスクリプション。
リソースグループ	リソースグループを選択するか、 [新規作成] を選択し、新しいリソースグループの名前を入力します。	キャッシュや他のリソースを作成するリソースグループの名前。すべてのアプリリソースを 1 つのリソースグループに配置することで、それらをまとめて簡単に管理または削除できます。
DNS 名	一意の名前を入力します。	キャッシュ名は、数字、英字、ハイフンのみを含む 1 から 63 文字の文字列とする必要があります。名前の先頭と末尾には数字または文字を使用する必要があり、連続するハイフンを含めることはできません。キャッシュインスタンスの "ホスト名" は `\<DNS name>.redis.cache.windows.net` です。
場所	場所を選択します。	キャッシュを使う他のサービスに近い Azure リージョン。
キャッシュ SKU	SKU を選びます。	SKU によって、キャッシュに利用できるサイズ、パフォーマンス、機能のパラメーターが決まります。詳細については、Azure Cache for Redis の概要に関するページを参照してください。
キャッシュサイズ	キャッシュサイズを選びます。	詳細については、Azure Cache for Redis の概要に関するページを参照してください。

[ネットワーク] タブを選ぶか、[次へ: ネットワーク] を選びます。
[ネットワーク] タブで、キャッシュに使う接続方法を選びます。
[詳細] タブを選ぶか、[次へ: 詳細] を選びます。
[詳細] ペインで、以下の情報に基づいて認証方法を確認または選択します。
- 既定では、新しい Basic、Standard、または Premium キャッシュでは、Microsoft Entra 認証が有効になり、アクセスキー認証が無効になります。
- Basic または Standard キャッシュの場合は、非 TLS ポートを選択できます。
- Standard および Premium キャッシュの場合は、可用性ゾーンを有効にすることを選択できます。キャッシュの作成後に可用性ゾーンを無効にすることはできません。
- Premium キャッシュを利用する場合は、非 TLS ポート、クラスタリング、マネージド ID、データ永続化の設定を構成します。
重要

最適なセキュリティのため、可能であれば、キャッシュに対する要求を認可するのに Microsoft Entra ID とマネージド ID を使うことをお勧めします。 Microsoft Entra ID とマネージド ID を使う認可は、共有アクセスキーの認可より、セキュリティと使いやすさの点で優れています。キャッシュでのマネージド ID の使用について詳しくは、キャッシュ認証での Microsoft Entra ID の使用に関する記事をご覧ください。
(省略可能) [タグ] タブを選ぶか、[次へ: タグ] を選びます。
(省略可能) キャッシュリソースを分類する場合は、[タグ] タブでタグの名前と値を入力します。
[確認および作成] ボタンを選択します。

[確認と作成] タブでは、Azure によって構成が自動的に検証されます。
緑色の検証に成功のメッセージが表示された後、 [作成] を選択します。

新しいキャッシュのデプロイは数分で完了します。デプロイの進行状況は、Azure Cache for Redis の [概要] ペインで監視できます。 [状態] に [実行中] と表示されたら、キャッシュを使用できます。

redis-py ライブラリをインストールする

redis-py は、Azure Cache for Redis の Python インターフェイスです。 Python パッケージツールの pip を使って、コマンドラインで redis-py パッケージをインストールします。

次の例では、管理者コマンドプロンプトウィンドウで Python 3 用の pip3 を使って Windows 11 に redis-py をインストールしています。

Azure Cache for Redis への redis-py インターフェイスのインストールを示すターミナルのスクリーンショット。

キャッシュにアクセスするための Python スクリプトを作成する

Microsoft Entra ID またはアクセスキーを使って Azure Cache for Redis に接続する Python スクリプトを作成します。 Microsoft Entra ID を使うことをお勧めします。

Microsoft Entra ID 認証 (推奨)
アクセスキー認証

キャッシュで Microsoft Entra ID の認証を有効にする

キャッシュが既にある場合は、最初に Microsoft Entra 認証が有効になっているかどうかを確認します。そうでない場合は、次の手順のようにして、Microsoft Entra 認証を有効にします。アプリケーションでの認証には Microsoft Entra ID を使うことをお勧めします。

Azure portal で、Microsoft Entra トークンベースの認証を使用する対象の Azure Cache for Redis インスタンスを選択します。
サービスメニューの [設定] で、[認証] を選びます。
[認証] ペインで、[Microsoft Entra 認証を有効にする] チェックボックスがオンになっているかどうかを調べます。そうである場合は、次のセクションに進むことができます。
そうでない場合は、[Microsoft Entra 認証を有効にする] チェックボックスをオンにします。次に、有効なユーザーの名前を入力します。 [保存] を選択します。入力したユーザー名には、データ所有者アクセスポリシーが自動的に割り当てられます。

マネージド ID またはサービスプリンシパルを入力して、キャッシュに接続することもできます。
ダイアログボックスで、構成を更新するかどうかが確認され、更新の完了には数分かかることが通知されます。 [はい] を選択します。

重要

有効化の操作が完了すると、キャッシュ内のノードが再起動して新しい構成が読み込まれます。この操作は、標準メンテナンス期間中またはピーク営業時間外に実行することをお勧めします。このプロセスには、最大で 30 分かかることがあります。

Azure CLI での Microsoft Entra ID の使用については、ID のリファレンスページをご覧ください。

Microsoft 認証ライブラリをインストールする

Microsoft 認証ライブラリ (MSAL) は、ユーザーの認証を行うために Microsoft ID プラットフォームからセキュリティトークンを取得します。

MSAL をインストールするには:

Python 用の MSAL をインストールします。
Python Azure ID クライアントライブラリをインストールします。このライブラリは、MSAL を使ってトークン認証のサポートを提供します。

pip を使ってこのライブラリをインストールします。

pip install azure-identity

Microsoft Entra ID を使用して Python スクリプトを作成する

テキストファイルを作成します。ファイルを PythonApplication1.py として保存します。

PythonApplication1.py で、次のスクリプトを追加して変更します。

スクリプトで:

<Your Host Name> を Azure Cache for Redis インスタンスの値に置き換えます。ホスト名の形式は <DNS name>.redis.cache.windows.net です。
<Your Username> を実際の Microsoft Entra ID ユーザーの値に置き換えます。

import redis
from azure.identity import DefaultAzureCredential

scope = "https://redis.azure.com/.default"
host = "<Your Host Name>"
port = 6380
user_name = "<Your Username>"


def hello_world():
    cred = DefaultAzureCredential()
    token = cred.get_token(scope)
    r = redis.Redis(host=host,
                    port=port,
                    ssl=True,    # ssl connection is required.
                    username=user_name,
                    password=token.token,
                    decode_responses=True)
    result = r.ping()
    print("Ping returned : " + str(result))

    result = r.set("Message", "Hello!, The cache is working with Python!")
    print("SET Message returned : " + str(result))

    result = r.get("Message")
    print("GET Message returned : " + result)

    result = r.client_list()
    print("CLIENT LIST returned : ")
    for c in result:
        print(f"id : {c['id']}, addr : {c['addr']}")

if __name__ == '__main__':
    hello_world()

ターミナルで Python コードを実行する前に、ターミナルで Microsoft Entra ID の使用を認可します。

azd auth login
Python を使って PythonApplication1.py ファイルを実行します。出力が次の例のようになることを確認します。

再認証を使用して Python スクリプトを作成する

Microsoft Entra ID アクセストークンの有効期間は限られており、約 75 分です。キャッシュへの接続を維持するには、トークンを更新する必要があります。

この例では、Python を使ってトークンを更新する方法を見ていきます。

テキストファイルを作成します。ファイルを PythonApplication2.py として保存します。

PythonApplication2.py で、次のスクリプトを追加して変更します。

スクリプトで:

<Your Host Name> を Azure Cache for Redis インスタンスの値に置き換えます。ホスト名の形式は <DNS name>.redis.cache.windows.net です。
<Your Username> を実際の Microsoft Entra ID ユーザーの値に置き換えます。

import time
import logging
import redis
from azure.identity import DefaultAzureCredential

scope = "https://redis.azure.com/.default"
host = "<Your Host Name>"
port = 6380
user_name = "<Your Username>"

def re_authentication():
    _LOGGER = logging.getLogger(__name__)
    cred = DefaultAzureCredential()
    token = cred.get_token(scope)
    r = redis.Redis(host=host,
                    port=port,
                    ssl=True,   # ssl connection is required.
                    username=user_name,
                    password=token.token,
                    decode_responses=True)
    max_retry = 3
    for index in range(max_retry):
        try:
            if _need_refreshing(token):
                _LOGGER.info("Refreshing token...")
                tmp_token = cred.get_token(scope)
                if tmp_token:
                    token = tmp_token
                r.execute_command("AUTH", user_name, token.token)
            result = r.ping()
            print("Ping returned : " + str(result))

            result = r.set("Message", "Hello!, The cache is working with Python!")
            print("SET Message returned : " + str(result))

            result = r.get("Message")
            print("GET Message returned : " + result)

            result = r.client_list()
            print("CLIENT LIST returned : ")
            for c in result:
                print(f"id : {c['id']}, addr : {c['addr']}")
            break
        except redis.ConnectionError:
            _LOGGER.info("Connection lost. Reconnecting.")
            token = cred.get_token(scope)
            r = redis.Redis(host=host,
                            port=port,
                            ssl=True,   # ssl connection is required.
                            username=user_name,
                            password=token.token,
                            decode_responses=True)
        except Exception:
            _LOGGER.info("Unknown failures.")
            break


def _need_refreshing(token, refresh_offset=300):
    return not token or token.expires_on - time.time() < refresh_offset

if __name__ == '__main__':
    re_authentication()

Python を使って PythonApplication2.py ファイルを実行します。出力が次の例のようになることを確認します。

前の例とは異なり、トークンの有効期間が切れると、この例のコードはトークンを自動的に更新します。

ホスト名、ポート、アクセスキーを取得する

キャッシュクライアントが Azure Cache for Redis サーバーに接続するには、キャッシュのホスト名、ポート、アクセスキーが必要です。一部のクライアントでは、これらの項目が少し異なる名前で呼ばれている場合があります。ホスト名、ポート、キーは Azure portal で取得できます。

キャッシュのアクセスキーを取得するには:
1. Azure portal で、キャッシュに移動します。
2. サービスメニューの [設定] で、[認証] を選びます。
3. [認証] ペインで、[アクセスキー] タブを選びます。
4. アクセスキーの値をコピーするには、キーフィールドの [コピー] アイコンを選びます。
キャッシュのホスト名とポートを取得するには:
1. Azure portal で、キャッシュに移動します。
2. サービスメニューで、[概要] を選びます。
3. [基本] の [ホスト名] で、[コピー] アイコンを選んでホスト名の値をコピーします。ホスト名の値の形式は <DNS name>.redis.cache.windows.net です。
4. [ポート] で、[コピー] アイコンを選んでポートの値をコピーします。

コマンドラインでキャッシュの読み取りと書き込みを行う

キャッシュをテストするには、コマンドラインから Pythonを実行します。

コマンドラインで「py」と入力して、Python インタープリターを開始します。
次のコードを変更して実行します。

コードで、<Your Host Name> と <Your Access Key> を Azure Cache for Redis インスタンスの値に置き換えます。ホスト名の形式は <DNS name>.redis.cache.windows.net です。
```
>>> import redis
>>> r = redis.Redis(host='<Your Host Name>',
        port=6380, db=0, password='<Your Access Key>', ssl=True)
>>> r.set('foo', 'bar')
True
>>> r.get('foo')
b'bar'
```

アクセスキーを使用して Python スクリプトを作成する

新しいテキストファイルを作成します。ファイルを PythonApplication1.py として保存します。

PythonApplication1.py で、次のスクリプトを追加して変更します。

スクリプトで:

<Your Host Name> を Azure Cache for Redis インスタンスの値に置き換えます。ホスト名の形式は <DNS name>.redis.cache.windows.net です。
<Your Access Key> を実際の Microsoft Entra ID ユーザーの値に置き換えます。

import redis

myHostname = "<Your Host Name>"
myPassword = "<Your Access Key>"

r = redis.Redis(host=myHostname, port=6380,
                      password=myPassword, ssl=True)

result = r.ping()
print("Ping returned : " + str(result))

result = r.set("Message", "Hello!, The cache is working with Python!")
print("SET Message returned : " + str(result))

result = r.get("Message")
print("GET Message returned : " + result)

result = r.client_list()
print("CLIENT LIST returned : ")
for c in result:
    print(f"id : {c['id']}, addr : {c['addr']}")

Python を使って PythonApplication1.py ファイルを実行します。次の例のような結果が出力として表示されることを確認します。

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

この記事で作成したリソースを引き続き使用する場合は、リソースグループを保持します。

それ以外の場合、リソースに関連する課金が行われないようにするために、リソースの使用が終了したら、作成した Azure リソースグループを削除して構いません。

警告

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

リソースグループを削除する

Azure portal にサインインし、 [リソースグループ] を選択します。
削除するリソースグループを選びます。

多数のリソースグループがある場合は、[任意フィールドのフィルター] に、この記事を完了するために作成したリソースグループの名前を入力します。検索結果の一覧で、リソースグループを選びます。
[リソースグループの削除] を選択します。
[リソースグループの削除] ペインで、リソースグループの名前を入力して確認した後、[削除] を選びます。

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

Azure Cache for Redis を使用する ASP.NET Web アプリを作成する

次の方法で共有

クイックスタート: Python アプリで Azure Cache for Redis を使用する

前提条件

キャッシュの作成

redis-py ライブラリをインストールする

キャッシュにアクセスするための Python スクリプトを作成する

キャッシュで Microsoft Entra ID の認証を有効にする

Microsoft 認証ライブラリをインストールする

Microsoft Entra ID を使用して Python スクリプトを作成する

再認証を使用して Python スクリプトを作成する

ホスト名、ポート、アクセスキーを取得する

コマンドラインでキャッシュの読み取りと書き込みを行う

アクセスキーを使用して Python スクリプトを作成する

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

リソースグループを削除する

フィードバック

その他のリソース

次の方法で共有

クイック スタート: Python アプリで Azure Cache for Redis を使用する

コードにスキップする

前提条件

キャッシュの作成

redis-py ライブラリをインストールする

キャッシュにアクセスするための Python スクリプトを作成する

キャッシュで Microsoft Entra ID の認証を有効にする

Microsoft 認証ライブラリをインストールする

Microsoft Entra ID を使用して Python スクリプトを作成する

再認証を使用して Python スクリプトを作成する

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

リソース グループを削除する

関連するコンテンツ

フィードバック

その他のリソース

クイックスタート: Python アプリで Azure Cache for Redis を使用する

リソースグループを削除する