Utiliser un cache externe compatible Redis dans Gestion des API Azure

S’APPLIQUE À : Tous les niveaux de Gestion des API

En plus de l’utilisation du cache intégré, Gestion des API Azure permet la mise en cache externe compatible Redis, comme un Cache Azure pour Redis.

L’utilisation d’un cache externe vous permet de pallier quelques limites du cache intégré :

• Éviter que votre cache soit régulièrement effacé lors des mises à jour de Gestion des API
• Obtenir un plus grand contrôle sur la configuration de votre cache
• Mettre en cache plus de données que ce que votre niveau Gestion des API ne vous le permet
• Utiliser la mise en cache avec le niveau Consommation de Gestion des API
• Activer la mise en cache dans les passerelles auto-hébergées de gestion des API

Pour plus d’informations sur la mise en cache, consultez Stratégies de mise en cache dans Gestion des API et Mise en cache personnalisée dans Gestion des API Azure.

Remarque

Actuellement, cette fonctionnalité n’est pas disponible dans les espaces de travail.

Ce que vous allez apprendre :

• Ajouter un cache externe dans Gestion des API

Prérequis

Pour suivre ce didacticiel, vous devez effectuer les opérations suivantes :

• Créer une instance du service Gestion des API Azure
• Comprendre la mise en cache dans Gestion des API Azure

Créer un cache Azure pour Redis

Cette section explique comment créer un Cache Azure pour Redis dans Azure. Si vous disposez déjà d’un Cache Azure pour Redis, dans ou en dehors d’Azure, vous pouvez passer à la section suivante.

1. Pour créer un cache, connectez-vous au portail Azure. Dans le menu du portail, sélectionnez Créer une ressource.

   

2. Dans le volet Démarrer, entrez Azure Cache pour Redis dans la barre de recherche. Dans les résultats de la recherche, localisez Azure Cache pour Redis, puis sélectionnez Créer.

   

3. Dans le volet Nouveau cache Redis, sous l’onglet Informations de base, configurez les paramètres suivants pour votre cache :

   Setting	Action	Description
   Abonnement	Sélectionnez votre abonnement Azure.	L’abonnement à utiliser pour créer l’instance d’Azure Cache pour Redis.
   Groupe de ressources	Sélectionnez un groupe de ressources ou choisissez Créer nouveau, puis entrez un nouveau nom de groupe de ressources.	Le nom du groupe de ressources dans lequel créer votre cache et d’autres ressources. En plaçant toutes les ressources de votre application dans un seul groupe de ressources, vous pouvez facilement les gérer ou les supprimer ensemble.
   Nom DNS	Entrez un nom unique.	Le nom du cache doit être une chaîne de 1 à 63 caractères ne contenant que des chiffres, des lettres et des traits d’union. Le nom doit commencer et se terminer par un chiffre ou une lettre, et ne doit pas contenir de traits d’union consécutifs. Le nom d’hôte de votre instance de cache est \<DNS name>.redis.cache.windows.net.
   Emplacement	Sélectionnez un emplacement.	Une région Azure proche d’autres services qui utilisent votre cache.
   Référence SKU du cache	Sélectionnez une référence SKU.	La référence SKU détermine les paramètres de taille, de performance et de fonctionnalités disponibles pour le cache. Pour plus d’informations, consultez Présentation d’Azure Cache pour Redis.
   Taille du cache	Sélectionnez une taille de cache.	Pour plus d’informations, consultez Présentation d’Azure Cache pour Redis.

4. Sélectionnez l’onglet Mise en réseau ou sélectionnez Suivant : Mise en réseau.

5. Sous l’onglet Mise en réseau, sélectionnez une méthode de connectivité à utiliser pour le cache.

6. Sélectionnez l’onglet Avancé ou sélectionnez Suivant : Avancé.

7. Dans le volet Avancé, vérifiez ou sélectionnez une méthode d’authentification en fonction des informations suivantes :

   

   • Par défaut, pour un nouveau cache Basic, Standard ou Premium, l’authentification Microsoft Entra est activée et l’authentification par clés d’accès est désactivée.
   • Pour les caches Basic ou Standard, vous pouvez choisir la sélection d'un port non TLS.
   • Pour les caches Standard et Premium, vous pouvez choisir d'activer les zones de disponibilité. Vous ne pouvez pas désactiver les zones de disponibilité une fois le cache créé.
   • Pour un cache Premium, configurez les paramètres afin d’utiliser un port non-TLS, le clustering, l’identité managée et la persistance des données.

   Important

   Pour bénéficier d’une sécurité optimale, nous vous recommandons d’utiliser si possible Microsoft Entra ID avec des identités managées pour autoriser les requêtes sur votre cache. L’autorisation avec Microsoft Entra ID et les identités managées offre davantage de sécurité et de facilité d’utilisation que l’autorisation par clé d’accès partagée. Pour plus d’informations sur l’utilisation d’identités managées avec votre cache, consultez Utiliser Microsoft Entra ID pour l’authentification du cache.

8. (Facultatif) Sélectionnez l’onglet Étiquettes ou sélectionnez Suivant : Étiquettes.

