クイック スタート: Python で Azure Redis Cache を使用するQuickstart: Use Azure Redis Cache with Python

はじめにIntroduction

このクイック スタートでは、Python で Azure Redis Cache に接続して、キャッシュの読み取りと書き込みを実行する方法について説明します。This quickstart shows how to connect to an Azure Redis Cache with Python to read and write to a cache.

完了した Python テスト

Azure サブスクリプションをお持ちでない場合は、開始する前に 無料アカウント を作成してください。If you don't have an Azure subscription, create a free account before you begin.

前提条件Prerequisites

Azure で Redis Cache を作成するCreate a Redis cache on Azure

キャッシュを作成するには、まず Azure Portal にサインインし、[リソースの作成] > [データベース] > [Redis Cache] の順にクリックします。To create a cache, first sign in to the Azure portal, and click Create a resource > Databases > Redis Cache.

新しいキャッシュ

[新規 Redis Cache] で、新しいキャッシュの設定を構成します。In New Redis Cache, configure the settings for your new cache.

SettingSetting 推奨値Suggested value [説明]Description
DNS 名DNS name グローバルに一意の名前Globally unique name キャッシュ名は 1 ~ 63 文字の文字列で、数字、英字、- 文字のみを使用する必要があります。The cache name must be a string between 1 and 63 characters and contain only numbers, letters, and the - character. キャッシュ名の先頭と末尾には - 文字を使用できません。また、連続する - 文字は無効です。The cache name cannot start or end with the - character, and consecutive - characters are not valid.
サブスクリプションSubscription 該当するサブスクリプションYour subscription この新しい Azure Redis Cache が作成されるサブスクリプション。The subscription under which this new Azure Redis Cache is created.
リソース グループResource Group TestResourcesTestResources その中にキャッシュを作成する新しいリソース グループの名前。Name for the new resource group in which to create your cache. アプリのすべてのリソースを 1 つのグループ内に配置することで、それらを一緒に管理できます。By putting all the resources for an app in a group, you can manage them together. たとえば、リソース グループを削除すれば、そのアプリに関連付けられているすべてのリソースが削除されます。For example, deleting the resource group would delete all resources associated with the app.
場所Location 米国東部East US キャッシュを使用する他のサービスの近くのリージョンを選択します。Choose a region near to other services that will use your cache.
価格レベルPricing tier Basic C0 (250 MB のキャッシュ)Basic C0 (250 MB Cache) 価格レベルによって、キャッシュのサイズ、パフォーマンス、および使用可能な機能が決まります。The pricing tier determines the size, performance, and features available for the cache. 詳細については、Azure Redis Cache の概要に関するページを参照してください。For more information, see Azure Redis Cache Overview.
ダッシュボードにピン留めするPin to dashboard オンSelected クリックすると、新しいキャッシュをダッシュ ボードにピン留めし、簡単に見つけられるようになります。Click pin the new cache to your dashboard making it easy to find.

キャッシュの作成

新しいキャッシュ設定を構成したら、[作成] をクリックします。Once the new cache settings are configured, click Create.

キャッシュが作成されるまで数分かかる場合があります。It can take a few minutes for the cache to be created. 状態を確認するには、ダッシュボードで進行状況を監視してください。To check the status, you can monitor the progress on the dashboard. キャッシュが作成されると、新しいキャッシュの状態が 実行中 になり、使用できるようになります。After the cache has been created, your new cache has a Running status and is ready for use.

作成されたキャッシュ

Azure Portal を使用して、ホスト名、ポート、およびアクセス キーを取得するRetrieve host name, ports, and access keys using the Azure Portal

Azure Redis Cache のインスタンスに接続するときには、キャッシュ クライアントにキャッシュのホスト名、ポート、およびキーが必要です。When connecting to an Azure Redis Cache instance, cache clients need the host name, ports, and a key for the cache. 一部のクライアントは、若干異なる名前で、これらの項目を参照できます。Some clients may refer to these items by slightly different names. この情報は、Azure Portal で取得できます。You can retrieve this information in the Azure portal.

Azure Portal を使用してアクセス キーを取得するには、キャッシュを参照して、[アクセス キー] をクリックします。To retrieve the access keys using the Azure portal, browse to your cache and click Access keys.

Redis Cache のキー

