Compartir vía

Inicio rápido: usar Azure Redis Cache en Python

  • Artículo

En este Inicio rápido, incorporará Azure Managed Redis (versión preliminar) o Azure Cache for Redis en un script de Python para tener acceso a una caché segura y dedicada a la que se puede acceder desde cualquier aplicación dentro de Azure.

Ir al código en GitHub

Si quiere pasar directamente al código, consulte Inicio rápido: Uso de Azure Cache for Redis en Python en GitHub.

Requisitos previos

Crear una instancia de Azure Managed Redis (versión preliminar)

  1. Para crear una instancia de Azure Managed Redis (versión preliminar), inicie sesión en Azure Portal y seleccione Crear un recurso.

  2. En la página Nuevo, seleccione Base de datos y, a continuación, seleccione Azure Cache for Redis.

  3. En la página Nueva instancia de Redis Cache, configure las opciones de la nueva caché.

    Configuración Elegir un valor Descripción
    Suscripción Desplácese hacia abajo y seleccione su suscripción. La suscripción en la que se va a crear esta nueva instancia de Azure Managed Redis.
    Grupo de recursos Desplácese hacia abajo y seleccione un grupo de recursos o Crear nuevo y escriba un nombre nuevo para el grupo de recursos. Nombre del grupo de recursos en el que se van a crear la caché y otros recursos. Al colocar todos los recursos de la aplicación en un grupo de recursos, puede administrarlos o eliminarlos fácilmente.
    Nombre DNS Escriba un nombre que sea único en la región. El nombre de la memoria caché debe ser una cadena de entre 1 y 63 caracteres combinada con el nombre de la región de la memoria caché que contenga solo números, letras o guiones. (Si el nombre de la caché tiene menos de 45 caracteres, debe funcionar en todas las regiones disponibles actualmente). El nombre debe comenzar y terminar por un número o una letra y no puede contener guiones consecutivos. El nombre de host de la instancia de caché es \<DNS name\>.\<Azure region\>.redis.azure.net.
    Ubicación Desplácese hacia abajo y seleccione una ubicación. Azure Managed Redis está disponible en las regiones de Azure seleccionadas.
    Tipo de caché Desplegable y seleccione el nivel de rendimiento y el tamaño de caché. El nivel determina el rendimiento de la instancia de Redis, mientras que el tamaño de caché determina la memoria disponible para almacenar datos. Para obtener instrucciones sobre cómo elegir el nivel de rendimiento adecuado, consulte Elección del nivel correcto

    Captura de pantalla que muestra la pestaña Aspectos básicos de Redis administrados de Azure.

  4. Seleccione Siguiente: Redes y seleccione un punto de conexión público o privado.

  5. Seleccione Siguiente: Opciones avanzadas. Aquí puede configurar los Módulos Redis que se van a agregar a la instancia.

    Establezca Directiva de agrupación en clústeres en Enterprise para una memoria caché no en clúster, o bien en OSS para una caché en clúster. Para obtener más información sobre cómo elegir Directiva de agrupación en clústeres, consulte directiva de clúster.

    Captura de pantalla que muestra la pestaña Azure Managed Redis Advanced (Opciones avanzadas de Redis administrados de Azure).

    Si usa Replicación geográfica activa, debe configurarse durante la creación. Para obtener instrucciones sobre cómo hacerlo, consulte Configuración de la replicación geográfica activa para instancias de Azure Managed Redis.

    Importante

    No puede cambiar la directiva de agrupación en clústeres de una instancia de Azure Managed Redis (versión preliminar) después de crearla. Si usa RediSearch, se requiere la directiva de clúster Enterprise y NoEviction es la única directiva de expulsión admitida.

    Importante

    Si usa esta instancia de caché en un grupo de replicación geográfica, las directivas de expulsión no se pueden cambiar después de crear la instancia. Asegúrese de conocer las directivas de expulsión de los nodos principales antes de crear la caché. Para obtener más información sobre la replicación geográfica activa, consulte Requisitos previos de replicación geográfica activa.

    Importante

    No se pueden cambiar los módulos después de crear una instancia de caché. Los módulos deben estar habilitados en el momento de crear una instancia de Azure Cache for Redis. No hay ninguna opción para habilitar la configuración de un módulo después de crear una memoria caché.

  6. Seleccione Siguiente: Etiquetas y omítalo.

  7. Seleccione Siguiente: Review + create (Revisar y crear).

    Captura de pantalla que muestra la pestaña Revisión y creación de Azure Managed Redis.

  8. Revise la configuración y seleccione Crear.

    La instancia de Redis tardará varios minutos en crearse. Puede supervisar el progreso en la página Información general de Azure Managed Redis. Cuando Estado se muestra como En ejecución, la memoria caché está lista para su uso.

