Schnellstart: Verwenden von Azure Cache for Redis mit einer Python-App

Aktivieren der auf Microsoft Entra ID basierenden Authentifizierung in Ihrem Cache

Überprüfen Sie bei einem vorhandenen Cache, ob die Microsoft Entra-Authentifizierung aktiviert ist. Falls nicht, führen Sie die folgenden Schritte aus, um die Microsoft Entra-Authentifizierung zu aktivieren. Wir empfehlen, Microsoft Entra ID für die Authentifizierung in Ihren Anwendungen zu verwenden.

1. Wählen Sie im Azure-Portal die Azure Cache for Redis-Instanz aus, in der Sie die tokenbasierte Microsoft Entra-Authentifizierung verwenden möchten.

2. Wählen Sie im Dienstmenü unter Einstellungen die Option Authentifizierung aus.

3. Überprüfen Sie im Bereich Authentifizierung, ob das Kontrollkästchen Microsoft Entra-Authentifizierung aktivieren aktiviert ist. Falls ja, können Sie mit dem nächsten Abschnitt fortfahren.

4. Aktivieren Sie andernfalls das Kontrollkästchen Microsoft Entra-Authentifizierung aktivieren. Geben Sie dann den Namen eines gültigen Benutzers ein. Wählen Sie Speichern. Dem eingegebenen Benutzernamen wird automatisch die Datenbesitzer-Zugriffsrichtlinie zugewiesen.

   Sie können auch eine verwaltete Identität oder einen Dienstprinzipal eingeben, um eine Verbindung mit Ihrem Cache herzustellen.

   

5. In einem Dialogfeld werden Sie gefragt, ob Sie Ihre Konfiguration aktualisieren möchten, und werden informiert, dass die Aktualisierung mehrere Minuten dauert. Wählen Sie Ja aus.

   Wichtig

   Nach Abschluss des Aktivierungsvorgangs werden die Knoten in Ihrem Cache neu gestartet, um die neue Konfiguration zu laden. Wir empfehlen, dass Sie diesen Vorgang während des Standardwartungsfensters oder außerhalb der Hauptgeschäftszeiten durchführen. Der Vorgang kann bis zu 30 Minuten dauern.

Informationen zur Verwendung von Microsoft Entra ID mit der Azure CLI finden Sie auf den Referenzseiten zur Identität.

Installieren der Microsoft-Authentifizierungsbibliothek

Die Microsoft-Authentifizierungsbibliothek (Microsoft Authentication Library, MSAL) ruft Sicherheitstoken von Microsoft Identity Platform ab, um Benutzer zu authentifizieren.

So installieren Sie die MSAL

1. Installieren Sie MSAL für Python.

2. Installieren Sie die Azure Identity-Clientbibliothek für Python. Die Bibliothek verwendet MSAL, um Unterstützung für die Tokenauthentifizierung bereitzustellen.

   Installieren Sie diese Bibliothek mithilfe von pip:

pip install azure-identity

Erstellen eines Python-Skripts mithilfe von Microsoft Entra ID

1. Erstellen einer Textdatei Speichern Sie die Datei unter PythonApplication1.py.

2. Fügen Sie in PythonApplication1.py das folgende Skript hinzu, und ändern Sie es.

   Im Skript:

   • Ersetzen Sie <Your Host Name> durch den Wert für Ihre Azure Cache for Redis-Instanz. Der Hostname weist folgendes Format auf: <DNS name>.redis.cache.windows.net.
   • Ersetzen Sie <Your Username> durch den Wert für Ihren Microsoft Entra ID-Benutzer.

   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. Bevor Sie Ihren Python-Code über ein Terminal ausführen, autorisieren Sie das Terminal für die Verwendung von Microsoft Entra ID:

   azd auth login

4. Führen Sie die Datei PythonApplication1.py mithilfe von Python aus. Stellen Sie sicher, dass die Ausgabe dem folgenden Beispiel ähnelt:

   

Erstellen eines Python-Skripts mithilfe einer erneuten Authentifizierung