ホスト名やポートを取得するには、[プロパティ] をクリックします。To retrieve host name, ports, click Properties.

Redis cache properties

redis-py をインストールするInstall redis-py

redis-py は、Redis Cache の Python インターフェイスです。Redis-py is a Python interface to Redis Cache. Python パッケージ ツールの pip を使用して、redis-py パッケージをインストールします。Use the Python packages tool, pip, to install the redis-py package.

次の例では、Python3 の pip3 を使用し、昇格された管理者特権で実行されている Visual Studio 2017 の開発者コマンド プロンプトを使用して、Windows 10 に redis-py パッケージをインストールします。The following example uses pip3 for Python3 to install the redis-py package on Windows 10 using a Visual Studio 2017 Developer Command prompt running with elevated Administrator privileges.

pip3 install redis

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

キャッシュの読み取りと書き込みを実行するRead and write to the cache

Python を実行し、コマンド ラインからキャッシュを使ってテストします。Run Python and test using the cache from the command line. <Your Host Name><Your Access Key> を、Redis Cache の値に置き換えます。Replace <Your Host Name> and <Your Access Key> with the values for your Redis Cache.

>>> import redis
>>> r = redis.StrictRedis(host='<Your Host Name>.redis.cache.windows.net',
        port=6380, db=0, password='<Your Access Key>', ssl=True)
>>> r.set('foo', 'bar')
True
>>> r.get('foo')
b'bar'

Python スクリプトを作成するCreate a Python script

PythonApplication1.py という名前の新しいスクリプト テキスト ファイルを作成します。Create a new script text file named PythonApplication1.py.

PythonApplication1.py に次のスクリプトを追加し、ファイルを保存します。Add the following script to PythonApplication1.py and save the file. このスクリプトでは、キャッシュへのアクセスをテストします。This script will test the cache access. <Your Host Name><Your Access Key> を、Redis Cache の値に置き換えます。Replace <Your Host Name> and <Your Access Key> with the values for your Redis Cache.

import redis

myHostname = "<Your Host Name>.redis.cache.windows.net"
myPassword = "<Your Access Key>"

r = redis.StrictRedis(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.decode("utf-8"))

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

Python でスクリプトを実行します。Run the script with Python.

完了した Python テスト

リソースのクリーンアップClean up resources

別のチュートリアルを引き続き実行する場合は、このクイック スタートで作成したリソースを保持して再利用できます。If you will be continuing with another tutorial, you can keep the resources created in this quickstart and reuse them.

クイック スタートのサンプル アプリケーションの使用を終える場合は、課金を避けるために、このクイック スタートで作成した Azure リソースを削除することができます。Otherwise, if you are finished with the quickstart sample application, you can delete the Azure resources created in this quickstart to avoid charges.

重要

いったん削除したリソース グループを元に戻すことはできません。リソース グループとそこに存在するすべてのリソースは完全に削除されます。Deleting a resource group is irreversible and that the resource group and all the resources in it are permanently deleted. 間違ったリソース グループやリソースをうっかり削除しないようにしてください。Make sure that you do not accidentally delete the wrong resource group or resources. このサンプルのホストとなるリソースを、保持するリソースが含まれている既存のリソース グループ内に作成した場合は、リソース グループを削除するのではなく、個々のブレードから各リソースを個別に削除することができます。If you created the resources for hosting this sample inside an existing resource group that contains resources you want to keep, you can delete each resource individually from their respective blades instead of deleting the resource group.

Azure ポータル にサインインし、 [リソース グループ] をクリックします。Sign in to the Azure portal and click Resource groups.

[名前でフィルター] ボックスにリソース グループの名前を入力します。In the Filter by name... textbox, type the name of your resource group. この記事の手順では、TestResources という名前のリソース グループを使用しました。The instructions for this article used a resource group named TestResources. 結果一覧でリソース グループの [...] をクリックし、[リソース グループの削除] をクリックします。On your resource group in the result list, click ... then Delete resource group.

削除

リソース グループの削除の確認を求めるメッセージが表示されます。You will be asked to confirm the deletion of the resource group. 確認のためにリソース グループの名前を入力し、[削除] をクリックします。Type the name of your resource group to confirm, and click Delete.

しばらくすると、リソース グループとそこに含まれているすべてのリソースが削除されます。After a few moments, the resource group and all of its contained resources are deleted.

次の手順Next steps