Importieren einer Azure-Funktionen-App als API in Azure API Management

GILT FÜR: Alle API Management-Ebenen

Azure API Management unterstützt das Importieren von Azure-Funktions-Apps als neue APIs und das Anfügen dieser Apps an vorhandene APIs. Bei diesem Prozess wird automatisch ein Hostschlüssel in der Azure-Funktions-App generiert, der dann einem benannten Wert in Azure API Management zugewiesen wird.

In diesem Artikel werden die Schritte zum Importieren und Testen einer Azure-Funktions-App als API in Azure API Management erläutert.

Sie lernen Folgendes:

• Importieren einer Azure-Funktionen-App als API
• Anfügen einer Azure-Funktionen-App an eine API
• Anzeigen des neuen Hostschlüssels der Azure-Funktionen-App und des benannten Azure API Management-Werts
• Testen der API im Azure-Portal

Voraussetzungen

• Absolvieren Sie den Schnellstart unter Schnellstart: Erstellen einer neuen Azure API Management-Dienstinstanz mithilfe des Azure-Portals.
• Stellen Sie sicher, dass Ihr Abonnement eine Azure Functions-App enthält. Weitere Informationen finden Sie unter Erstellen Ihrer ersten Funktion im Azure-Portal. Funktionen müssen einen HTTP-Trigger enthalten, und die Autorisierungsstufe muss auf Anonym oder Funktion festgelegt sein.

Hinweis

Sie können die API Management-Erweiterung für Visual Studio Code zum Importieren und Verwalten von APIs verwenden. Informationen zur Installation und zu den ersten Schritten finden Sie unter Tutorial: Verwenden der API Management-Erweiterung für Visual Studio Code zum Importieren und Verwalten von APIs.

Navigieren zur API Management-Instanz

1. Suchen Sie im Azure-Portal nach API Management-Dienste, und wählen Sie diese Option aus.

   

2. Wählen Sie auf der Seite API Management-Dienste Ihre API Management-Instanz aus.

   

Importieren einer Azure-Funktionen-App als neue API

Führen Sie die folgenden Schritte aus, um auf der Grundlage einer Azure-Funktionen-App eine neue API zu erstellen.

1. Navigieren Sie im Azure-Portal zu Ihrem API Management-Dienst, und wählen Sie im Menü APIs aus.

2. Wählen Sie in der Liste Neue API hinzufügen die Option Funktionen-App aus.

   

3. Klicken Sie auf Durchsuchen, um eine Funktionen-App für den Import auszuwählen.

   

4. Klicken Sie auf den Abschnitt Funktionen-App, um in der Liste der verfügbaren Funktionen-Apps eine App auszuwählen.

   

5. Suchen Sie die Funktionen-App, aus der Sie Funktionen importieren möchten, klicken Sie darauf, und klicken Sie auf Auswählen.

   

6. Wählen Sie die Funktionen aus, die Sie importieren möchten, und klicken Sie auf Auswählen.

   • Sie können Funktionen nur importieren, wenn sie auf einem HTTP-Trigger mit der Autorisierungsstufe Anonym oder Funktion basieren.

   

7. Wechseln Sie zur Ansicht Vollständig, und weisen Sie Ihrer neuen API Produkt zu.

8. Geben Sie bei Bedarf während der Erstellung andere Felder an, oder konfigurieren Sie sie später über die Registerkarte Einstellungen.

   • Die Einstellungen werden im Tutorial Importieren und Veröffentlichen Ihrer ersten API erläutert.

   Hinweis

   Produkte sind Zuordnungen einer oder mehrerer APIs, die Entwicklern über das Entwicklerportal angeboten werden. Entwickler müssen zunächst ein Produkt abonnieren, um Zugriff auf die API zu erhalten. Wenn sie ein Produkt abonniert haben, erhalten sie einen Abonnementschlüssel für jede API in diesem Produkt. Als Ersteller der API Management-Instanz sind Sie Administrator und haben dadurch standardmäßig alle Produkte abonniert.

   Jede API Management-Instanz enthält zwei Standardbeispielprodukte:

   • Starter
   • Unbegrenzt

9. Klicken Sie auf Erstellen.

Anfügen einer Azure-Funktionen-App an eine vorhandene API

Führen Sie die folgenden Schritte aus, um eine Azure-Funktionen-App zu einer vorhandenen API hinzuzufügen.

1. Klicken Sie in Ihrer Azure API Management-Dienstinstanz im Menü auf der linken Seite auf APIs.

