Verwenden eines externen Redis-kompatiblen Caches in Azure API Management

GILT FÜR: Alle API Management-Ebenen

Zusätzlich zum integrierten Cache können Sie mit Azure API Management Antworten in einem externen, mit Redis kompatiblen Cache zwischenspeichern, z. B. in Azure Cache for Redis.

Durch die Verwendung eines externen Caches lassen sich einige Einschränkungen des integrierten Caches umgehen:

• Vermeidung der regelmäßigen Löschung Ihres Caches im Zuge von API Management-Updates
• Mehr Kontrolle über Ihre Cachekonfiguration
• Zwischenspeichern von mehr Daten als mit Ihrem API Management-Tarif
• Verwendung der Zwischenspeicherung mit dem Verbrauchstarif von API Management
• Aktivieren des Zwischenspeicherns im selbstgehosteten API Management-Gateway

Ausführlichere Informationen zum Zwischenspeichern finden Sie unter Cacherichtlinien für API Management sowie unter Benutzerdefiniertes Zwischenspeichern in Azure API Management.

Sie lernen Folgendes:

Voraussetzungen

Für dieses Tutorial benötigen Sie Folgendes:

• Erstellen einer neuen Azure API Management-Dienstinstanz
• Verständnis der Zwischenspeicherung in Azure API Management

Erstellen von Azure Cache for Redis

In diesem Abschnitt erfahren Sie, wie Sie eine Azure Cache for Redis-Instanz in Azure erstellen. Wenn Sie bereits über eine Azure Cache for Redis-Instanz oder einen anderen mit Redis kompatiblen Cache innerhalb oder außerhalb von Azure verfügen, können Sie direkt mit dem nächsten Abschnitt fortfahren.

1. Um einen Cache zu erstellen, melden Sie sich im Azure-Portal an. Klicken Sie im Menü des Portals auf Ressource erstellen.

   

2. Geben Sie auf der Seite Erste Schritte den Begriff Azure Cache for Redis in das Suchfeld ein. Suchen Sie in den Suchergebnissen Azure Cache for Redis, und wählen Sie dann Erstellen aus.

   

3. Konfigurieren Sie im Bereich Neuen Redis-Cache auf der Registerkarte Grundlagen die folgenden Einstellungen für Ihren Cache:

   Einstellung	Aktion	Beschreibung
   Abonnement	Wählen Sie Ihr Azure-Abonnement.	Das Abonnement, das zum Erstellen der neuen Instanz von Azure Cache for Redis verwendet werden soll.
   Ressourcengruppe	Wählen Sie eine Ressourcengruppe aus, oder wählen Sie Neu erstellen aus, und geben Sie einen Namen für eine neue Ressourcengruppe ein.	Der Name der Ressourcengruppe, in der Ihr Cache und weitere Ressourcen erstellt werden. Wenn Sie alle Ihre App-Ressourcen in einer Ressourcengruppe zusammenfassen, können Sie sie einfacher gemeinsam verwalten oder löschen.
   DNS-Name	Geben Sie einen eindeutigen Namen ein.	Der Cachename muss eine Zeichenfolge von 1 bis 63 Zeichen sein, die nur Zahlen, Buchstaben und Bindestriche enthält. Der Name muss mit einer Zahl oder einem Buchstaben beginnen und enden und darf keine aufeinanderfolgenden Bindestriche enthalten. Der Hostname Ihrer Cache-Instanz ist \<DNS name>.redis.cache.windows.net.
   Location	Wählen Sie einen Standort aus.	Eine Azure-Region, die sich in der Nähe anderer Dienste befindet, die Ihren Cache verwenden.
   Cache-SKU	Wählen Sie eine SKU aus.	Die SKU bestimmt die Parameter für Größe, Leistung und Features, die für den Cache verfügbar sind. Weitere Informationen finden Sie unter Azure Cache for Redis.
   Cachegröße	Wählen Sie eine Cachegröße aus.	Weitere Informationen finden Sie unter Azure Cache for Redis.

