Freigeben über


Schnellstart: Erstellen einer neuen Azure API-Verwaltungsinstanz mithilfe von PowerShell

GILT FÜR: Verbrauch | Developer | Basic | Standard | Premium

In dieser Schnellstartanleitung erstellen Sie eine neue API-Verwaltungsinstanz 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 hilft Organisationen, APIs für externe, Partner und interne Entwickler zu veröffentlichen, um das Potenzial ihrer Daten und Dienste zu entsperren. 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 nicht über ein Azure-Konto verfügen, erstellen Sie ein kostenloses Konto , bevor Sie beginnen.

Voraussetzungen

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 namens "myResourceGroup " am Standort "West US" erstellt:

New-AzResourceGroup -Name myResourceGroup -Location WestUS

Erstellen einer API Management-Instanz

Nachdem Sie nun über eine Ressourcengruppe verfügen, können Sie eine API-Verwaltungsdienstinstanz erstellen. Erstellen Sie eine solche Instanz mithilfe des New-AzApiManagement-Befehls, und geben Sie einen Dienstname sowie Details zum Herausgeber an. Der Dienstname muss innerhalb von Azure eindeutig sein.

Im folgenden Beispiel wird myapim für den Dienstnamen verwendet. Aktualisieren Sie den Namen auf einen eindeutigen Wert. Aktualisieren Sie außerdem den Organisationsnamen des API-Herausgebers und die E-Mail-Adresse des Administrators, um Benachrichtigungen zu erhalten.

Standardmäßig erstellt der Befehl die Instanz auf der Entwicklerebene, eine wirtschaftliche Option zum Auswerten der Azure-API-Verwaltung. Dieser Tarif ist nicht für die Produktion bestimmt. Weitere Informationen zu den API-Verwaltungsebenen finden Sie im featurebasierten Vergleich der Azure API-Verwaltungsebenen.

Tipp

Dies ist eine lang andauernde Aktion. Es kann zwischen 30 und 40 Minuten dauern, bis ein API-Verwaltungsdienst in dieser Ebene erstellt und aktiviert wird.

New-AzApiManagement -Name "myapim" -ResourceGroupName "myResourceGroup" `
  -Location "West US" -Organization "Contoso" -AdminEmail "admin@contoso.com" 

Wenn der Befehl zurückgegeben wird, führen Sie Get-AzApiManagement aus, um die Eigenschaften des Azure API-Verwaltungsdiensts anzuzeigen. 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

Nachdem Ihre API-Verwaltungsdienstinstanz bereitgestellt wurde, können Sie sie verwenden. Beginnen Sie mit dem Tutorial Importieren und Veröffentlichen Ihrer ersten API.

Bereinigen von Ressourcen

Wenn sie nicht mehr benötigt wird, können Sie den Befehl "Remove-AzResourceGroup " verwenden, um die Ressourcengruppe und alle zugehörigen Ressourcen zu entfernen.

Remove-AzResourceGroup -Name myResourceGroup

Nächste Schritte