Démarrage rapide : Créer une instance de Azure API Management à l’aide de Bicep

CONCERNE : Tous les niveaux de gestion des API

Ce guide de démarrage rapide explique comment utiliser un fichier Bicep pour créer une instance de Azure API Management. Vous pouvez également utiliser Bicep pour les tâches de gestion courantes telles que l’importation d’API dans votre instance de API Management.

Azure API Management aide les organisations à publier des API sur des développeurs externes, partenaires et internes pour déverrouiller le potentiel de leurs données et services. API Management fournit les compétences principales pour garantir la réussite d’un programme d’API par le biais de l’engagement des développeurs, des insights métier, de l’analytique, de la sécurité et de la protection. Avec API Management, créez et gérez des passerelles d’API modernes pour les services principaux existants hébergés n’importe où.

Bicep est un langage spécifique au domaine (DSL) qui utilise la syntaxe déclarative pour déployer des ressources Azure. Il fournit une syntaxe concise, une cohérence des types fiable et une prise en charge de la réutilisation du code. Bicep offre la meilleure expérience de création pour vos solutions d’infrastructure en tant que code dans Azure.

Prérequis

Examiner le fichier Bicep

Le fichier Bicep utilisé dans ce guide de démarrage rapide provient de Azure modèles de démarrage rapide.

@description('The name of the API Management service instance')
param apiManagementServiceName string = 'apiservice${uniqueString(resourceGroup().id)}'

@description('The email address of the owner of the service')
@minLength(1)
param publisherEmail string

@description('The name of the owner of the service')
@minLength(1)
param publisherName string

@description('The pricing tier of this API Management service')
@allowed([
  'Consumption'
  'Developer'
  'Basic'
  'Basicv2'
  'Standard'
  'Standardv2'
  'Premium'
])
param sku string = 'Developer'

@description('The instance size of this API Management service.')
@allowed([
  0
  1
  2
])
param skuCount int = 1

@description('Location for all resources.')
param location string = resourceGroup().location

resource apiManagementService 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
  name: apiManagementServiceName
  location: location
  sku: {
    name: sku
    capacity: skuCount
  }
  properties: {
    publisherEmail: publisherEmail
    publisherName: publisherName
  }
}

La ressource suivante est définie dans le fichier Bicep :

Dans cet exemple, le fichier Bicep configure par défaut l’instance API Management dans le niveau Développeur, une option économique pour évaluer Azure API Management. Ce niveau n’est pas destiné à la production.

Vous trouverez d'autres exemples Azure API Management Bicep dans les modèles de démarrage rapide d'Azure.

Déployer le fichier Bicep

Vous pouvez utiliser Azure CLI ou Azure PowerShell pour déployer le fichier Bicep. Pour plus d’informations sur le déploiement de fichiers Bicep, consultez Deploy Bicep files with the Azure CLI.

  1. Enregistrez le fichier Bicep en tant que main.bicep sur votre ordinateur local.

  2. Déployez le fichier Bicep à l’aide de Azure CLI ou de Azure PowerShell.

    Remplacez <publisher-name> et <publisher-email> par le nom de votre organisation et votre adresse e-mail pour recevoir des notifications.

    az group create --name exampleRG --location eastus

az deployment group create --resource-group exampleRG --template-file main.bicep --parameters publisherEmail=<publisher-email> publisherName=<publisher-name>

    Une fois le déploiement terminé, un message doit s’afficher pour indiquer que le déploiement a réussi.

    Conseil

    La création et l’activation d’un service de API Management au niveau développeur peuvent prendre entre 30 et 40 minutes. Les heures varient selon le niveau.

Vérifier les ressources déployées

Utilisez les Azure portal, Azure CLI ou Azure PowerShell pour répertorier la ressource App Configuration déployée dans le groupe de ressources.

az resource list --resource-group exampleRG

Lorsque votre instance de service API Management est en ligne, vous êtes prêt à l'utiliser. Commencez par le tutoriel Importer et publier votre première API.

Nettoyer les ressources

Si vous envisagez de continuer à utiliser les didacticiels suivants, vous souhaiterez peut-être laisser l’instance API Management en place. Quand vous n’en avez plus besoin, supprimez le groupe de ressources, ce qui supprime également les ressources qu’il contient.

az group delete --name exampleRG

Étape suivante

Tutoriel : Importer et publier votre première API

  • Last updated on