Démarrage rapide : Créer une instance Gestion des API en utilisant PowerShell
S’APPLIQUE À : Consommation | Développeur | De base | Standard | Premium
Dans ce guide de démarrage rapide, vous créez une nouvelle instance API Management à l’aide de cmdlets Azure PowerShell. Après avoir créé une instance, vous pouvez utiliser Azure PowerShell 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
- Si vous choisissez d’utiliser Azure PowerShell localement :
- Installez la dernière version du module Az PowerShell.
- Connectez-vous à votre compte Azure à l’aide de la cmdlet Connect-AzAccount.
- Si vous choisissez d’utiliser Azure Cloud Shell :
- Pour plus d’informations, consultez Vue d’ensemble d’Azure Cloud Shell.
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.
Conseil
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, ProvisioningState est Réussite et l’instance a plusieurs URL associées. Par 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