Creación de una instancia de Azure Redis Cache

  1. Para crear una caché, inicie sesión en Azure Portal. En el menú de Azure Portal, seleccione Crear un recurso.

    Captura de pantalla que muestra la opción Crear un recurso resaltada en el panel de navegación izquierdo de Azure Portal.

  2. En el panel Comenzar, escriba Azure Cache for Redis en la barra de búsqueda. En los resultados de la búsqueda, encuentre Azure Cache for Redis y, a continuación, seleccione Crear.

    Captura de pantalla que muestra Azure Marketplace con Azure Cache for Redis en el cuadro de búsqueda y el botón Crear está resaltado.

  3. En el panel Nueva Redis Cache, en la pestaña Aspectos básicos, configure las siguientes opciones para la memoria caché:

    Configuración Acción Descripción
    Suscripción Seleccione la suscripción a Azure. La suscripción que se va a usar para crear la nueva instancia de Azure Cache for Redis.
    Grupo de recursos Seleccione un grupo de recursos o Crear nuevo, y escriba un nombre nuevo para el grupo de recursos. Nombre del grupo de recursos en el que se va a crear la memoria caché y otros recursos. Al colocar todos los recursos de la aplicación en un grupo de recursos, puede administrarlos o eliminarlos fácilmente.
    Nombre DNS Escriba un nombre único. El nombre de caché debe ser una cadena de 1 a 63 caracteres que contenga solo números, letras y guiones. El nombre debe comenzar y terminar por un número o una letra y no puede contener guiones consecutivos. El nombre de host de la instancia de caché es \<DNS name>.redis.cache.windows.net.
    Ubicación Seleccione una ubicación. Una región de Azure cercana a otros servicios que usan la memoria caché.
    SKU de la caché Seleccione una SKU. La SKU determina los parámetros de tamaño, rendimiento y característica que están disponibles para la memoria caché. Para más información, consulte la introducción a Azure Cache for Redis.
    Tamaño de la caché Seleccione un tamaño de caché. Para más información, consulte la introducción a Azure Cache for Redis.

  4. Seleccione la pestaña Redes o Siguiente: Redes.

  5. En la pestaña Redes, seleccione un método de conectividad que se usará para la memoria caché.

  6. Seleccione la pestaña Opciones avanzadas o Siguiente: Opciones avanzadas.

  7. En el panel Opciones avanzadas, compruebe o seleccione un método de autenticación en función de la siguiente información:

    Captura de pantalla que muestra el panel Opciones avanzadas y las opciones disponibles que se van a seleccionar.

    • De manera predeterminada, para una nueva caché Básica, Estándar o Premium, la Autenticación de Microsoft Entra está habilitada y la Autenticación de claves de acceso está deshabilitada.
    • Para las cachés Básica o Estándar, puede elegir la selección de un puerto que no sea TLS.
    • Para las cachés Estándar y Premium, puede habilitar las zonas de disponibilidad. No puede deshabilitar las zonas de disponibilidad una vez creada la caché.
    • En el caso de una caché Premium, configure las opciones para un puerto que no sea TLS, la agrupación en clústeres, la identidad administrada y la persistencia de datos.

    Importante

    Para obtener una seguridad óptima, se recomienda usar Microsoft Entra ID con identidades administradas para autorizar solicitudes en la memoria caché, si es posible. La autorización mediante Microsoft Entra ID y las identidades administradas proporciona una seguridad y facilidad de uso superiores a la autorización mediante claves de acceso compartidas. Para más información sobre el uso de identidades administradas con la memoria caché, consulte Uso de Microsoft Entra ID para la autenticación de caché.

  8. (Opcional) Seleccione la pestaña Etiquetas o Siguiente: Etiquetas.

  9. (Opcional) En la pestaña Etiquetas, escriba un nombre de etiqueta y un valor si desea clasificar el recurso de caché.

  10. Seleccione el botón Revisar y crear.

    En la pestaña Revisar y crear, Azure valida automáticamente la configuración.

  11. Tras aparecer el mensaje verde Validación superada, seleccione Crear.

