快速入门：将 Azure Cache for Redis 与 Python 应用配合使用

项目
10/01/2024

在本快速入门中，你会将 Azure Cache for Redis 合并到 Python 脚本，以便能够访问 Azure 中的任何应用程序都可访问的安全专用缓存。

本文介绍如何创建一个 Python 应用，然后修改代码以最终得到一个正常运行的示例应用。

如果要直接跳到代码，请参阅 GitHub 上的 Python 快速入门示例。

先决条件

Azure 订阅。创建一个
Python 3
- 对于 macOS 或 Linux，请从 python.org 下载。
- 对于Windows 11，请使用 Windows 应用商店。

创建缓存

若要创建缓存，请登录到 Azure 门户并选择“创建资源”。
在“入门”页上的搜索框中键入“Azure Cache for Redis”。然后选择创建。

在“新建 Redis 缓存”页上配置缓存的设置。

设置	选择值	说明
订阅	单击下拉箭头并选择你的订阅。	要在其下创建此新的 Azure Cache for Redis 实例的订阅。
资源组	单击下拉箭头并选择一个资源组，或者选择新建并输入新的资源组名称。	要在其中创建缓存和其他资源的资源组的名称。将所有应用资源放入一个资源组可以轻松地统一管理或删除这些资源。
DNS 名称	输入唯一名称。	缓存名称必须是包含 1 到 63 个字符的字符串，只能包含数字、字母或连字符。该名称必须以数字或字母开头和结尾，且不能包含连续的连字符。缓存实例的主机名是 <DNS name>.redis.cache.chinacloudapi.cn。
位置	单击下拉箭头并选择一个位置。	选择使用缓存的其他服务附近的区域。
缓存 SKU	打开下拉列表并选择一个 SKU。	此 SKU 决定可用于缓存的大小、性能和功能参数。有关详细信息，请参阅用于 Redis 的 Azure 缓存概述。
缓存大小	打开下拉列表并选择缓存的大小	有关详细信息，请参阅用于 Redis 的 Azure 缓存概述。

选择网络选项卡，或选择网络按钮（位于页面底部）。
在网络选项卡中，选择你的连接方法。
选择“下一步: 高级”选项卡，或选择页面底部的“下一步: 高级”按钮，以查看“高级”选项卡。
- 对于“基本”或“标准”缓存，请切换非 TLS 端口的选项。还可以选择是否要启用“Microsoft Entra 身份验证”。
- 对于“高级”缓存，请配置非 TLS 端口、群集、托管标识和数据持久性的设置。还可以选择是否要启用“Microsoft Entra 身份验证”。
选择下一步: 标记选项卡，或选择页面底部的下一步: 标记按钮。
或者，在标记选项卡中，如果希望对资源分类，请输入名称或值。
选择查看 + 创建。随后你会转到“查看 + 创建”选项卡，Azure 将在此处验证配置。
显示绿色的“已通过验证”消息后，选择创建。

创建缓存需要一段时间。可以在 Azure Cache for Redis 的概述页上监视进度。如果“状态”显示为“正在运行”，则表示该缓存可供使用。

安装 redis-py 库

Redis-py 是 Azure Redis 缓存的 Python 接口。使用 Python 包工具 pip 在命令行中安装 redis-py 包。

以下示例在管理员命令提示符窗口中使用 Python 3 的 pip3 在 Windows 11 上安装 redis-py。

终端的屏幕截图，其中显示将 redis-py 接口安装到 Azure Cache for Redis。

创建用于访问缓存的 Python 脚本

创建一个 Python 脚本，该脚本使用 Microsoft Entra ID 或访问密钥连接到 Azure Cache for Redis。建议使用 Microsoft Entra ID。

Microsoft Entra ID 身份验证（建议）
访问密钥身份验证

在缓存上启用 Microsoft Entra ID 身份验证

对于现有的缓存，首先请检查是否启用了 Microsoft Entra 身份验证。如果未启用，请完成以下步骤来启用 Microsoft Entra 身份验证。建议在应用程序中使用 Microsoft Entra ID 进行身份验证。

在 Azure 门户中，选择你想要使用基于 Microsoft Entra 令牌的身份验证的 Azure Cache for Redis 实例。
在服务菜单中的“设置”下，选择“身份验证”。
在“身份验证”窗格中，检查是否选中了“启用 Microsoft Entra 身份验证”复选框。如果是，你可以转到下一部分。
否则，请选中“启用 Microsoft Entra 身份验证”复选框。然后输入有效用户的名称。选择“保存”。将为输入的用户名自动分配数据所有者访问策略。

你还可以输入托管标识或服务主体来连接缓存。
在对话框中，系统会询问你是否要更新配置，并告知更新需要几分钟才能完成。选择是。

重要

启用操作完成后，缓存中的节点将重新启动以加载新配置。建议在标准维护时段或高峰营业时间之外完成此操作。此过程最多可能需要 30 分钟。

有关将 Microsoft Entra ID 与 Azure CLI 配合使用的信息，请参阅标识参考页面。

安装 Microsoft 身份验证库

Microsoft 身份验证库 (MSAL) 从 Microsoft 标识平台获取安全令牌，以便对用户进行身份验证。

若要安装 MSAL，请执行以下操作：

安装适用于 Python 的 MSAL。
安装 Python Azure 标识客户端库。该库使用 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.chinacloudapi.cn。
请将 <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.chinacloudapi.cn。
请将 <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 门户中获取主机名、端口和密钥。

若要获取缓存的访问密钥，请执行以下操作：
1. 在 Azure 门户中转到自己的缓存。
2. 在服务菜单中的“设置”下，选择“身份验证”。
3. 在“身份验证”窗格上，选择“访问密钥”选项卡。
4. 若要复制访问密钥的值，请选择密钥字段中的“复制”图标。
若要获取缓存的主机名和端口，请执行以下操作：
1. 在 Azure 门户中转到自己的缓存。
2. 在服务菜单中，选择“概述”。
3. 在“Essentials”下，对于“主机名”，请选择“复制”图标以复制主机名值。主机名值的形式为 <DNS name>.redis.cache.chinacloudapi.cn。
4. 对于“端口”，请选择“复制”图标以复制端口值。

从命令行读取和写入缓存

若要测试缓存，请从命令行运行 Python。

在命令行中输入 py 以启动 Python 解释器。
修改并运行以下代码。

在代码中，将 <Your Host Name> 和 <Your Access Key> 替换为你的 Azure Cache for Redis 实例中的值。主机名的格式为 <DNS name>.redis.cache.chinacloudapi.cn。
```
>>> 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.chinacloudapi.cn。
请将 <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 门户，然后选择“资源组”。
选择要删除的资源组。

如果有多个资源组，请在“筛选任何字段”中，输入为完成本文创建的资源组的名称。在搜索结果列表中，选择该资源组。
选择“删除资源组”。
在“删除资源组”窗格中，输入资源组的名称进行确认，然后选择“删除”。

很快将会删除该资源组及其所有资源。

创建使用 Azure Cache for Redis 的 ASP.NET Web 应用

通过

快速入门：将 Azure Cache for Redis 与 Python 应用配合使用

跳到代码

先决条件

创建缓存

安装 redis-py 库

创建用于访问缓存的 Python 脚本

在缓存上启用 Microsoft Entra ID 身份验证

安装 Microsoft 身份验证库

使用 Microsoft Entra ID 创建 Python 脚本

使用重新身份验证创建 Python 脚本

清理资源

删除资源组

相关内容

其他资源