Snabbstart: Skapa en ny Azure API Management-tjänstinstans med hjälp av PowerShell
Azure API Management (APIM) hjälper organisationer att publicera API:er till externa partner och interna utvecklare så att de kan få ut maximalt av sina data och tjänster. API Management lägger grunden till ett effektivt API-program genom engagerade utvecklare, affärsinsikter, analyser, hög säkerhet och skydd. Med APIM kan du skapa och hantera moderna API-gatewayer för befintliga serverdeltjänster som ligger var som helst. Mer information finns i Översikt.
Den här snabbstarten beskriver stegen för att skapa en API Management instans med hjälp av Azure PowerShell-cmdlets.
Om du inte har en Azure-prenumerationkan du skapa ett kostnads fritt konto innan du börjar.
Anteckning
I den här artikeln används Azure Az PowerShell-modulen, som är den rekommenderade PowerShell-modulen för att interagera med Azure. För att komma igång med Az PowerShell kan du läsa artikeln om att installera Azure PowerShell. Information om hur du migrerar till Az PowerShell-modulen finns i artikeln om att migrera Azure PowerShell från AzureRM till Az.
Använda Azure Cloud Shell
Azure är värd för Azure Cloud Shell, en interaktiv gränssnittsmiljö som du kan använda via webbläsaren. Du kan använda antingen Bash eller PowerShell med Cloud Shell för att arbeta med Azure-tjänster. Du kan använda förinstallerade Cloud Shell-kommandon för att köra koden i den här artikeln utan att behöva installera något i din lokala miljö.
Så här startar du Azure Cloud Shell:
| Alternativ | Exempel/länk |
|---|---|
| Välj Prova i det övre högra hörnet av ett kodblock. Om du väljer Prova kopieras koden inte automatiskt till Cloud Shell. |  |
| Gå till https://shell.azure.com eller Välj knappen Starta Cloud Shell för att öppna Cloud Shell i webbläsaren. |  |
| Välj knappen Cloud Shell på menyn längst upp till höger i Azure-portalen. |  |
Så här kör du koden i den här artikeln i Azure Cloud Shell:
Starta Cloud Shell.
Kopiera koden genom att klicka på knappen Kopiera på ett kodblock.
Klistra in koden i Cloud Shell-sessionen genom att välja Ctrl+Skift+V på Windows och Linux eller genom att välja Cmd+Skift+V på macOS.
Välj Retur för att köra koden.
Om du väljer att installera och använda PowerShell lokalt behöver du ha version 1.0 eller senare av Azure PowerShell-modulen för den här självstudien. Kör Get-Module -ListAvailable Az för att hitta versionen. Om du behöver uppgradera kan du läsa Install Azure PowerShell module (Installera Azure PowerShell-modul). Om du kör PowerShell lokalt måste du också köra Connect-AzAccount för att skapa en anslutning till Azure.
Skapa resursgrupp
Skapa en Azure-resursgrupp med New-AzResourceGroup. En resursgrupp är en logisk container där Azure-resurser distribueras och hanteras.
Följande kommando skapar en resursgrupp med namnet myResourceGroup på platsen USA, västra:
New-AzResourceGroup -Name myResourceGroup -Location WestUS
Skapa en API Management-tjänst
Nu när du har en resursgrupp kan du skapa en API Management-tjänstinstans. Skapa en med hjälp av New-AzApiManagement och ange ett tjänstnamn och information om utgivaren. Tjänstnamnet måste vara unikt i Azure.
I följande exempel används myapim som tjänstnamn. Uppdatera namnet till ett unikt värde. Uppdatera även organisationsnamnet för API-utgivaren och administratörens e-postadress för att ta emot meddelanden.
Som standard skapar kommandot instansen på developer-nivån, ett ekonomiskt alternativ för att utvärdera Azure API Management. Den här nivån är inte till för produktionsanvändning. Mer information om att skala API Management-nivåerna finns i avsnittet Uppgradera och skala.
Anteckning
Det här är en långvarig åtgärd. Det kan ta mellan 30 och 40 minuter att skapa och aktivera en API Management på den här nivån.
New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
-Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com"
När kommandot returneras kör du Get-AzApiManagement för att visa egenskaperna för Azure API Management tjänsten. Efter aktiveringen är etableringsstatusen Lyckades och tjänstinstansen har flera associerade URL:er. Exempel:
Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup"
Exempel på utdata:
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
När API Management tjänstinstansen har distribuerats är du redo att använda den. Börja med självstudien för att importera och publicera ditt första API.
Rensa resurser
När den inte längre behövs kan du använda kommandot Remove-AzResourceGroup för att ta bort resursgruppen och alla relaterade resurser.
Remove-AzResourceGroup -Name myResourceGroup