Synchroniser les API à partir d’une instance Gestion des API

Cet article vous explique comment créer un lien vers une instance Gestion des API afin que les API de l’instance soient continuellement mises à jour dans l’inventaire de votre Centre d’API.

À propos de la liaison d’une instance Gestion des API

Même si vous pouvez utiliser l’interface Azure CLI pour importer des API à la demande à partir de Gestion des API Azure vers Azure API Center, la liaison à une instance Gestion des API vous permet d’effectuer une synchronisation continue afin que l’inventaire des API soit toujours à jour.

Lorsque vous liez une instance Gestion des API en tant que source d’API, les événements suivants se produisent :

1. Toutes les API, et éventuellement les définitions d’API (spécifications), de l’instance Gestion des API sont ajoutées à l’inventaire du centre d’API.
2. Vous configurez un environnement de type Gestion des API Azure dans le centre d’API.
3. Un déploiement associé est créé pour chaque définition d’API synchronisée à partir de Gestion des API.

Lorsque les paramètres des API existantes sont modifiés, les API de Gestion des API sont automatiquement synchronisées avec le centre d’API (par exemple, lorsque de nouvelles versions sont ajoutées, que de nouvelles API sont créées ou que des API sont supprimées). Cette synchronisation est unidirectionnelle entre Gestion des API et votre centre d’API Azure, ce qui signifie que les mises à jour d’API dans le centre d’API ne sont pas synchronisées en retour avec l’instance Gestion des API.

Remarque

• Le nombre d’instances Gestion des API liées (sources d’API) est limité.
• Les mises à jour d’API dans Gestion des API sont généralement synchronisées avec votre centre d’API en quelques minutes, mais la synchronisation peut prendre jusqu’à 24 heures.

Entités synchronisées à partir de Gestion des API

Vous pouvez ajouter ou mettre à jour des propriétés des métadonnées et de la documentation dans votre centre d’API afin d’aider les parties prenantes à découvrir, comprendre et utiliser les API synchronisées. En savoir plus sur les propriétés de métadonnées intégrées et personnalisées d’Azure API Center.

Le tableau suivant présente les propriétés des entités qui peuvent être modifiées dans Azure API Center et les propriétés qui sont déterminées en fonction de leurs valeurs dans une instance Gestion des API Azure liée. En outre, les identifiants de ressources ou de systèmes des entités dans Azure API Center sont générés automatiquement et ne peuvent pas être modifiés.

Entité	Propriétés configurables dans API Center	Propriétés déterminées dans Gestion des API
API	résumé lifecycleStage termsOfService license externalDocumentation customProperties	title description kind
Version d’API	lifecycleStage	title
Environnement	title description kind server.managementPortalUri intégration customProperties	server.type
Déploiement	title description serveur state customProperties	server.runtimeUri

Pour plus de détails sur les propriétés, consultez la référence de l’API REST d’Azure API Center.

Prérequis

• Un Centre d’API dans votre abonnement Azure. Si vous n’en avez pas créé, consultez Démarrage rapide : Créer votre Centre API.

• Une instance Gestion des API Azure, dans le même abonnement ou dans un abonnement différent. L’instance doit se trouver dans le même répertoire.

• Pour Azure CLI :

  • Utilisez l’environnement Bash dans Azure Cloud Shell. Pour plus d’informations, consultez Démarrage rapide pour Bash dans Azure Cloud Shell.

    

  • Si vous préférez exécuter les commandes de référence de l’interface de ligne de commande localement, installez l’interface Azure CLI. Si vous exécutez sur Windows ou macOS, envisagez d’exécuter Azure CLI dans un conteneur Docker. Pour plus d’informations, consultez Guide pratique pour exécuter Azure CLI dans un conteneur Docker.

    • Si vous utilisez une installation locale, connectez-vous à Azure CLI à l’aide de la commande az login. Pour finir le processus d’authentification, suivez les étapes affichées dans votre terminal. Pour connaître les autres options de connexion, consultez Se connecter avec Azure CLI.

    • Lorsque vous y êtes invité, installez l’extension Azure CLI lors de la première utilisation. Pour plus d’informations sur les extensions, consultez Utiliser des extensions avec Azure CLI.

    • Exécutez az version pour rechercher la version et les bibliothèques dépendantes installées. Pour effectuer une mise à niveau vers la dernière version, exécutez az upgrade.

  Remarque

  Les commandes az apic nécessitent l’extension Azure CLI apic-extension. Si vous n’avez pas utilisé de commandes az apic, l’extension peut être installée dynamiquement lorsque vous exécutez votre première commande az apic, ou vous pouvez l’installer manuellement. Apprenez-en davantage sur les extensions Azure CLI.

  Pour connaître les dernières modifications et mises à jour relatives à apic-extension, consultez les notes de publication.

  Remarque

  Les exemples de commandes Azure CLI de cet article peuvent s’exécuter dans PowerShell ou dans un interpréteur de commandes bash. Si c’est nécessaire en raison d’une syntaxe de variables différente, des exemples distincts de commandes sont fournis pour les deux interpréteurs de commandes.

Ajouter une identité managée dans votre Centre API

