Édition

Configurer un back-end Service Fabric dans Gestion des API avec le portail Azure

Cet article explique comment configurer un service Service Fabric en tant que back-end d’API personnalisé à l’aide du portail Azure. Il montre comment configurer un service fiable ASP.NET Core simple sans état en tant que back-end Service Fabric.

Pour plus d’informations, consultez Back-ends dans Gestion des API.

Prérequis

Prérequis pour la configuration d’un exemple de service dans un cluster Service Fabric exécutant Windows en tant que back-end personnalisé :

  • Environnement de développement Windows : installez les charges de travail Visual Studio 2019 et le développement Azure, ASP.NET et le développement web ainsi que Développement multiplateforme .NET Core. Ensuite, configurez un environnement de développement .NET.

  • Cluster Service Fabric : consultez Tutoriel : Déployer un cluster Service Fabric exécutant Windows sur un réseau virtuel Azure. Vous pouvez créer un cluster avec un certificat X.509 existant, ou à des fins de test, créer un certificat auto-signé. Le cluster est créé dans un réseau virtuel.

  • Exemple d’application Service Fabric : créez une application API web et déployez-la sur le cluster Service Fabric, comme décrit dans Intégrer Gestion des API à Service Fabric dans Azure.

    Ces étapes créent un service fiable ASP.NET Core simple sans état en utilisant le modèle de projet d’API web par défaut. Par la suite, vous exposez le point de terminaison HTTP pour ce service par le biais de Gestion des API Azure.

    Prenez note du nom de l’application, par exemple fabric:/myApplication/myService.

  • Instance Gestion des API : instance de Gestion des API existante ou nouvelle dans le niveau Premium ou Développeur et dans la même région que le cluster Service Fabric. Si nécessaire, créez une instance de Gestion des API.

  • Réseau virtuel : ajoutez votre instance de Gestion des API au réseau virtuel que vous avez créé pour votre cluster Service Fabric. Gestion des API nécessite un sous-réseau dédié dans le réseau virtuel.

    Pour connaître les étapes permettant d’activer la connectivité de réseau virtuel pour l’instance de Gestion des API, consultez Utilisation de la gestion des API Azure avec des réseaux virtuels.

Créer un back-end - Portail

Ajouter le certificat du cluster Service Fabric à Gestion des API

Le certificat du cluster Service Fabric est stocké et géré dans un coffre de clés Azure associé au cluster. Ajoutez ce certificat à votre instance de Gestion des API en tant que certificat client.

Pour connaître les étapes permettant d’ajouter un certificat à votre instance de Gestion des API, consultez Comment sécuriser les services back-end à l’aide d’une authentification par certificat client dans la Gestion des API Azure.

Notes

Nous vous recommandons d’ajouter le certificat à Gestion des API en référençant le certificat de coffre de clés.

Ajouter le back-end Service Fabric

  1. Dans le portail Azure, accédez à votre instance APIM.

  2. Sous API, sélectionnez Backends>+ Ajouter.

  3. Entrez un nom de back-end et une description facultative.

  4. Dans Type, sélectionnez Service Fabric.

  5. Dans URL du runtime, entrez le nom du service back-end Service Fabric auquel le service Gestion des API doit transférer les demandes. Exemple : fabric:/myApplication/myService.

  6. Dans Nombre maximal de tentatives de résolution de partition, entrez un nombre compris entre 0 et 10.

  7. Entrez le point de terminaison de gestion du cluster Service Fabric. Ce point de terminaison est l’URL du cluster sur le port 19080, par exemple, https://mysfcluster.eastus.cloudapp.azure.com:19080.

  8. Dans Certificat client, sélectionnez le certificat de cluster Service Fabric que vous avez ajouté à votre instance de Gestion des API dans la section précédente.

  9. Dans Méthode d’autorisation du point de terminaison de gestion, entrez une empreinte ou le nom de serveur x509 d’un certificat utilisé par le service de gestion de cluster Service Fabric pour la communication TLS.

  10. Activez les paramètres Valider la chaîne de certificats et Valider le nom du certificat.

  11. Dans Informations d’identification d’autorisation, fournissez des informations d’identification, si nécessaire, pour atteindre le service back-end configuré dans Service Fabric. Pour l’exemple d’application utilisé dans ce scénario, les informations d’identification d’autorisation ne sont pas nécessaires.

  12. Sélectionnez Créer.

    Créer un back-end Service Fabric

