Schnellstart: Erstellen einer neuen Azure API Management-Instanz mithilfe von PowerShell
GILT FÜR: Verbrauch | Entwickler | Basic | Standard | Premium
In dieser Schnellstartanleitung erstellen Sie eine neue API Management-Instanz mithilfe von Azure PowerShell-Cmdlets. Nach dem Erstellen einer Instanz können Sie Azure PowerShell-Cmdlets für allgemeine Verwaltungsaktionen wie das Importieren von APIs in Ihrer API-Verwaltungsinstanz verwenden.
Azure API Management unterstützt Organisationen beim Veröffentlichen von APIs für externe, Partner- und interne Entwickler, um das volle Potenzial von Daten und Diensten nutzen zu können. API Management bietet die Kernkompetenzen zur Sicherstellung eines erfolgreichen API-Programms in Form von Entwicklerengagement, geschäftlichen Erkenntnissen, Analysen, Sicherheit und Schutz. Mit API Management können Sie moderne API-Gateways für vorhandene Back-End-Dienste, die an einem beliebigen Ort gehostet werden, erstellen und verwalten.
Wenn Sie kein Azure-Abonnement haben, erstellen Sie ein kostenloses Azure-Konto, bevor Sie beginnen.
Voraussetzungen
- Bei lokaler Verwendung von Azure PowerShell:
- Installieren der aktuellen Version des Az PowerShell-Moduls.
- Stellen Sie eine Verbindung mit Ihrem Azure-Konto mit dem Cmdlet Connect-AzAccount her.
- Bei Verwendung von Azure Cloud Shell:
- Weitere Informationen finden Sie in der Übersicht über Azure Cloud Shell.
Ressourcengruppe erstellen
Erstellen Sie mit New-AzResourceGroup eine Azure-Ressourcengruppe. Eine Ressourcengruppe ist ein logischer Container, in dem Azure-Ressourcen bereitgestellt und verwaltet werden.
Mit dem folgenden Befehl wird eine Ressourcengruppe mit dem Namen myResourceGroup am Standort „USA, Westen“ erstellt:
New-AzResourceGroup -Name myResourceGroup -Location WestUS
Erstellen einer API Management-Instanz
Da Sie nun über eine Ressourcengruppe verfügen, können Sie eine API Management-Dienstinstanz erstellen. Erstellen Sie eine solche Instanz mithilfe des New-AzApiManagement-Befehls, und geben Sie einen Dienstname sowie Details zum Herausgeber an. Der Dienstname muss in Azure eindeutig sein.
Im folgenden Beispiel wird myapim als Dienstname verwendet. Ersetzen Sie diesen Namen durch einen eindeutigen Wert. Aktualisieren Sie außerdem den Namen der Organisation des Herausgebers der API sowie die E-Mail-Adresse des Administrators, um Benachrichtigungen zu erhalten.
Standardmäßig erstellt der Befehl die Instanz im Developer-Tarif, wobei es sich um eine günstige Option zum Bewerten von Azure API Management handelt. Dieser Tarif ist nicht für die Produktion bestimmt. Weitere Informationen zu den Dienstebenen von API Management finden Sie unter Featurebasierter Vergleich der Azure API Management-Dienstebenen.
Tipp
Dies ist eine zeitintensive Aktion. Es dauert in der Regel zwischen 30 und 40 Minuten, einen API Management-Dienst mit diesem Tarif zu erstellen und zu aktivieren.
New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
-Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com"
Wenn der Befehl etwas zurückgibt, führen Sie Get-AzApiManagement aus, damit die Eigenschaften des Azure API Management-Diensts angezeigt werden. Nach der Aktivierung ist ProvisioningState erfolgreich und die Instanz verfügt über mehrere zugeordnete URLs. Beispiel:
Get-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup"
Beispielausgabe:
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
Sobald Ihre API Management-Dienstinstanz bereitgestellt wurde, können Sie sie verwenden. Beginnen Sie mit dem Tutorial Importieren und Veröffentlichen Ihrer ersten API.
Bereinigen von Ressourcen
Wenn die Ressourcengruppe und alle zugehörigen Ressourcen nicht mehr benötigt werden, können Sie sie mit dem Befehl Remove-AzResourceGroup entfernen.
Remove-AzResourceGroup -Name myResourceGroup