Démarrage rapide : Créer une instance Gestion des API Azure en utilisant Azure CLI
S’APPLIQUE À : Consommation | Développeur | De base | Standard | Premium
Ce guide de démarrage rapide décrit les étapes de création d’une instance Gestion des API en utilisant des commande Azure CLI. Après avoir créé une instance, vous pouvez utiliser Azure CLI pour des tâches de gestion courantes comme l’importation d’API dans votre instance Gestion des API.
La Gestion des API Azure aide les organisations à publier des API pour des développeurs externes, partenaires et internes, afin de libérer le potentiel de leurs données et services. Il offre les compétences essentielles qui garantissent un programme d’API réussi au travers de l’engagement des développeurs, des perspectives commerciales, de l’analytique, de la sécurité et de la protection. Gestion des API vous permet de créer et de gérer des passerelles d’API modernes pour des services back-ends existants, où qu’ils soient hébergés.
Si vous n’avez pas d’abonnement Azure, créez un compte gratuit Azure avant de commencer.
Prérequis
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.
- Cet article nécessite la version 2.11.1 ou ultérieure de l’interface Azure CLI. Si vous utilisez Azure Cloud Shell, la version la plus récente est déjà installée.
Créer un groupe de ressources
Les instances du service Gestion des API Azure, comme toutes les ressources Azure, doivent être déployées dans un groupe de ressources. Les groupes de ressources vous permettent d’organiser et de gérer les ressources Azure connexes.
Commencez par créer un groupe de ressources nommé myResourceGroup dans la localisation USA Centre à l’aide de la commande az group create suivante :
az group create --name myResourceGroup --location centralus
Création d'une instance Gestion des API
Maintenant que vous avez un groupe de ressources, vous pouvez créer une instance Gestion des API. Créez-en une à l’aide de la commande az apim create et fournissez un nom de service et les détails de l’éditeur. Le nom de service doit être unique au sein d’Azure.
Dans l’exemple suivant, myapim est utilisé comme nom de service. Mettez à jour le nom de façon à utiliser une valeur unique. Mettez également à jour le nom de l’organisation de l’éditeur de l’API et l’adresse e-mail pour la réception des notifications.
az apim create --name myapim --resource-group myResourceGroup \
--publisher-name Contoso --publisher-email admin@contoso.com \
--no-wait
Par défaut, la commande crée l’instance au niveau Développeur, ce qui constitue une option économique pour évaluer la Gestion des API Azure. Ce niveau n’est pas destiné à la production. Pour en savoir plus sur la mise à l’échelle des niveaux du service Gestion des API, consultez Mettre à niveau et mettre à l’échelle.
Conseil
La création et l’activation d’un service Gestion des API à ce niveau peuvent prendre entre 30 et 40 minutes. La commande précédente utilise l’option --no-wait pour rendre la main immédiatement pendant la création du service.
Vérifiez l’état du déploiement en exécutant la commande az apim show :
az apim show --name myapim --resource-group myResourceGroup --output table
Au départ, la sortie ressemble à ce qui suit, indiquant l’état Activating :
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- -------------- ----------- ------------ ---------- --------- -------
myapim myResourceGroup Central US Activating Developer 1
Après l’activation, l’état est Online et l’instance de service a une adresse de passerelle et une adresse IP publique. Pour le moment, ces adresses n’exposent pas de contenu. Par exemple, .
NAME RESOURCE GROUP LOCATION GATEWAY ADDR PUBLIC IP PRIVATE IP STATUS TIER UNITS
----------- ---------------- ---------- --------------------------------- ------------ ------------ -------- --------- -------
myapim myResourceGroup Central US https://myapim.azure-api.net 203.0.113.1 Online Developer 1
Une fois votre instance Gestion des API en ligne, vous êtes prêt à l’utiliser. Commencez par le tutoriel Importer et publier votre première API.
Nettoyer les ressources
Vous pouvez utiliser la commande az group delete pour supprimer le groupe de ressources et l’instance Gestion des API quand vous n’en avez plus besoin.
az group delete --name myResourceGroup