Se produce una nueva implementación de caché durante varios minutos. Puede supervisar el progreso de la implementación en el panel Información general de Azure Cache for Redis. Cuando Estado muestra En ejecución, la memoria caché está lista para usarse.

Instalación de la biblioteca redis-py

Redis-py es una interfaz de Python para Redis. Use la herramienta de paquetes de Python, pip, para instalar el paquete redis-py desde un símbolo del sistema.

En el ejemplo siguiente se usa pip3 para Python 3 para instalar redis-py en Windows 11 desde un símbolo del sistema de administrador.

Captura de pantalla de un terminal que muestra una instalación de la interfaz redis-py para Azure Cache for Redis.

Creación de un script de Python para acceder a la memoria caché

Cree una secuencia de comandos Python que utilice Microsoft Entra ID o claves de acceso para conectarse a su instancia de Azure Managed Redis (versión preliminar). Se recomienda usar Microsoft Entra ID.

Habilitación de la autenticación de Microsoft Entra ID en la memoria caché

Si tiene una memoria caché, compruebe si se ha habilitado la autenticación de Microsoft Entra. Si no es así, habilítela. Se recomienda usar Microsoft Entra ID para las aplicaciones.

  1. En Azure Portal, seleccione la instancia de Azure Cache for Redis en la que desea usar la autenticación basada en tokens de Microsoft Entra.

  2. Seleccione Autenticación en el menú Recurso.

  3. Actualice el panel de trabajo para ver si está activada Habilitar la autenticación de Microsoft Entra. Si es así, puede continuar.

  4. Seleccione Habilitar autenticación de Microsoft Entra y escriba el nombre de un usuario válido. Al usuario que escriba se le asigna automáticamente una directiva de acceso del propietario de datos de forma predeterminada al seleccionar Guardar. También puede escribir una identidad administrada o una entidad de servicio para conectarse a la instancia de caché.

    Captura de pantalla que muestra la autenticación seleccionada en el menú de recursos y la habilitación de la autenticación de Microsoft Entra activada.

  5. Se muestra un cuadro de diálogo emergente en el que se le pregunta si desea actualizar la configuración e informa de que tarda varios minutos. Seleccione Sí.

    Importante

    Una vez completada la operación de habilitación, los nodos de la instancia de caché se reinician para cargar la nueva configuración. Se recomienda realizar esta operación durante la ventana de mantenimiento o fuera del horario comercial pico. Esta operación puede tardar hasta 30 minutos.

Para obtener información sobre el uso de Microsoft Entra ID con la CLI de Azure, consulte las páginas de referencias para la identidad.

Instalación de la biblioteca de autenticación de Microsoft

  1. Instale la biblioteca de autenticación de Microsoft (MSAL). Esta biblioteca permite adquirir tokens de seguridad de la identidad de Microsoft para autenticar a los usuarios.

  2. Puede usar la biblioteca cliente de identidad de Azure de Python disponible que usa MSAL para proporcionar compatibilidad con la autenticación de tokens. Instale esta biblioteca utilizando pip:

