Schnellstart: Erstellen einer neuen Azure API Management-Dienstinstanz mit einer ARM-Vorlage

Artikel
04/09/2024

GILT FÜR: Alle API Management-Ebenen

In dieser Schnellstartanleitung wird beschrieben, wie Sie mit einer ARM-Vorlage (Azure Resource Manager) eine Azure API Managementinstanz erstellen. Sie können ARM-Vorlagen 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.

Eine Azure Resource Manager-Vorlage ist eine JSON-Datei (JavaScript Object Notation), die die Infrastruktur und die Konfiguration für Ihr Projekt definiert. Die Vorlage verwendet eine deklarative Syntax. Sie beschreiben Ihre geplante Bereitstellung, ohne die Abfolge der Programmierbefehle zum Erstellen der Bereitstellung zu schreiben.

Wenn Ihre Umgebung die Voraussetzungen erfüllt und Sie mit der Verwendung von ARM-Vorlagen vertraut sind, klicken Sie auf die Schaltfläche In Azure bereitstellen. Die Vorlage wird im Azure-Portal geöffnet.

Voraussetzungen

Wenn Sie kein Azure-Abonnement besitzen, können Sie ein kostenloses Konto erstellen, bevor Sie beginnen.

Überprüfen der Vorlage

Die in dieser Schnellstartanleitung verwendete Vorlage stammt von der Seite mit den Azure-Schnellstartvorlagen.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.26.54.24096",
      "templateHash": "15176578550391235821"
    }
  },
  "parameters": {
    "apiManagementServiceName": {
      "type": "string",
      "defaultValue": "[format('apiservice{0}', uniqueString(resourceGroup().id))]",
      "metadata": {
        "description": "The name of the API Management service instance"
      }
    },
    "publisherEmail": {
      "type": "string",
      "minLength": 1,
      "metadata": {
        "description": "The email address of the owner of the service"
      }
    },
    "publisherName": {
      "type": "string",
      "minLength": 1,
      "metadata": {
        "description": "The name of the owner of the service"
      }
    },
    "sku": {
      "type": "string",
      "defaultValue": "Developer",
      "allowedValues": [
        "Consumption",
        "Developer",
        "Basic",
        "Basicv2",
        "Standard",
        "Standardv2",
        "Premium"
      ],
      "metadata": {
        "description": "The pricing tier of this API Management service"
      }
    },
    "skuCount": {
      "type": "int",
      "defaultValue": 1,
      "allowedValues": [
        0,
        1,
        2
      ],
      "metadata": {
        "description": "The instance size of this API Management service."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Location for all resources."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.ApiManagement/service",
      "apiVersion": "2023-05-01-preview",
      "name": "[parameters('apiManagementServiceName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('sku')]",
        "capacity": "[parameters('skuCount')]"
      },
      "properties": {
        "publisherEmail": "[parameters('publisherEmail')]",
        "publisherName": "[parameters('publisherName')]"
      }
    }
  ]
}

In der Vorlage ist die folgende Ressource definiert:

Microsoft.ApiManagement/service

Weitere Beispiele für Azure API Management-Vorlagen finden Sie unter Azure-Schnellstartvorlagen.

Bereitstellen der Vorlage

Klicken Sie auf das folgende Bild, um sich bei Azure anzumelden und eine Vorlage zu öffnen. Von der Vorlage wird eine Instanz des API Management-Diensts mit einem automatisch generierten Namen erstellt.

In diesem Beispiel wird die Instanz mit dem 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 Informationen zum Skalieren der API Management-Tarife finden Sie unter Upgrade and scale an API Management instance (Upgraden und Skalieren einer API Management-Instanz).
Wählen Sie die folgenden Werte aus, bzw. geben Sie sie ein.
- Abonnement: Wählen Sie ein Azure-Abonnement aus.
- Ressourcengruppe: Wählen Sie die Option Neu erstellen aus, geben Sie einen eindeutigen Namen für die Ressourcengruppe ein, und wählen Sie dann OK aus.
- Region: Wählen Sie einen Standort für die Ressourcengruppe aus. Beispiel: USA, Mitte
- Publisher Email (E-Mail-Adresse des Herausgebers): Geben Sie eine E-Mail-Adresse für den Empfang von Benachrichtigungen ein.
- Publisher Name (Name des Herausgebers):Geben Sie den gewünschten Namen für den API-Herausgeber ein.
- SKU: Übernehmen Sie den Standardwert für Developer. Alternativ können Sie einen anderen Wert auswählen.
- SKU Count (SKU-Anzahl): Übernehmen Sie den Standardwert.
- Location (Speicherort): Übernehmen Sie den generierten Speicherort für den API Management-Dienst.
Wählen Sie Überprüfen und erstellen aus, und lesen Sie sich die Geschäftsbedingungen durch. Wählen Sie Erstellen aus, wenn Sie die Bedingungen akzeptieren.

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.
Nach der erfolgreichen Erstellung der Instanz erhalten Sie eine Benachrichtigung:

Zum Bereitstellen der Vorlage wird das Azure-Portal verwendet. Neben dem Azure-Portal können Sie Azure PowerShell, die Azure-Befehlszeilenschnittstelle (Azure CLI) und die REST-API verwenden. Informationen zu anderen Bereitstellungsmethoden finden Sie unter Bereitstellen von Vorlagen.

Überprüfen der bereitgestellten Ressourcen

Verwenden Sie das Azure-Portal, um die bereitgestellten Ressourcen zu überprüfen, oder nutzen Sie Tools wie die Azure CLI oder Azure PowerShell, um sie aufzulisten.

Suchen Sie im Azure-Portal nach API Management-Dienste, und wählen Sie diese Option aus. Wählen Sie anschließend die von Ihnen erstellte Dienstinstanz aus.
Sehen Sie sich auf der Seite Übersicht die Eigenschaften Ihres Diensts an.

Seite mit der Dienstübersicht

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.

Suchen Sie im Azure-Portal nach Ressourcengruppen, und wählen Sie die entsprechende Option aus. Die Option Ressourcengruppen kann auch auf der Startseite von Azure ausgewählt werden.
Wählen Sie auf der Seite Ressourcengruppen Ihre Ressourcengruppe aus.
Wählen Sie auf der Ressourcengruppenseite die Option Ressourcengruppe löschen aus.
Geben Sie den Namen Ihrer Ressourcengruppe ein, und wählen Sie Löschen aus.

Nächste Schritte

Tutorial: Importieren und Veröffentlichen Ihrer ersten API