Démarrage rapide : utiliser des caches Azure Redis dans .NET Framework

Dans ce guide de démarrage rapide, vous allez incorporer le cache Azure pour Redis dans une application .NET Framework pour avoir accès à un cache sécurisé et dédié accessible à partir de n’importe quelle application dans Azure. Vous utiliserez spécifiquement le client StackExchange.Redis avec du code C# dans une application console .NET.

Passer au code sur GitHub

Clonez le référentiel à partir de Azure-Samples/azure-cache-redis-samples sur GitHub.

Prérequis

• Abonnement Azure : créez-en un gratuitement
• Visual Studio 2019
• .NET Framework 4 ou ultérieur est requis par le client StackExchange.Redis.

Créer une instance Redis managé Azure (préversion)

1. Pour créer une instance Redis managé Azure (préversion), connectez-vous au portail Azure, puis sélectionnez Créer une ressource.

2. Dans la page Nouveau, dans la zone de recherche, tapez Azure Cache pour Redis.

3. Dans la page Nouveau cache Redis, configurez les paramètres du nouveau cache.

   Paramètre	Choisir une valeur	Description
   Abonnement	Dans la liste déroulante, sélectionnez votre abonnement.	L’abonnement sous lequel créer cette nouvelle instance Redis managé Azure.
   Groupe de ressources	Dans la liste déroulante, sélectionnez un groupe de ressources ou choisissez Créer nouveau, puis entrez un nouveau nom de groupe de ressources.	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 dans la région.	Le nom du cache doit être une chaîne de 1 à 63 caractères qui, une fois associée au nom de région du cache contient uniquement des chiffres, des lettres ou des traits d’union. (Si le nom du cache est inférieur à 45 caractères, il peut fonctionner dans toutes les régions actuellement disponibles.) Le nom doit commencer et se terminer par un chiffre ou une lettre, et ne peut pas contenir de traits d’union consécutifs. Le nom d’hôte de votre instance de cache est \<DNS name\>.\<Azure region\>.redis.azure.net.
   Lieu	Dans la liste déroulante, sélectionnez un emplacement.	Redis managé Azure est disponible dans certaines régions Azure.
   Type de cache	Utilisez la liste déroulante pour sélectionner le niveau de performance et la taille du cache.	Le niveau détermine les performances de l’instance Redis, tandis que la taille du cache détermine la mémoire disponible pour stocker les données. Pour obtenir de l’aide pour choisir le niveau de performance approprié, consultez Choix du niveau approprié

   

4. Sélectionnez Suivant : Mise en réseau pour configurer un point de terminaison public ou privé.

5. Sélectionnez Suivant : Avancé.

   Configurez les modules Redis que vous voulez ajouter à l’instance.

   Par défaut, pour un nouveau cache managé :

   • Microsoft Entra ID est activé.
   • L’authentification avec des clés d’accès est désactivée pour des raisons de sécurité.

   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.

   Définissez la stratégie de clustering sur Enterprise pour un cache non cluster ou sur OSS pour un cache en cluster. Pour plus d’informations sur le choix d’une stratégie de clustering, consultez Stratégie de clustering.

   

   Si vous utilisez la Géoréplication active, elle doit être configurée pendant la création. Pour plus d’informations, consultez Configurer la géoréplication active pour les instances d’Azure Managed Redis.

   Important

   Vous ne pouvez pas modifier la stratégie de clustering d’une instance Redis managé Azure (préversion) après l’avoir créée. Si vous utilisez RediSearch, la stratégie de cluster Entreprise est requise et NoEviction est la seule stratégie d’éviction prise en charge.

   Important

   Si vous utilisez cette instance de cache dans un groupe de géoréplication, les stratégies d’éviction ne peuvent pas être modifiées une fois l’instance créée. Veillez à connaître les stratégies d’éviction de vos nœuds principaux avant de créer le cache. Pour plus d’informations sur la géoréplication active, consultez les Prérequis à la géoréplication active.

   Important

   Vous ne pouvez pas modifier les modules après avoir créé une instance de cache. Les modules doivent être activés au moment où vous créez une instance Azure Cache pour Redis. Il n’existe aucune option permettant d’activer la configuration d’un module après avoir créé un cache.

6. Sélectionnez Suivant : Étiquettes et ignorez.

7. Sélectionnez Suivant : Vérifier + créer.

8. Passez en revue les paramètres, puis sélectionnez Créer.

   La création de l’instance Redis prend plusieurs minutes. Vous pouvez suivre la progression sur la page Vue d’ensemble de Redis managé Azure. Lorsque État indique En cours d’exécution, le cache est prêt pour utilisation.

Créer une instance Cache Redis Azure

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 affiche En cours d’exécution, le cache est prêt pour utilisation.

Utiliser l’authentification Microsoft Entra ID sur votre cache

Pour les caches Redis Azure, à l’exception des niveaux Enterprise et Enterprise Flash, l’authentification Microsoft Entra est activée par défaut. Les clés d’accès sont désactivées par défaut.

Important

Microsoft recommande d’utiliser l’authentification Microsoft Entra ID plutôt que des mots de passe ou des clés d’accès pour l’expérience d’authentification la plus sécurisée. L’authentification décrite dans cette section de l’article utilise des clés d’accès, qui nécessitent un niveau de confiance très élevé dans l’application et présente des risques non présents lors de l’utilisation de Microsoft Entra ID. Utilisez l’approche de ce document uniquement lorsque l’authentification Microsoft Entra ID n’est pas viable.