pip install azure-identity

Creación de un script de Python con Microsoft Entra ID

  1. Cree un nuevo archivo de texto, agregue el siguiente script y guarde el archivo como PythonApplication1.py.

  2. Reemplace <Your Host Name> por los valores de su instancia de Azure Cache for Redis. Su nombre de host tiene el formato <DNS name>.<region>.redis.azure.net.

  3. Reemplace <Your Username> por los valores de su usuario de Microsoft Entra ID.

    import redis
from azure.identity import DefaultAzureCredential

scope = "https://redis.azure.com/.default"
host = "<Your Host Name>"
port = 10000
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()

  4. Antes de ejecutar el código de Python desde un terminal, asegúrese de autorizar el terminal para usar Microsoft Entra ID.

    azd auth login

  5. Ejecute PythonApplication1.py con Python. Debería ver resultados parecidos a este ejemplo:

    Captura de pantalla de un terminal que muestra un script de Python para probar el acceso a la memoria caché.

Creación de un script de Python mediante la reautenticación

Los tokens de acceso de Microsoft Entra ID tienen una duración limitada, cuyo promedio es 75 minutos. Para mantener una conexión a la memoria caché, es preciso actualizar el token. En este ejemplo se muestra cómo hacerlo mediante Python.

  1. Cree un archivo de texto y agregue el siguiente script. Luego, guarde el archivo como PythonApplication2.py.

  2. Reemplace <Your Host Name> por el valor de su instancia de Azure Managed Redis (versión preliminar). Su nombre de host tiene el formato <DNS name>.<region>.redis.azure.net.

  3. Reemplace <Your Username> por los valores de su usuario de 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 = 10000
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()

  4. Ejecute PythonApplication2.py con Python. Debería ver resultados parecidos a este ejemplo:

    Captura de pantalla de un terminal que muestra un script de Python para probar el acceso a la memoria caché.

    A diferencia del primer ejemplo, si el token expira, este ejemplo lo actualiza automáticamente.

Creación de un script de Python para acceder a la memoria caché

Cree un script Python que utilice Microsoft Entra ID o claves de acceso para conectarse a su instancia Redis. Se recomienda usar Microsoft Entra ID.

Habilitación de la autenticación de Microsoft Entra ID en la memoria caché

Si tiene una memoria caché, compruebe si se ha habilitado la autenticación de Microsoft Entra. Si no es así, habilítela. Se recomienda usar Microsoft Entra ID para las aplicaciones.

  1. En Azure Portal, seleccione la instancia de Azure Cache for Redis en la que desea usar la autenticación basada en tokens de Microsoft Entra.

  2. Seleccione Autenticación en el menú Recurso.

  3. Actualice el panel de trabajo para ver si está activada Habilitar la autenticación de Microsoft Entra. Si es así, puede continuar.

  4. Seleccione Habilitar autenticación de Microsoft Entra y escriba el nombre de un usuario válido. Al usuario que escriba se le asigna automáticamente una directiva de acceso del propietario de datos de forma predeterminada al seleccionar Guardar. También puede escribir una identidad administrada o una entidad de servicio para conectarse a la instancia de caché.

    Captura de pantalla que muestra la autenticación seleccionada en el menú de recursos y la habilitación de la autenticación de Microsoft Entra activada.

  5. Se muestra un cuadro de diálogo emergente en el que se le pregunta si desea actualizar la configuración e informa de que tarda varios minutos. Seleccione Sí.

    Importante

    Una vez completada la operación de habilitación, los nodos de la instancia de caché se reinician para cargar la nueva configuración. Se recomienda realizar esta operación durante la ventana de mantenimiento o fuera del horario comercial pico. Esta operación puede tardar hasta 30 minutos.