Ein Microsoft Entra ID-Zugriffstoken hat eine begrenzte Lebensdauer von etwa 75 Minuten. Um eine Verbindung zum Cache aufrechtzuerhalten, müssen Sie das Token aktualisieren.

Das Aktualisieren eines Token mithilfe von Python wird im folgenden Beispiel veranschaulicht.

1. Erstellen einer Textdatei Speichern Sie die Datei unter PythonApplication2.py.

2. Fügen Sie in PythonApplication2.py das folgende Skript hinzu, und ändern Sie es.

   Im Skript:

   • Ersetzen Sie <Your Host Name> durch den Wert für Ihre Azure Cache for Redis-Instanz. Der Hostname weist folgendes Format auf: <DNS name>.redis.cache.windows.net.
   • Ersetzen Sie <Your Username> durch den Wert für Ihren Microsoft Entra ID-Benutzer.

   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. Führen Sie die Datei PythonApplication2.py mithilfe von Python aus. Stellen Sie sicher, dass die Ausgabe dem folgenden Beispiel ähnelt:

   

   Im Gegensatz zum vorherigen Beispiel aktualisiert der Code in diesem Beispiel das Token automatisch, wenn es abläuft.

Abrufen des Hostnamens, der Ports und des Zugriffsschlüssels

Um Ihren Azure Cache for Redis-Server zu verbinden, benötigt der Cacheclient den Hostnamen des Cache, die Ports und einen Zugriffsschlüssel. Einige Clients verweisen möglicherweise mit geringfügig anderen Namen auf diese Elemente. Sie finden Hostname, Ports und Schlüssel im Azure-Portal.

• So rufen Sie einen Zugriffsschlüssel für Ihren Cache ab

  1. Navigieren Sie im Azure-Portal zu Ihrem Cache.
  2. Wählen Sie im Dienstmenü unter Einstellungen die Option Authentifizierung aus.
  3. Wählen Sie im Bereich Authentifizierung die Registerkarte Zugriffsschlüssel aus.
  4. Um den Wert für einen Zugriffsschlüssel zu kopieren, wählen Sie im Schlüsselfeld das Symbol Kopieren aus.

  

• So rufen Sie den Hostnamen und die Ports für Ihren Cache ab

  1. Navigieren Sie im Azure-Portal zu Ihrem Cache.
  2. Wählen Sie im Dienstmenü die Option Übersicht aus.
  3. Wählen Sie unter Grundlagen für Hostname das Symbol Kopieren aus, um den Hostnamenwert zu kopieren. Der Hostnamenwert hat das Format <DNS name>.redis.cache.windows.net.
  4. Wählen Sie für Ports das Symbol Kopieren aus, um die Portwerte zu kopieren.

  

Lesen und Schreiben in den Cache über die Befehlszeile

Führen Sie Python über die Befehlszeile aus, um den Cache zu testen.

1. Initiieren Sie den Python-Interpreter in Ihrer Befehlszeile, indem Sie py eingeben.

2. Ändern Sie den folgenden Code, und führen Sie ihn dann aus.

   Ersetzen Sie im Code <Your Host Name> und <Your Access Key> durch die Werte für Ihre Azure Cache for Redis-Instanz. Der Hostname weist folgendes Format auf: <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'
   

Erstellen eines Python-Skripts mithilfe von Zugriffsschlüssen

1. Erstellen Sie eine neue Textdatei. Speichern Sie die Datei unter PythonApplication1.py.

2. Fügen Sie in PythonApplication1.py das folgende Skript hinzu, und ändern Sie es.

   Im Skript:

   • Ersetzen Sie <Your Host Name> durch den Wert für Ihre Azure Cache for Redis-Instanz. Der Hostname weist folgendes Format auf: <DNS name>.redis.cache.windows.net.
   • Ersetzen Sie <Your Access Key> durch den Wert für Ihren Microsoft Entra ID-Benutzer.

   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. Führen Sie die Datei PythonApplication1.py mithilfe von Python aus. Überprüfen Sie, ob die Ergebnisse wie im folgenden Beispiel als Ausgabe angezeigt werden: