Início Rápido: Utilizar a Cache do Azure para Redis no Python

Ativar a autenticação do Microsoft Entra ID no cache

Se você já tiver um cache, primeiro deseja verificar se a Autenticação do Microsoft Entra foi habilitada. Se não, então habilite-o. Recomendamos o uso do Microsoft Entra ID para seus aplicativos.

1. No portal do Azure, selecione a instância do Cache do Azure para Redis onde você gostaria de usar a autenticação baseada em token do Microsoft Entra.

2. Selecione Autenticação no menu Recurso.

3. Verifique no painel de trabalho se a opção Ativar Autenticação do Microsoft Entra está marcada. Se sim, você pode seguir em frente.

4. Selecione Ativar Autenticação Microsoft Entra e insira o nome de um usuário válido. O usuário inserido recebe automaticamente a Política de Acesso do Proprietário de Dados por padrão quando você seleciona Salvar. Você também pode inserir uma identidade gerenciada ou uma entidade de serviço para se conectar à sua instância de cache.

   

5. Uma caixa de diálogo pop-up é exibida perguntando se você deseja atualizar sua configuração e informando que leva vários minutos. Selecione Yes (Sim).

   Importante

   Quando a operação enable for concluída, os nós em sua instância de cache serão reinicializados para carregar a nova configuração. Recomendamos realizar esta operação durante a janela de manutenção ou fora do horário comercial de pico. A operação pode demorar até 30 minutos.

Para obter informações sobre como usar o Microsoft Entra ID com a CLI do Azure, consulte as páginas de referências para identidade.

Instalar a Biblioteca de Autenticação da Microsoft

1. Instale a Microsoft Authentication Library (MSAL). Essa biblioteca permite que você adquira tokens de segurança da identidade da Microsoft para autenticar usuários.

2. Você pode usar a biblioteca de cliente de identidade do Python Azure disponível que usa o MSAL para fornecer suporte à autenticação de token. Instale esta biblioteca usando pip:

pip install azure-identity

Criar um script Python usando o Microsoft Entra ID

1. Crie um novo arquivo de texto, adicione o seguinte script e salve o arquivo como PythonApplication1.py.

2. Substitua <Your Host Name> pelo valor da sua instância do Cache do Azure para Redis. Seu nome de host é do formato <DNS name>.redis.cache.windows.net.

3. Substitua <Your Username> pelos valores do usuário do 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 executar o código Python a partir de um Terminal, certifique-se de que autoriza o terminal a utilizar o Microsoft Entra ID.

   azd auth login

5. Execute PythonApplication1.py com Python. Você deve ver resultados como o exemplo a seguir:

   

Criar um script Python usando reautenticação

Os tokens de acesso do Microsoft Entra ID têm vida útil limitada, com uma média de 75 minutos. Para manter uma conexão com seu cache, você precisa atualizar o token. Este exemplo demonstra como fazer isso usando Python.

1. Crie um novo arquivo de texto, adicione o seguinte script. Em seguida, salve o arquivo como PythonApplication2.py.

2. Substitua <Your Host Name> pelo valor da sua instância do Cache do Azure para Redis. Seu nome de host é do formato <DNS name>.redis.cache.windows.net.

3. Substitua <Your Username> pelos valores do usuário do 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. Execute PythonApplication2.py com Python. Você deve ver resultados como o exemplo a seguir:

   

   Ao contrário do primeiro exemplo, se o token expirar, este exemplo o atualiza automaticamente.

Recuperar nome de host, portas e chaves de acesso do portal do Azure

Para conectar seu servidor Cache do Azure para Redis, o cliente de cache precisa do nome do host, das portas e de uma chave para o cache. Alguns clientes podem mencionar esses itens com nomes ligeiramente diferentes. Você pode obter o nome do host, as portas e as chaves no portal do Azure.

• Para obter as chaves de acesso, selecione Autenticação no menu Recurso. Em seguida, selecione a guia Teclas de acesso.

  

• Para obter o nome do host e as portas do cache, selecione Visão geral no menu Recurso. O nome do host é do formato <DNS name.redis.cache.windows.net>.

  

Ler e gravar no cache a partir da linha de comando

Execute Python a partir da linha de comando para testar seu cache. Primeiro, inicie o interpretador Python em sua linha de comando digitando pye, em seguida, use o código a seguir. Substitua <Your Host Name> e <Your Access Key> pelos valores da sua instância do Cache do Azure para Redis. Seu nome de host é do 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'

Criar um script Python usando teclas de acesso

Crie um novo arquivo de texto, adicione o seguinte script e salve o arquivo como PythonApplication1.py. Substitua <Your Host Name> e <Your Access Key> pelos valores da sua instância do Cache do Azure para Redis. Seu nome de host é do formato <DNS name>.redis.cache.windows.net.

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']}")

Execute PythonApplication1.py com Python. Você deve ver resultados como o exemplo a seguir: