Notes
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
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 à l’aide de commandes Azure CLI. Après avoir créé une instance, vous pouvez utiliser Azure CLI pour des tâches de gestion courantes telles que 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 ne disposez pas d’un compte Azure, créez-en un gratuitement avant de commencer.
Conditions préalables
Utilisez l’environnement Bash dans Azure Cloud Shell. Pour obtenir plus d’informations, consultez Démarrage d’Azure Cloud Shell.
Si vous préférez exécuter des commandes de référence CLI localement, installez 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 terminer le processus d’authentification, suivez les étapes affichées dans votre terminal. Pour obtenir d’autres options de connexion, consultez S’authentifier auprès d’Azure à l’aide d’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 et gérer 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 d’Azure CLI. Si vous utilisez Azure Cloud Shell, la dernière version est déjà installée.
Créer un groupe de ressources
Les instances 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.
Tout d’abord, créez un groupe de ressources nommé myResourceGroup dans l’emplacement USA Centre avec la commande az group create suivante :
az group create --name myResourceGroup --location centralus
Créer une instance Gestion des API
Maintenant que vous disposez d’un groupe de ressources, vous pouvez créer une instance Gestion des API. Créez-en un à l’aide de la commande az apim create et fournissez un nom de service et des détails de l’éditeur. Le nom du service doit être unique dans Azure.
Dans l’exemple suivant, myapim est utilisé pour le nom du service. Mettez à jour le nom en une valeur unique. Mettez également à jour le nom de l’organisation de l’éditeur d’API et l’adresse e-mail pour recevoir 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 dans le niveau Développeur, une option économique pour évaluer 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 / Astuce
La création et l’activation d’un service Gestion des API dans ce niveau peuvent prendre entre 30 et 40 minutes. La commande précédente utilise l’option --no-wait pour que la commande retourne 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
Initialement, la sortie est similaire à ce qui suit, montrant 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 l’instant, ces adresses n’exposent aucun 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 du service Gestion des API lorsqu’elles ne sont pas nécessaires.
az group delete --name myResourceGroup