Utiliser le back-end

Pour utiliser un back-end personnalisé, référencez-le avec la stratégie set-backend-service. Cette stratégie convertit l’URL de base du service back-end par défaut d’une demande d’API entrante en un back-end spécifique, en l’occurrence, le back-end Service Fabric.

La stratégie set-backend-service peut être utile avec une API existante pour transformer une demande entrante en un back-end autre que celui qui est spécifié dans les paramètres d’API. À des fins de démonstration dans cet article, créez une API de test et définissez la stratégie pour diriger les demandes d’API vers le back-end Service Fabric.

Create API

Suivez les étapes décrites dans Ajouter une API manuellement pour créer une API vide.

  • Dans les paramètres de l’API, laissez URL du service web vide.

  • Ajoutez un Suffixe de l’URL de l’API, tel que fabric.

    Créer une API vide

Ajouter une opération GET à l’API

Comme indiqué dans Déploiement d’un service principal de Service Fabric, l’exemple de service ASP.NET Core déployé sur le cluster Service Fabric prend en charge une seule opération HTTP GET sur le chemin d’URL /api/values.

La réponse par défaut sur ce chemin est un tableau JSON de deux chaînes :

["value1", "value2"]

Pour tester l’intégration de la Gestion des API au cluster, ajoutez l’opération GET correspondante à l’API sur le chemin /api/values :

  1. Sélectionnez l’API que vous avez créée à l’étape précédente.

  2. Sélectionnez + Ajouter une opération.

  3. Dans la fenêtre Front-end, entrez les valeurs suivantes, puis sélectionnez Enregistrer.

    Paramètre Valeur
    Nom complet Test backend
    URL GET
    URL /api/values

    Ajouter une opération GET à l’API

Configurer la stratégie set-backend-service

Ajoutez la stratégie set-backend-service à l’API de test.

  1. Sous l’onglet Conception, dans la section Traitement entrant, sélectionnez l’icône Éditeur de code (</>).

  2. Placez le curseur à l’intérieur de l’élément <inbound> .

  3. Ajoutez l’instruction de stratégie set-service-backend.

    • Dans backend-id, substituez le nom de votre back-end Service Fabric.

    • sf-resolve-condition est une condition permettant de réévaluer un emplacement de service et de renvoyer une demande. Le nombre de nouvelles tentatives a été défini lors de la configuration du back-end. Par exemple :

      <set-backend-service backend-id="mysfbackend" sf-resolve-condition="@(context.LastError?.Reason == "BackendConnectionFailure")"/>
      
  4. Sélectionnez Enregistrer.

    Configurer la stratégie set-backend-service

Notes

Si un ou plusieurs nœuds du cluster Service Fabric sont en panne ou sont supprimés, Gestion des API ne reçoit pas de notification automatique et continue à envoyer le trafic vers ces nœuds. Pour gérer ces cas, configurez une condition de résolution similaire à celle-ci : sf-resolve-condition="@((int)context.Response.StatusCode != 200 || context.LastError?.Reason == "BackendConnectionFailure" || context.LastError?.Reason == "Timeout")"

Tester l’API back-end

  1. Sous l’onglet Test, sélectionnez l’opération GET que vous avez créée dans la section précédente.

  2. Sélectionnez Envoyer.

    Quand elle est correctement configurée, la réponse HTTP indique un code de réussite HTTP et affiche le JSON retourné par le service Service Fabric back-end.

    Tester le back-end Service Fabric