Schnellstart: Erstellen einer neuen Azure API Management-Dienstinstanz mit Bicep
GILT FÜR: Alle API Management-Ebenen
In dieser Schnellstartanleitung wird beschrieben, wie Sie mit einer Bicep-Datei eine Azure API Managementinstanz erstellen. Sie können Bicep auch für allgemeine Verwaltungsaufgaben wie das Importieren von APIs in Ihrer API Managementinstanz 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.
Bicep ist eine domänenspezifische Sprache (Domain-Specific Language, DSL), die eine deklarative Syntax zur Bereitstellung von Azure-Ressourcen verwendet. Sie bietet eine präzise Syntax, zuverlässige Typsicherheit und Unterstützung für die Wiederverwendung von Code. Bicep bietet die beste Form der Erstellung für Ihre Infrastructure-as-Code-Lösungen in Azure.
Voraussetzungen
Wenn Sie kein Azure-Abonnement besitzen, können Sie ein kostenloses Konto erstellen, bevor Sie beginnen.
Für die Azure CLI:
Verwenden Sie die Bash-Umgebung in Azure Cloud Shell. Weitere Informationen finden Sie unter Schnellstart für Bash in Azure Cloud Shell.
Wenn Sie CLI-Referenzbefehle lieber lokal ausführen, installieren Sie die Azure CLI. Wenn Sie Windows oder macOS ausführen, sollten Sie die Azure CLI in einem Docker-Container ausführen. Weitere Informationen finden Sie unter Ausführen der Azure CLI in einem Docker-Container.
Wenn Sie eine lokale Installation verwenden, melden Sie sich mithilfe des Befehls az login bei der Azure CLI an. Führen Sie die in Ihrem Terminal angezeigten Schritte aus, um den Authentifizierungsprozess abzuschließen. Informationen zu anderen Anmeldeoptionen finden Sie unter Anmelden mit der Azure CLI.
Installieren Sie die Azure CLI-Erweiterung beim ersten Einsatz, wenn Sie dazu aufgefordert werden. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden von Erweiterungen mit der Azure CLI.
Führen Sie az version aus, um die installierte Version und die abhängigen Bibliotheken zu ermitteln. Führen Sie az upgrade aus, um das Upgrade auf die aktuelle Version durchzuführen.
Für Azure PowerShell:
- 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.
- Bei lokaler Verwendung von Azure PowerShell:
Überprüfen der Bicep-Datei
Die in dieser Schnellstartanleitung verwendete Bicep-Datei stammt aus den Azure-Schnellstartvorlagen.
@description('The name of the API Management service instance')
param apiManagementServiceName string = 'apiservice${uniqueString(resourceGroup().id)}'
@description('The email address of the owner of the service')
@minLength(1)
param publisherEmail string
@description('The name of the owner of the service')
@minLength(1)
param publisherName string
@description('The pricing tier of this API Management service')
@allowed([
'Consumption'
'Developer'
'Basic'
'Basicv2'
'Standard'
'Standardv2'
'Premium'
])
param sku string = 'Developer'
@description('The instance size of this API Management service.')
@allowed([
0
1
2
])
param skuCount int = 1
@description('Location for all resources.')
param location string = resourceGroup().location
resource apiManagementService 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
name: apiManagementServiceName
location: location
sku: {
name: sku
capacity: skuCount
}
properties: {
publisherEmail: publisherEmail
publisherName: publisherName
}
}
In der Bicep-Datei wird die folgende Ressource definiert:
In diesem Beispiel wird die API Management-Instanz mithilfe der Bicep-Datei standardmäßig im Developer-Tarif konfiguriert. Hierbei handelt es sich um eine kostengünstige Option zum Evaluieren von Azure API Management. Dieser Tarif ist nicht für die Produktion bestimmt.
Weitere Bicep-Beispiele für Azure API Management finden Sie unter Azure-Schnellstartvorlagen.
Bereitstellen der Bicep-Datei
Sie können entweder die Azure CLI oder Azure PowerShell zum Bereitstellen der Bicep-Datei verwenden. Weitere Informationen zum Bereitstellen von Bicep-Dateien finden Sie unter Bereitstellen.
Speichern Sie die Bicep-Datei als main.bicep auf Ihrem lokalen Computer.
Stellen Sie die Bicep-Datei entweder mit Azure CLI oder mit Azure PowerShell bereit.
az group create --name exampleRG --location eastus az deployment group create --resource-group exampleRG --template-file main.bicep --parameters publisherEmail=<publisher-email> publisherName=<publisher-name>
Ersetzen Sie <publisher-name> und <publisher-email> durch den Namen der Organisation des Herausgebers der API sowie die E-Mail-Adresse, um Benachrichtigungen zu erhalten.
Nach Abschluss der Bereitstellung sollte eine Meldung mit dem Hinweis angezeigt werden, dass die Bereitstellung erfolgreich war.
Tipp
Es dauert in der Regel zwischen 30 und 40 Minuten, einen API Management-Dienst im Developer-Tarif zu erstellen und zu aktivieren. Die Zeiten variieren je nach Ebene.
Überprüfen der bereitgestellten Ressourcen
Verwenden Sie das Azure-Portal, Azure CLI oder Azure PowerShell, um die bereitgestellte App Configuration-Ressource in der Ressourcengruppe aufzulisten.
az resource list --resource-group exampleRG
Sobald Ihre API Management-Dienstinstanz online ist, können Sie sie verwenden. Beginnen Sie mit dem Tutorial Importieren und Veröffentlichen Ihrer ersten API.
Bereinigen von Ressourcen
Falls Sie auch die nachfolgenden Tutorials durcharbeiten möchten, ist es ggf. ratsam, die API Management-Instanz beizubehalten. Wenn Sie die Ressourcen nicht mehr benötigen, löschen Sie die Ressourcengruppe. Dadurch werden die Ressourcen in der Ressourcengruppe gelöscht.
az group delete --name exampleRG