Pour ce scénario, votre Centre API utilise une identité managée afin d’accéder aux API dans votre instance Gestion des API. Selon vos besoins, configurez une identité managée affectée par le système ou une identité managée ou plus affectée par l’utilisateur.

Les exemples suivants montrent comment configurer une identité managée affectée par le système à l’aide du Portail Azure ou d'Azure CLI. À un niveau élevé, les étapes de configuration sont similaires pour une identité gérée attribuée à un utilisateur.

Portail

1. Dans le portail, accédez à votre Centre API.
2. Dans le menu de gauche, sous Sécurité, sélectionnez Identités managées.
3. Sélectionnez Affectée par le système, puis définissez l’état sur Activé.
4. Cliquez sur Enregistrer.

Azure CLI

Définissez l’identité affectée par le système dans votre Centre API à l’aide de la commande az apic update suivante. Remplacez les noms de votre Centre API et de votre groupe de ressources :

az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'

Attribuer à l’identité managée le rôle Lecteur du service Gestion des API

Pour autoriser l’importation d’API, attribuez à l’identité managée de votre Centre API le rôle Lecteur du service Gestion des API dans votre instance Gestion des API. Vous pouvez utiliser le portail Azure ou Azure CLI.

Portail

1. Dans le portail, accédez à votre instance Gestion des API.
2. Dans le menu de gauche, sélectionnez Contrôle d’accès (IAM) .
3. Sélectionnez + Ajouter une attribution de rôle.
4. Dans la page Ajouter une attribution de rôle, définissez les valeurs comme suit :
   1. Sous l’onglet Rôle : sélectionnez Lecteur du service Gestion des API.
   2. Sous l’onglet Membres, dans Attribuer l’accès à : sélectionnez Identité managée>+ Sélectionner des membres.
   3. Dans la page Sélectionner des identités managées : sélectionnez l’identité managée affectée par le système de votre Centre API que vous avez ajoutée dans la section précédente. Cliquez sur Sélectionner.
   4. Sélectionnez Vérifier + attribuer.

Azure CLI

1. Obtenez l’ID principal de l’identité. Pour une identité affectée par le système, utilisez la commande az apic show.

   #! /bin/bash
   apicObjID=$(az apic show --name <api-center-name> \
       --resource-group <resource-group-name> \
       --query "identity.principalId" --output tsv)
   

   # Formatted for PowerShell
   $apicObjID=$(az apic show --name <api-center-name> `
       --resource-group <resource-group-name> `
       --query "identity.principalId" --output tsv)
   

2. Obtenez l’ID de ressource de votre instance Gestion des API à l’aide de la commande az apim show.

   #! /bin/bash
   apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

   # Formatted for PowerShell
   $apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

3. Attribuez à l’identité managée le rôle Lecteur du service Gestion des API dans votre instance Gestion des API à l’aide de la commande az role assignment create.

   #! /bin/bash
   scope="${apimID:1}"
   
   az role assignment create \
       --role "API Management Service Reader Role" \
       --assignee-object-id $apicObjID \
       --assignee-principal-type ServicePrincipal \
       --scope $scope 
   

   # Formatted for PowerShell
   $scope=$apimID.substring(1)
   
   az role assignment create `
       --role "API Management Service Reader Role" `
       --assignee-object-id $apicObjID `
       --assignee-principal-type ServicePrincipal `
       --scope $scope 
   

Lier une instance Gestion des API

Vous pouvez lier une instance Gestion des API à l’aide du portail.

1. Dans le portail, accédez à votre Centre API.
2. Sous Ressources, sélectionnez Environnements.
3. Sélectionnez Liens (préversion)>+ Nouveau lien.
4. Dans la page Lier votre service Gestion des API Azure :
   1. Sélectionnez l’Abonnement, le Groupe de ressources et le Service Gestion des API Azure que vous souhaitez lier.
   2. Dans Détails du lien, entrez un identificateur.
   3. Dans Détails de l’environnement, saisissez le Titre de l’environnement (nom), le Type d’environnement et une Description de l’environnement.
   4. Dans Détails de l’API, sélectionnez une Étape de cycle de vie pour les API synchronisées. (Vous pouvez mettre à jour cette valeur pour vos API après leur ajout à votre centre d’API.) Sélectionnez également s’il faut synchroniser les définitions d’API.
5. Sélectionnez Créer.

L’environnement est ajouté dans votre centre d’API. Les API de Gestion des API sont importées dans l’inventaire du centre d’API.

Supprimer un lien

Lorsqu’une instance Gestion des API est liée, vous ne pouvez pas supprimer les API synchronisées de votre centre d’API. Si nécessaire, vous pouvez supprimer le lien. Lorsque vous supprimez un lien :

• Les API de Gestion d’API synchronisées dans l’inventaire de votre centre d’API sont supprimées
• L’environnement et les déploiements associés à l’instance Gestion des API sont supprimés

Pour supprimer un lien Gestion des API :

1. Dans le portail, accédez à votre Centre API.
2. Sous Ressources, sélectionnez Environnements>Lien (préversion).
3. Sélectionnez le lien, puis cliquez sur Supprimer (icône de la corbeille).

Contenu connexe

• Gérer l’inventaire des API avec des commandes Azure CLI
• Importer des API à partir de Gestion des API vers votre centre d’API Azure
• Documentation Gestion des API Azure