Inicio rápido: Uso de Azure Cache for Redis con una aplicación de Python

En este inicio rápido, incorporará Azure Cache for Redis en un script de Python para acceder a una caché dedicada y segura, a la que se puede acceder desde cualquier aplicación de Azure.

Ir al código

En este artículo se describe cómo crear una aplicación de Python y, a continuación, modificar el código para obtener una aplicación de ejemplo que funcione.

Si quiere pasar directamente al código, consulte Ejemplo de inicio rápido de Python en GitHub.

Requisitos previos

• Suscripción a Azure. Crear una cuenta gratuita
• Python 3
  • Para macOS o Linux, descargue desde python.org.
  • Para Windows 11, use la Tienda Windows.

Creación de una caché

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

   

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, seleccioneCrear.

   

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:

   

   • 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 Azure Redis Cache. Use la herramienta de paquetes de Python, pip, para instalar el paquete redis-py desde una línea de comandos.

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

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

Cree un script de Python para que use Microsoft Entra ID o claves de acceso para conectarse a una instancia de Azure Cache for Redis. Se recomienda usar Microsoft Entra ID.

Autenticación de Microsoft Entra ID (recomendado)

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

Para una caché existente, compruebe primero si la autenticación de Microsoft Entra está habilitada. Si no es así, complete los pasos siguientes para habilitar la autenticación de Microsoft Entra. Se recomienda usar Microsoft Entra ID para la autenticación de 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. En el menú Servicio, en Configuración, seleccione Autenticación.

3. En el panel Autenticación, compruebe si la casilla Habilitar autenticación de Microsoft Entra está activada. Si es así, puede pasar a la sección siguiente.

4. De lo contrario, active la casillaHabilitar autenticación de Microsoft Entra. A continuación, escriba el nombre de un usuario válido. Seleccione Guardar. El nombre de usuario que escriba se asigna automáticamente a la directiva de acceso del propietario de datos.

   También puede escribir una identidad administrada o una entidad de servicio para conectarse a la memoria caché.

   

5. En un cuadro de diálogo, se le pregunta si desea actualizar la configuración y se le informa de que la actualización tarda varios minutos en finalizar. Seleccione Sí.

   Importante

   Cuando finaliza la operación de habilitación, los nodos de la caché se reinician para cargar la nueva configuración. Se recomienda completar esta operación durante la ventana de mantenimiento estándar o fuera de las horas punta del horario comercial. El proceso puede tardar hasta 30 minutos.

Para más información sobre el uso de Microsoft Entra ID con la CLI de Azure, consulte las páginas de referencia de identidad.

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

La biblioteca de autenticación de Microsoft (MSAL) adquiere tokens de seguridad de la plataforma de identidad de Microsoft para autenticar usuarios.

Para instalar MSAL:

1. Instale MSAL para Python.

2. Instale la biblioteca cliente de Azure Identity para Python. La biblioteca usa MSAL para proporcionar compatibilidad con la autenticación de tokens.

   Instale esta biblioteca mediante pip:

pip install azure-identity

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

1. Crear un archivo de texto Guarde el archivo como PythonApplication1.py.

2. En PythonApplication1.py, agregue y modifique el siguiente script.

   En el script:

   • 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.
   • Reemplace <Your Username> por el valor 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()
   

3. Antes de ejecutar el código de Python en un terminal, autorice al terminal para que use Microsoft Entra ID:

   azd auth login

4. Ejecute el archivo PythonApplication1.py mediante Python. Compruebe que la salida es similar a la de este ejemplo:

   

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

Un token de acceso de Microsoft Entra ID tiene una duración limitada de aproximadamente 75 minutos. Para mantener una conexión a la memoria caché, debe actualizar el token.

En este ejemplo se muestra cómo actualizar el token mediante Python:

1. Crear un archivo de texto Guarde el archivo como PythonApplication2.py.

2. En PythonApplication2.py, agregue y modifique el siguiente script.

   En el script:

   • 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.
   • Reemplace <Your Username> por el valor 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()
   

3. Ejecute el archivo PythonApplication2.py mediante Python. Compruebe que la salida es similar a la de este ejemplo:

   

   A diferencia del ejemplo anterior, si el token expira, el código de este ejemplo actualiza automáticamente el token.

Autenticación de clave de acceso

Obtención del nombre de host, los puertos y la clave de acceso

Para conectarse al servidor de Azure Cache for Redis, el cliente de la caché necesita el nombre de host, los puertos y una clave de acceso de la caché. Es posible que algunos clientes utilicen nombres ligeramente diferentes para estos elementos. Puede obtener el nombre de host, los puertos y las claves en Azure Portal.

• Para obtener una clave de acceso para la memoria caché:

  1. En Azure Portal, acceda a la caché.
  2. En el menú Servicio, en Configuración, seleccione Autenticación.
  3. En el panel Autenticación, seleccione la pestaña Claves de acceso.
  4. Para copiar el valor de una clave de acceso, seleccione el icono Copiar en el campo de clave.

  

• Para obtener el nombre de host y los puertos de la memoria caché:

  1. En Azure Portal, acceda a la caché.
  2. En el menú Servicio, seleccione Información general.
  3. En Información esencial, para Nombre de host, seleccione el icono Copiar para copiar el valor del nombre de host. El valor del nombre de host tiene el formato <DNS name>.redis.cache.windows.net.
  4. En Puertos, seleccione el icono Copiar para copiar los valores de puerto.

  

Lectura y escritura en la memoria caché desde la línea de comandos

Para probar la memoria caché, ejecute Python desde la línea de comandos.

1. Para iniciar el intérprete de Python en la línea de comandos, escriba py.

2. Modifique y ejecute el código siguiente.

   En el código, reemplace <Your Host Name> y <Your Access Key> por los valores de su instancia de Azure Cache for Redis. Su nombre de host tiene el formato <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'
   

Creación de un script de Python mediante claves de acceso

1. Cree un nuevo archivo de texto. Guarde el archivo como PythonApplication1.py.

2. En PythonApplication1.py, agregue y modifique el siguiente script.

   En el script:

   • 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.
   • Reemplace <Your Access Key> por el valor de su usuario de 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']}")
   

3. Ejecute el archivo PythonApplication1.py mediante Python. Compruebe que los resultados como el ejemplo siguiente aparecen como salida:

   

Limpieza de recursos

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

De lo contrario, para evitar cargos relacionados con los recursos, si ha terminado de usarlos, puede eliminar el grupo de recursos de Azure que creó.

Advertencia

La eliminación de un grupo de recursos es irreversible. Cuando elimine un grupo de recursos, todos los recursos del grupo 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 tiene recursos que desea conservar, puede eliminar cada recurso individualmente en lugar de eliminar el grupo de recursos.

Eliminación de 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 se eliminará.

   Si hay muchos grupos de recursos, en Filtro para cualquier campo, escriba el nombre del grupo de recursos que creó para completar este artículo. En la lista de resultados de búsqueda, seleccione el grupo de recursos.

   

3. Seleccione Eliminar grupo de recursos.

4. En el panel Eliminar un grupo de recursos, escriba el nombre del grupo de recursos para confirmar y, a continuación, seleccione Eliminar.

   

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

Contenido relacionado

• Creación de una aplicación web ASP.NET que usa Azure Cache for Redis