Démarrage rapide : Créer une instance du service Gestion des API Azure avec PowerShell

Dans ce guide de démarrage rapide, vous créez une nouvelle instance API Management à l’aide de cmdlets Azure PowerShell.

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. API Management vous permet de créer et de gérer des passerelles d’API modernes pour des services back-end existants, où qu’ils soient hébergés.

Prérequis

  • Compte Azure avec un abonnement actif. Créez un compte gratuitement.

  • Azure Cloud Shell ou Azure PowerShell

    Azure héberge Azure Cloud Shell, un environnement d’interpréteur de commandes interactif que vous pouvez utiliser dans votre navigateur. Vous pouvez utiliser Bash ou PowerShell avec Cloud Shell pour utiliser les services Azure. Vous pouvez utiliser les commandes préinstallées Cloud Shell pour exécuter le code de cet article sans avoir à installer quoi que ce soit dans votre environnement local.

    Pour démarrer Azure Cloud Shell :

    Option Exemple/Lien
    Sélectionnez Essayer dans le coin supérieur droite d’un bloc de codes ou de commandes. La sélection de Essayer ne copie pas automatiquement le code ni la commande dans Cloud Shell. Capture d’écran présentant un exemple d’essai pour Azure Cloud Shell.
    Accédez à https://shell.azure.com ou sélectionnez le bouton Lancer Cloud Shell pour ouvrir Cloud Shell dans votre navigateur. Capture d’écran montrant comment lancer Cloud Shell dans une nouvelle fenêtre.
    Sélectionnez le bouton Cloud Shell dans la barre de menus en haut à droite du portail Azure. Capture d’écran présentant le bouton Cloud Shell dans le portail Azure.

    Pour utiliser Azure Cloud Shell :

    1. Démarrez Cloud Shell.

    2. Sélectionnez le bouton Copier sur un bloc de codes (ou un bloc de commandes) pour copier le code ou la commande.

    3. Collez le code ou la commande dans la session Cloud Shell en sélectionnant Ctrl+Maj+V sur Windows et Linux ou en sélectionnant Cmd+Maj+V sur macOS.

    4. Sélectionnez Entrer pour exécuter le code ou la commande.

    Si vous choisissez d’installer et d’utiliser PowerShell localement, vous devez exécuter le module Azure PowerShell version 1.0 ou version ultérieure pour les besoins de ce démarrage rapide. Exécutez Get-Module -ListAvailable Az pour trouver la version. Si vous devez effectuer une mise à niveau, consultez Installer le module Azure PowerShell. Si vous exécutez PowerShell en local, vous devez également exécuter Connect-AzAccount pour créer une connexion avec Azure.

Créer un groupe de ressources

Créez un groupe de ressources Azure avec New-AzResourceGroup. Un groupe de ressources est un conteneur logique dans lequel les ressources Azure sont déployées et gérées.

La commande suivante crée un groupe de ressources nommé myResourceGroup dans la localisation USA Ouest :

New-AzResourceGroup -Name myResourceGroup -Location WestUS

Création d'une instance Gestion des API

Maintenant que vous avez un groupe de ressources, vous pouvez créer une instance du service Gestion des API. Créez-en une à l’aide de New-AzApiManagement 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 de l’administrateur pour la réception des notifications.

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 plus d’informations sur les niveaux du service API Management, consultez Comparaison des fonctionnalités des niveaux d’Azure API Management.

Notes

Il s’agit d’une action de longue durée. La création et l’activation d’un service Gestion des API à ce niveau peuvent prendre entre 30 et 40 minutes.

New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
  -Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com" 

Quand la commande prend fin, exécutez Get-AzApiManagement pour afficher les propriétés du service Gestion des API Azure. Après l’activation, l’état de la configuration est Opération réussie et l’instance de service a plusieurs URL associées. Exemple :

Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" 

Exemple de sortie :

PublicIPAddresses                     : {203.0.113.1}
PrivateIPAddresses                    :
Id                                    : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/myapim
Name                                  : myapim
Location                              : West US
Sku                                   : Developer
Capacity                              : 1
CreatedTimeUtc                        : 9/9/2022 9:07:43 PM
ProvisioningState                     : Succeeded
RuntimeUrl                            : https://myapim.azure-api.net
RuntimeRegionalUrl                    : https://myapi-westus-01.regional.azure-api.net
PortalUrl                             : https://myapim.portal.azure-api.net
DeveloperPortalUrl                    : https://myapim.developer.azure-api.net
ManagementApiUrl                      : https://myapim.management.azure-api.net
ScmUrl                                : https://myapim.scm.azure-api.net
PublisherEmail                        : admin@contoso.com
OrganizationName                      : Contoso
NotificationSenderEmail               : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork                        :
VpnType                               : None
PortalCustomHostnameConfiguration     :
ProxyCustomHostnameConfiguration      : {myapim.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration        :
DeveloperPortalHostnameConfiguration  :
SystemCertificates                    :
Tags                                  : {}
AdditionalRegions                     : {}
SslSetting                            : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity                              :
EnableClientCertificate               :
EnableClientCertificate               :
Zone                                  :
DisableGateway                        : False
MinimalControlPlaneApiVersion         :
PublicIpAddressId                     :
PlatformVersion                       : stv2
PublicNetworkAccess                   : Enabled
PrivateEndpointConnections            :
ResourceGroupName                     : myResourceGroup

Une fois déployée votre instance du service Gestion des API, vous êtes prêt à l’utiliser. Commencez par le tutoriel Importer et publier votre première API.

Nettoyer les ressources

Quand vous n’en avez plus besoin, vous pouvez utiliser la commande Remove-AzResourceGroup pour supprimer le groupe de ressources et toutes les ressources associées.

Remove-AzResourceGroup -Name myResourceGroup

Étapes suivantes