Para obtener información sobre el uso de Microsoft Entra ID con la CLI de Azure, consulte las páginas de referencias para la identidad.

Instalación de la biblioteca de autenticación de Microsoft

  1. Instale la biblioteca de autenticación de Microsoft (MSAL). Esta biblioteca permite adquirir tokens de seguridad de la identidad de Microsoft para autenticar a los usuarios.

  2. Puede usar la biblioteca cliente de identidad de Azure de Python disponible que usa MSAL para proporcionar compatibilidad con la autenticación de tokens. Instale esta biblioteca utilizando pip:

pip install azure-identity

Creación de un script de Python con Microsoft Entra ID

  1. Cree un nuevo archivo de texto, agregue el siguiente script y guarde el archivo como PythonApplication1.py.

  2. Reemplace <Your Host Name> por los valores de su instancia de Azure Cache for Redis. Su nombre de host tiene el formato <DNS name>.redis.cache.windows.net.

  3. Reemplace <Your Username> por los valores de su usuario de 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()

  4. Antes de ejecutar el código de Python desde un terminal, asegúrese de autorizar el terminal para usar Microsoft Entra ID.

    azd auth login

  5. Ejecute PythonApplication1.py con Python. Debería ver resultados parecidos a este ejemplo:

    Captura de pantalla de un terminal que muestra un script de Python para probar el acceso a la memoria caché.

Creación de un script de Python mediante la reautenticación

Los tokens de acceso de Microsoft Entra ID tienen una duración limitada, cuyo promedio es 75 minutos. Para mantener una conexión a la memoria caché, es preciso actualizar el token. En este ejemplo se muestra cómo hacerlo mediante Python.

  1. Cree un archivo de texto y agregue el siguiente script. Luego, guarde el archivo como PythonApplication2.py.

  2. Reemplace <Your Host Name> por los valores de su instancia de Azure Cache for Redis. Su nombre de host tiene el formato <DNS name>.redis.cache.windows.net.

  3. Reemplace <Your Username> por los valores de su usuario de 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()

  4. Ejecute PythonApplication2.py con Python. Debería ver resultados parecidos a este ejemplo:

    Captura de pantalla de un terminal que muestra un script de Python para probar el acceso a la memoria caché.

    A diferencia del primer ejemplo, si el token expira, este ejemplo lo actualiza automáticamente.

Limpieza de recursos

Si desea seguir usando los recursos que creó en este artículo, mantenga el grupo de recursos.

De lo contrario, si ya ha terminado con los recursos, puede eliminar el grupo de recursos de Azure que ha creado para evitar cargos.

Importante

La eliminación de un grupo de recursos es irreversible. Cuando elimine un grupo de recursos, todos los recursos contenidos en él se eliminan permanentemente. Asegúrese de no eliminar por accidente el grupo de recursos o los recursos equivocados. Si ha creado los recursos en un grupo de recursos existente que contiene recursos que desea conservar, puede eliminar cada recurso individualmente en lugar de eliminar el grupo de recursos.

Para eliminar un grupo de recursos

  1. Inicie sesión en Azure Portal y después seleccione Grupos de recursos.

  2. Seleccione el grupo de recursos que desea eliminar.

    Si hay muchos grupos de recursos, use el cuadro Filtro para cualquier campo... y escriba el nombre del grupo de recursos que creó para este artículo. Seleccione el grupo de recursos en la lista de resultados.

    Captura de pantalla que muestra una lista de grupos de recursos para eliminar en el panel de trabajo.

  3. Seleccione Eliminar grupo de recursos.

  4. Se le pedirá que confirme la eliminación del grupo de recursos. Escriba el nombre del grupo de recursos para confirmar y, después, seleccione Eliminar.

    Captura de pantalla que muestra un formulario que requiera el nombre del recurso para confirmar la eliminación.

Transcurridos unos instantes, el grupo de recursos y todos sus recursos se eliminan.

Contenido relacionado