9. (Facultatif) Sous l’onglet Étiquettes, entrez un nom et une valeur d’étiquette si vous voulez catégoriser votre ressource de cache.

10. Sélectionnez le bouton Vérifier + Créer.

    Sous l’onglet Vérifier et créer, Azure vérifie automatiquement votre configuration.

11. Une fois que le message vert Validation réussie s’affiche, sélectionnez Créer.

Le déploiement d’un nouveau cache prend plusieurs minutes. Vous pouvez surveiller la progression du déploiement dans le volet Vue d’ensemble d’Azure Cache pour Redis. Lorsque État indique En cours d’exécution, le cache est prêt à être utilisé.

Déployer le cache Redis sur Kubernetes

Pour une passerelle auto-hébergée, la mise en cache nécessite un cache externe. Pour que la mise en cache soit efficace, une passerelle auto-hébergée et le cache sur lequel elle s’appuie doivent être situés à proximité de chaque élément afin de minimiser les latences de recherche et de stockage. Le déploiement d’un cache Redis dans le même cluster Kubernetes ou dans un cluster distinct à proximité est le meilleur choix. Découvrez comment déployer le cache Redis sur un cluster Kubernetes.

Ajouter un cache externe

Suivez les étapes ci-dessous pour ajouter un cache compatible Redis externe dans Gestion des API Azure. Vous pouvez limiter le cache à une passerelle spécifique dans votre instance Gestion des API.

Utiliser à partir du paramètre

L’utilisation à partir du paramètre dans la configuration spécifie l’emplacement de votre instance de Gestion des API qui utilisera le cache. Sélectionnez l’un des suivants :

• La région Azure où l’instance Gestion des API est hébergée (ou l’un des emplacements configurés, si vous avez un déploiement multirégion)

• Une passerelle auto-hébergée

• Par défaut, pour configurer le cache comme valeur par défaut pour tous les emplacements de passerelle dans l’instance Gestion des API

  Un cache utilisé par Défaut est remplacé par un cache utilisé pour une région ou un emplacement correspondant spécifique.

  Par exemple, considérez une instance Gestion des API hébergée dans les régions USA Est, Asie Sud-Est et Europe Ouest. Il existe deux caches configurés, un par Défaut et un pour l’Asie Sud-Est. Dans cet exemple, Gestion des API en Asie du Sud-Est utilise son propre cache, tandis que les deux autres régions utilisent l’entrée de cache par défaut.

Notes

Vous pouvez configurer le même cache externe pour plusieurs instances Gestion des API. Les instances Gestion des API peuvent se trouver dans la même région ou des régions différentes. Lorsque vous partagez le cache pour plusieurs instances, vous devez sélectionner Par défaut dans le paramètre Utiliser à partir de .

Ajouter un Cache Azure pour Redis à partir du même abonnement

1. Accédez à votre instance Gestion des API dans le portail Azure.
2. Sélectionnez l’onglet Cache externe dans le menu de gauche.
3. Sélectionnez le bouton + Ajouter.
4. Sélectionnez votre cache dans la liste déroulante Instance de cache.
5. Sélectionnez Par défaut ou précisez la région souhaitée dans la zone de liste déroulante Utiliser à partir de.
6. Sélectionnez Enregistrer.

Ajouter un cache Redis hébergé en dehors de l’abonnement Azure actuel ou d’Azure en général

1. Accédez à votre instance Gestion des API dans le portail Azure.
2. Sélectionnez l’onglet Cache externe dans le menu de gauche.
3. Sélectionnez le bouton + Ajouter.
4. Sélectionnez Personnalisé dans la zone de liste déroulante Instance de cache.
5. Sélectionnez Par défaut ou précisez la région souhaitée dans la zone de liste déroulante Utiliser à partir de.
6. Indiquez la chaîne de connexion de votre Cache Azure pour Redis (ou cache compatible Redis) dans le champ Chaîne de connexion.
7. Sélectionnez Enregistrer.

Ajouter un cache Redis à une passerelle auto-hébergée

1. Accédez à votre instance Gestion des API dans le portail Azure.
2. Sélectionnez l’onglet Cache externe dans le menu de gauche.
3. Sélectionnez le bouton + Ajouter.
4. Sélectionnez Personnalisé dans la zone de liste déroulante Instance de cache.
5. Spécifiez l’emplacement de la passerelle auto-hébergée souhaitée ou Par défaut dans le champ déroulant Utiliser à partir de .
6. Indiquez la chaîne de connexion de votre cache Redis dans le champ Chaîne de connexion.
7. Sélectionnez Enregistrer.

Utiliser le cache externe

Après avoir ajouté un cache compatible Redis, configurez les stratégies de mise en cache pour activer la mise en cache de réponse ou la mise en cache des valeurs par clé, dans le cache externe.

Pour les instructions détaillées, consultez Ajouter une mise en cache pour améliorer les performances de Gestion des API Azure.

Étapes suivantes

• Pour plus d’informations sur les stratégies de mise en cache, voir la section Stratégies de mise en cache dans Référence de stratégie de Gestion des API.
• Pour plus d’informations sur la mise en cache des éléments par clé à l’aide d’expressions de stratégie, consultez Mise en cache personnalisée dans la gestion des API Azure.