2. Wählen Sie eine API aus, in die Sie eine Azure-Funktionen-App importieren möchten. Klicken Sie auf ... , und klicken Sie im Kontextmenü auf Importieren.

   

3. Klicken Sie auf die Kachel Funktionen-App.

   

4. Klicken Sie im Popupfenster auf Durchsuchen.

   

5. Klicken Sie auf den Abschnitt Funktionen-App, um in der Liste der verfügbaren Funktionen-Apps eine App auszuwählen.

   

6. Suchen Sie die Funktionen-App, aus der Sie Funktionen importieren möchten, klicken Sie darauf, und klicken Sie auf Auswählen.

   

7. Wählen Sie die Funktionen aus, die Sie importieren möchten, und klicken Sie auf Auswählen.

   

8. Klicken Sie auf Importieren.

   

Autorisierung

Beim Importieren einer Azure-Funktionen-App wird automatisch Folgendes generiert:

• Hostschlüssel in der Funktionen-App mit dem Namen „apim-{Name Ihrer Azure API Management-Dienstinstanz}“
• Benannter Wert in der Azure API Management-Instanz mit dem Namen „{Name der Instanz Ihrer Azure-Funktionen-App}-key“, die den erstellten Hostschlüssel enthält

Bei APIs, die nach dem 4. April 2019 erstellt werden, wird der Hostschlüssel in HTTP-Anforderungen von API Management in einem Header an die Funktionen-App übergeben. Bei älteren APIs wird der Hostschlüssel als Abfrageparameter übergeben. Sie können dieses Verhalten durch den PATCH BackendREST-API-Aufruf für die der Funktions-App zugeordnete Back-End-Entität ändern.

Warnung

Wenn Sie den Wert des Hostschlüssels der Azure-Funktions-App oder den benannten Wert von Azure API Management entfernen oder ändern, wird die Kommunikation zwischen den Diensten unterbrochen. Die Werte werden nicht automatisch synchronisiert.

Falls Sie den Hostschlüssel rotieren müssen, ändern Sie auch den benannten Wert in Azure API Management.

Zugreifen auf den Hostschlüssel der Azure-Funktionen-App

1. Navigieren Sie zur Instanz Ihrer Azure-Funktionen-App.

   

2. Wählen Sie im seitlichen Navigationsmenü im Abschnitt Funktionen die Option App-Schlüssel aus.

   

3. Die Schlüssel finden Sie im Abschnitt Hostschlüssel.

   

Zugreifen auf den benannten Wert in Azure API Management

Navigieren Sie zu Ihrer Azure API Management-Instanz, und klicken Sie im Menü auf der linken Seite auf Benannte Werte. Der Schlüssel der Azure-Funktionen-App ist dort gespeichert.

Testen der neuen API im Azure-Portal

Sie können Vorgänge direkt über das Azure-Portal aufrufen. Das Azure-Portal bietet eine komfortable Möglichkeit, die Vorgänge einer API anzuzeigen und zu testen.

1. Wählen Sie die im vorherigen Abschnitt erstellte API aus.

2. Wählen Sie die Registerkarte Testen aus.

3. Wählen Sie den Vorgang aus, den Sie testen möchten.

   • Auf der Seite werden Felder für Abfrageparameter und Header angezeigt.
   • Einer der Header ist „Ocp-Apim-Subscription-Key“. Er steht für den Abonnementschlüssel des Produkts, das dieser API zugeordnet ist.
   • Als Ersteller der API Management-Instanz sind Sie bereits Administrator, sodass der Schlüssel automatisch eingetragen wird.

4. Wählen Sie Send (Senden) aus.

   • Wenn der Test erfolgreich ist, antwortet das Back-End mit 200 OK und einigen Daten.

Zugehörige Themen

• Einschränkungen beim API-Import
• Importieren einer OpenAPI-Spezifikation
• Importieren einer SOAP-API
• Importieren einer SOAP-API und Konvertieren dieser in REST
• Importieren einer App Service-API
• Importieren einer Container-App-API
• Importieren einer WebSocket-API
• Importieren einer GraphQL-API
• Importieren eines GraphQL-Schemas und Einrichten von Feldauflösern
• Importieren einer Azure Functions-App als API
• Importieren einer Logik-App als API
• Tutorial: Integrieren von API Management in Service Fabric in Azure
• Importieren einer OData-API
• Importieren von SAP OData-Metadaten
• Importieren einer gRPC-API
• Bearbeiten von APIs

Nächste Schritte

Transformieren und Schützen einer veröffentlichten API