Quickstart: Een nieuw exemplaar van het API Management-service-exemplaar maken met PowerShell
APIM (API Management) helpt organisaties bij het publiceren van API's naar externe en interne ontwikkelaars, en naar partnerontwikkelaars om alle mogelijkheden van hun gegevens en services te ontsluiten. API Management beschikt over de competenties die belangrijk zijn voor een geslaagd API-programma via ontwikkelaarsbetrokkenheid, zakelijke inzichten, analytische gegevens, beveiliging en bescherming. Met APIM kunt u moderne API-gateways maken en beheren voor bestaande back-endservices die op elke willekeurige locatie worden gehost. Zie het overzicht voor meer informatie.
In deze quickstart worden de stappen beschreven voor het maken van een nieuw API Management-exemplaar met behulp van Azure PowerShell-cmdlets.
Als u geen Azure-abonnement hebt, maakt u een gratis account voordat u begint.
Notitie
In dit artikel wordt de Azure Az PowerShell-module gebruikt. Dit is de aanbevolen PowerShell-module voor interactie met Azure. Raadpleeg Azure PowerShell installeren om aan de slag te gaan met de Az PowerShell-module. Raadpleeg Azure PowerShell migreren van AzureRM naar Az om te leren hoe u naar de Azure PowerShell-module migreert.
Azure Cloud Shell gebruiken
Azure host Azure Cloud Shell, een interactieve shell-omgeving die u via uw browser kunt gebruiken. U kunt Bash of PowerShell gebruiken met Cloud Shell om met Azure-services te werken. U kunt de vooraf geïnstalleerde opdrachten van Cloud Shell gebruiken om de code in dit artikel uit te voeren zonder dat u iets hoeft te installeren in uw lokale omgeving.
Om Azure Cloud Shell op te starten:
| Optie | Voorbeeld/koppeling |
|---|---|
| Selecteer Nu proberen in de rechterbovenhoek van een codeblok. Als u Uitproberen selecteert, wordt de code niet automatisch gekopieerd naar Cloud Shell. |  |
| Ga naar https://shell.azure.com, of selecteer de knop Cloud Shell starten om Cloud Shell in uw browser te openen. |  |
| Klik op de knop Cloud Shell in het menu in de balk rechtsboven in de Azure-portal. |  |
Om de code in dit artikel in Azure Cloud Shell uit te voeren:
Start Cloud Shell.
Selecteer de knop Kopiëren op een codeblok om de code te kopiëren.
Plak de code in de Cloud Shell-sessie door CTRL+Shift+V te selecteren in Windows en Linux of door Cmd+Shift+V op macOS te selecteren.
Selecteer Invoeren om de code uit te voeren.
Als u PowerShell lokaal wilt installeren en gebruiken, wordt voor deze zelfstudie moduleversie 1.0 of hoger van Azure PowerShell vereist. Voer Get-Module -ListAvailable Az uit om de versie te bekijken. Als u PowerShell wilt upgraden, raadpleegt u De Azure PowerShell-module installeren. Als u PowerShell lokaal uitvoert, moet u ook Connect-AzAccount uitvoeren om verbinding te kunnen maken met Azure.
Een resourcegroep maken
Maak een Azure-resourcegroep met behulp van de opdracht New-AzResourceGroup. Een resourcegroep is een logische container waarin Azure-resources worden geïmplementeerd en beheerd.
Met de volgende opdracht wordt een resourcegroep met de naam myResourceGroup gemaakt in de locatie US - west:
New-AzResourceGroup -Name myResourceGroup -Location WestUS
Een API Management-service maken
Met deze resourcegroep kunt u een API Management-service-exemplaar maken. Maak er een met behulp van New-AzApiManagement en geef een servicenaam en de details van de uitgever op. De servicenaam moet uniek zijn binnen Azure.
In het volgende voorbeeld wordt myapim gebruikt voor de servicenaam. Werk de naam bij naar een unieke waarde. Werk ook de naam van de organisatie van de uitgever van de API en het e-mailadres van de beheerder bij om meldingen te ontvangen.
De opdracht maakt standaard het exemplaar in de ontwikkelaarslaag, een voordelige optie om Azure API Management te evalueren. Deze laag is niet bedoeld voor productie. Zie bijwerken en schalen voor meer informatie over het schalen van API Management-lagen.
Notitie
Dit is een langdurige bewerking. Het kan tussen de dertig en veertig minuten duren om een API Management-service in deze laag te maken en activeren.
New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
-Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com"
Wanneer de opdracht is uitgevoerd, voert u Get-AzApiManagement uit om de eigenschappen van de Azure API Management-service weer te geven. Na de activering is de inrichtingsstatus Geslaagd en bevat het service-exemplaar enkele gekoppelde URL's. Bijvoorbeeld:
Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup"
Voorbeelduitvoer:
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/2020 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 :
ResourceGroupName : myResourceGroup
Nadat het API Management-service-exemplaar is geïmplementeerd, kunt u het gebruiken. Begin met de zelfstudie om Uw eerste API importeren en publiceren.
Resources opschonen
U kunt de opdracht Remove-AzResourceGroup gebruiken om de resourcegroep en alle gerelateerde resources te verwijderen wanneer u ze niet meer nodig hebt.
Remove-AzResourceGroup -Name myResourceGroup