Snabbstart: Skapa en ny Azure API Management-instans med hjälp av PowerShell
GÄLLER FÖR: Förbrukning | Utvecklare | Grundläggande | Standard | Premium
I den här snabbstarten skapar du en ny API Management-instans med hjälp av Azure PowerShell-cmdletar. När du har skapat en instans kan du använda Azure PowerShell-cmdletar för vanliga hanteringsåtgärder som att importera API:er i din API Management-instans.
Azure API Management hjälper organisationer att publicera API:er till externa utvecklare, partner och interna utvecklare för att frigöra potentialen för 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 API Management skapar och hanterar du moderna API-gatewayer för befintliga serverdelstjänster var som helst.
Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt Azure-konto innan du börjar.
Förutsättningar
- Om du väljer att använda Azure PowerShell lokalt:
- Installera den senaste versionen av Az PowerShell-modulen.
- Anslut till ditt Azure-konto med cmdleten Anslut-AzAccount.
- Om du väljer att använda Azure Cloud Shell:
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-instans
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 utgivarinformation. Tjänstnamnet måste vara unikt i Azure.
I följande exempel används myapim för tjänstnamnet. 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å nivån Utvecklare, ett ekonomiskt alternativ för att utvärdera Azure API Management. Den här nivån är inte avsedd för produktionsanvändning. Mer information om API Management-nivåerna finns i Funktionsbaserad jämförelse av Azure API Management-nivåerna.
Dricks
Det här är en tidskrävande åtgärd. Det kan ta mellan 30 och 40 minuter att skapa och aktivera en API Management-tjänst 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 ProvisioningState är Lyckades och instansen har flera associerade URL:er. Till 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/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
När din API Management-tjänstinstans 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