4. Wählen Sie die Registerkarte Netzwerk, oder wählen Sie Weiter: Netzwerke.

5. Wählen Sie auf der Registerkarte Netzwerk eine Konnektivitätsmethode für den Cache aus.

6. Wählen Sie die Registerkarte Erweitert aus, oder wählen Sie Weiter: Erweitert aus.

7. Überprüfen oder wählen Sie im Bereich Erweitert basierend auf den folgenden Informationen eine Authentifizierungsmethode aus:

   

   • Standardmäßig ist für einen neuen Basic-, Standard- oder Premium-Cache die Microsoft Entra-Authentifizierung aktiviert und die Authentifizierung mit Zugriffsschlüsseln deaktiviert.
   • Für Basic- oder Standard-Caches können Sie sich für die Auswahl eines Nicht-TLS-Ports entscheiden.
   • Für Standard- und Premium-Caches können Sie Verfügbarkeitszonen aktivieren. Verfügbarkeitszonen können nach der Erstellung des Caches nicht deaktiviert werden.
   • Konfigurieren Sie für ein Premium-Cache die Einstellungen für einen Nicht-TLS-Port, das Clustering, die verwaltete Identität und die Datenpersistenz.

   Wichtig

   Für eine optimale Sicherheit empfehlen wir, Microsoft Entra ID mit verwalteten Identitäten zu verwenden, um Anforderungen nach Möglichkeit für Ihren Cache zu autorisieren. Die Autorisierung mit Microsoft Entra ID und verwalteten Identitäten bietet eine höhere Sicherheit und Benutzerfreundlichkeit als die Autorisierung mit gemeinsam verwendetem Schlüssel. Weitere Informationen zum Verwenden verwalteter Identitäten mit Ihren Caches finden Sie unter Verwenden von Microsoft Entra ID für die Cacheauthentifizierung.

8. (Optional) Wählen Sie die Registerkarte Kategorien aus, oder wählen Sie Weiter: Kategorien aus.

9. Geben Sie optional auf der Registerkarte Kategorien den Namen und den Wert ein, wenn Sie die Cacheressource kategorisieren möchten.

10. Wählen Sie die Schaltfläche Überprüfen + erstellen aus.

    Auf der Registerkarte Überprüfen und Erstellen überprüft Azure automatisch Ihre Konfiguration.

11. Wenn die grüne Meldung Validierung erfolgreich angezeigt wird, wählen Sie Erstellen aus.

Eine neue Cachebereitstellung erfolgt über mehrere Minuten hinweg. Sie können den Fortschritt der Bereitstellung im Azure Cache for Redis -Übersichtsbereich überwachen. Wenn der Status Wird ausgeführt anzeigt, kann der Cache verwendet werden.

Bereitstellen von Redis Cache in Kubernetes

Bei einem selbstgehosteten Gateway benötigt das Zwischenspeichern einen externen Cache. Damit das Zwischenspeichern effektiv ist, müssen sich das selbstgehostete Gateway und der Cache, auf dem es basiert, nah beieinander befinden, um Wartezeiten beim Lookup und dem Speichern zu minimieren. Das Bereitstellen eines Redis Cache im selben Kubernetes-Cluster oder in einem gesonderten Cluster in der Nähe sind die besten Optionen. Hier erfahren Sie, wie Sie einen Redis-Cache in einem Kubernetes-Cluster bereitstellen.

Hinzufügen eines externen Caches

Gehen Sie wie folgt vor, um Azure API Management einen externen, mit Redis kompatiblen Cache hinzuzufügen. Sie können den Cache auf ein bestimmtes Gateway in Ihrer API Management-Instanz beschränken.

Einstellung „Verwenden aus“

Die Einstellung Verwenden aus in der Konfiguration gibt den Speicherort Ihrer API Management-Instanz an, die den Cache verwendet. Wählen Sie eines der folgenden Szenarien aus:

• Die Azure-Region, in der die API Management-Instanz gehostet wird, oder einer der konfigurierten Speicherorte, wenn Sie über eine Bereitstellung mit mehreren Regionen verfügen

• Ein selbstgehosteter Gatewayspeicherort

• Standard, um den Cache als Standard für alle Gatewayspeicherorte in der API Management-Instanz zu konfigurieren

  Ein für Standard verwendeter Cache wird von einem Cache außer Kraft gesetzt, der für eine bestimmte übereinstimmende Region oder einen Speicherort verwendet wird.

  Betrachten Sie beispielsweise eine API Management-Instanz, die in den Regionen „USA, Osten“, „Asien, Südosten“ und „Europa, Westen“ gehostet wird. Zwei Caches sind konfiguriert, einer für Standard und einer für Asien, Südosten. In diesem Beispiel verwendet API Management in Asien, Südosten einen eigenen Cache, während die anderen beiden Regionen den Cache-Eintrag Standard nutzen.

Hinzufügen einer Azure Cache for Redis-Instanz aus dem gleichen Abonnement

1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
2. Wählen Sie im Menü auf der linken Seite die Registerkarte External cache (Externer Cache) aus.
3. Wählen Sie die Schaltfläche + Hinzufügen aus.
4. Wählen Sie im Dropdownfeld Cache instance (Cacheinstanz) Ihren Cache aus.
5. Wählen Sie Standard aus, oder geben Sie im Dropdownfeld Verwenden aus die gewünschte Region an.
6. Wählen Sie Speichern aus.

Hinzufügen eines mit Redis kompatiblen Caches, der außerhalb des aktuellen Azure-Abonnements oder außerhalb von Azure gehostet wird

1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
2. Wählen Sie im Menü auf der linken Seite die Registerkarte External cache (Externer Cache) aus.
3. Wählen Sie die Schaltfläche + Hinzufügen aus.
4. Wählen Sie im Dropdownfeld Cache instance (Cacheinstanz) die Option Benutzerdefiniert aus.
5. Wählen Sie Standard aus, oder geben Sie im Dropdownfeld Verwenden aus die gewünschte Region an.
6. Geben Sie im Feld Verbindungszeichenfolge die Verbindungszeichenfolge Ihrer Azure Cache for Redis-Instanz oder Ihres mit Redis kompatiblen Caches an.
7. Wählen Sie Speichern aus.

Hinzufügen eines Redis Cache zu einem selbstgehosteten Gateway

1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
2. Wählen Sie im Menü auf der linken Seite die Registerkarte External cache (Externer Cache) aus.
3. Wählen Sie die Schaltfläche + Hinzufügen aus.
4. Wählen Sie im Dropdownfeld Cache instance (Cacheinstanz) die Option Benutzerdefiniert aus.
5. Geben Sie den gewünschten Standort des selbstgehosteten Gateways oder Standard im Dropdownfeld Verwenden aus an.
6. Geben Sie im Feld Verbindungszeichenfolge die Verbindungszeichenfolge Ihres Redis-Caches an.
7. Wählen Sie Speichern aus.

Verwenden des externen Caches

Konfigurieren Sie Zwischenspeicherungsrichtlinien zum Aktivieren des Zwischenspeicherns von Antworten oder Werten nach Schlüssel im externen Cache, nachdem Sie einen mit Redis kompatiblen Cache hinzugefügt haben.

Ein ausführliches Beispiel finden Sie unter Hinzufügen des Zwischenspeicherns zum Verbessern der Leistung in Azure API Management.

Nächste Schritte

• Weitere Informationen zu Richtlinien für die Zwischenspeicherung finden Sie unter Richtlinien für die Zwischenspeicherung in der Richtlinienreferenz für API Management.
• Informationen zum Zwischenspeichern von Elementen nach Schlüssel mithilfe von Richtlinienausdrücken finden Sie unter Benutzerdefiniertes Zwischenspeichern in Azure API Management.