Démarrage rapide : créer votre centre d’API : Azure CLI

Article
06/06/2024

Configurez votre centre d’API pour démarrer un inventaire des API de votre organisation. Le centre d’API Azure permet de suivre les API dans un emplacement centralisé pour la découverte, la réutilisation et la gouvernance.

Après avoir créé votre centre d’API, suivez les étapes décrites dans les didacticiels pour ajouter des métadonnées personnalisées, des API, des versions, des définitions et d’autres informations.

Prérequis

Si vous n’en avez pas, créez un compte gratuit Azure avant de commencer.
Au moins une attribution de rôle Contributeur ou des autorisations équivalentes dans l’abonnement Azure.

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 dans le apic-extension, consultez les notes de publication.

Enregistrez le fournisseur Microsoft.ApiCenter

Si ce n’est déjà fait, vous devez inscrire le fournisseur de ressources Microsoft.ApiCenter dans votre abonnement. Vous ne devez inscrire le fournisseur de ressources qu’une seule fois.

Pour enregistrer le fournisseur de ressources dans votre abonnement à l'aide d'Azure CLI, exécutez les commandes az provider register suivantes :

az provider register --namespace Microsoft.ApiCenter

Vous pouvez vérifier l’état de l’inscription en exécutant la commande az provider show suivante :

az provider show --namespace Microsoft.ApiCenter

Créer un groupe de ressources

Les instances du centre d’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.

Créez un groupe de ressources avec la commande az group create. L’exemple suivant crée un groupe de nommé MyGroup dans l’emplacement USA Est :

az group create --name MyGroup --location eastus

Créer un centre d’API

Créez un centre d’API à l’aide de la commande az apic create.

L’exemple suivant crée un centre d’API appelé MyApiCenter dans le groupe de ressources MyGroup. Dans cet exemple, le centre d’API est déployé dans l’emplacement Europe Ouest. Remplacez un nom de centre d’API de votre choix et entrez l’un des emplacements disponibles pour votre centre d’API.

az apic create --name MyApiCenter --resource-group MyGroup --location westeurope

La sortie de la commande ressemble à ce qui suit. Par défaut, le centre d’API est créé dans le plan Gratuit.

{
  "dataApiHostname": "myapicenter.data.westeurope.azure-apicenter.ms",
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mygroup/providers/Microsoft.ApiCenter/services/myapicenter",
  "location": "westeurope",
  "name": "myapicenter",
  "resourceGroup": "mygroup",
  "sku": {
    "name": "Free"
  },
  "systemData": {
    "createdAt": "2024-06-22T21:40:35.2541624Z",
    "lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
  },
  "tags": {},
  "type": "Microsoft.ApiCenter/services"
}

Après le déploiement, votre centre d’API est prêt à être utilisé !

Étapes suivantes

Vous pouvez maintenant commencer à ajouter des informations à l’inventaire dans votre centre d’API. Pour vous aider à organiser vos API et d’autres informations, commencez par définir des métadonnées personnalisées dans votre centre d’API.

Définir des métadonnées personnalisées

Partager via