1. Dans le portail Azure, sélectionnez le cache pour lequel vous voulez utiliser l’authentification basée sur des jetons Microsoft Entra.

2. Dans le menu Ressource, sélectionnez Authentification.

3. Sélectionnez Sélectionner un membre et entrez le nom d’un utilisateur valide. L’utilisateur que vous spécifiez est automatiquement associé à la stratégie d’accès Propriétaire des données par défaut lorsque vous sélectionnez Enregistrer. Vous pouvez également entrer une identité managée ou un principal de service pour vous connecter à votre instance de cache.

   

Pour plus d’informations sur l’utilisation de Microsoft Entra ID avec Azure CLI, consultez les pages de référence pour l’identité.

Installer la bibliothèque pour utiliser l’authentification Microsoft Entra ID

La bibliothèque Azure.StackExchange.Redis contient la méthode d’authentification Microsoft Entra ID pour se connecter aux services Azure Redis en utilisant Microsoft Entra ID. Elle s’applique à tous les services Azure Cache pour Redis, Azure Cache pour Redis Entreprise et Azure Managed Redis (Préversion).

1. Ouvrez votre projet dans Visual Studio.

2. Cliquez avec le bouton droit sur le projet, puis choisissez Gérer les packages NuGet....

3. Rechercher Microsoft.Azure.StackExchangeRedis

4. Cliquez sur le bouton installer pour effectuer l’installation

5. Acceptez tout le contenu faisant l’objet d’une demande pour terminer l’installation

---

Se connecter au cache en utilisant Microsoft Entra ID

1. Inclure les bibliothèques dans votre code

   using Azure.Identity;
   using StackExchange.Redis
   

2. Utilisation des informations d’identification Azure par défaut pour authentifier la connexion client. Cela permet à votre code d’utiliser les informations d’identification de l’utilisateur connecté lors d’une exécution locale et une identité managée Azure lors d’une exécution dans Azure sans modification de code.

var configurationOptions = await ConfigurationOptions.Parse($"{_redisHostName}").ConfigureForAzureWithTokenCredentialAsync(new DefaultAzureCredential());
ConnectionMultiplexer _newConnection = await ConnectionMultiplexer.ConnectAsync(configurationOptions);
IDatabase Database = _newConnection.GetDatabase();

Pour modifier le fichier app.config

1. Modifiez le fichier app.config en ajoutant le contenu suivant :

   <appSettings>
       <add key="RedisHostName" value="<cache-hostname-with-portnumber>"/>
   </appSettings>
   

2. Remplacez <cache-hostname> par le nom de votre hôte de cache tel qu’il apparaît dans la Vue d’ensemble du menu Ressource dans le Portail Azure.

   Par exemple, avec Azure Managed Redis ou le niveau Enterprise : my-redis.eastus.azure.net:10000

3. Enregistrez le fichier.

Pour plus d’informations, consultez StackExchange.Redis et le code dans un référentiel GitHub.

Pour modifier le fichier app.config

1. Modifiez le fichier app.config en ajoutant le contenu suivant :

   <appSettings>
       <add key="RedisHostName" value="<cache-hostname-with-portnumber>"/>
   </appSettings>
   

2. Remplacez <cache-hostname> par le nom de votre hôte de cache tel qu’il apparaît dans la Vue d’ensemble du menu Ressource dans le Portail Azure.

   Par exemple, avec Azure Cache pour Redis : my-redis.eastus.azure.net:6380

3. Enregistrez le fichier.

Pour plus d’informations, consultez StackExchange.Redis et le code dans un référentiel GitHub.

Exécution de l'exemple

Appuyez sur Ctrl + F5 pour générer et exécuter l’application console pour tester la sérialisation des objets .NET.

Nettoyer les ressources

Si vous souhaitez continuer à utiliser les ressources que vous avez créées dans cet article, conservez le groupe de ressources.

Sinon, si vous avez terminé avec les ressources, vous pouvez supprimer le groupe de ressources Azure que vous avez créé pour éviter les frais.

Important

La suppression d’un groupe de ressources est irréversible. Quand vous supprimez un groupe de ressources, toutes les ressources qu’il contient sont supprimées définitivement. Veillez à ne pas supprimer accidentellement des ressources ou un groupe de ressources incorrects. Si vous avez créé les ressources dans un groupe de ressources existant contenant des ressources que vous souhaitez conserver, vous pouvez supprimer chaque ressource individuellement, au lieu de supprimer l’intégralité du groupe de ressources.

Pour supprimer un groupe de ressources

1. Connectez-vous au Portail Azure, puis sélectionnez Groupes de ressources.

2. Recherchez le groupe de ressources à supprimer.

   S’il existe de nombreux groupes de ressources, utilisez la zone Filtrer pour n’importe quel champ..., tapez le nom du groupe de ressources que vous avez créé pour cet article. Sélectionnez le groupe de ressources dans la liste des résultats.

   

3. Sélectionnez Supprimer le groupe de ressources.

4. Vous êtes invité à confirmer la suppression du groupe de ressources. Saisissez le nom de votre groupe de ressources pour confirmer, puis sélectionnez Supprimer.

   

Après quelques instants, le groupe de ressources et toutes ses ressources sont supprimés.

Contenu connexe

• Résilience des connexions
• Bonnes pratiques de développement