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

2025-05-20

GILT FÜR: Alle API Management-Ebenen

Azure API Management unterstützt das Importieren von Azure-Funktions-Apps als neue APIs oder das Anfügen an vorhandene APIs. Der Prozess generiert automatisch einen Hostschlüssel in der Azure-Funktions-App, der dann einem benannten Wert in der API-Verwaltung zugewiesen wird.

Hinweis

Dieses Feature ist derzeit in Arbeitsbereichen nicht verfügbar.

In diesem Artikel wird beschrieben, wie Sie eine Azure-Funktions-App als API in Azure API Management importieren und die API testen.

Hier erfahren Sie, wie Sie:

Importieren einer Azure-Funktions-App als API
Anfügen einer Azure-Funktions-App an eine API
Anzeigen des neuen Hostschlüssels der Funktions-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 Sie über eine Azure-Funktions-App in Ihrem Abonnement verfügen. Weitere Informationen finden Sie unter Erste Schritte mit Azure Functions. Die Funktion muss über einen HTTP-Trigger verfügen. Die Autorisierungsstufe muss auf "Anonym" oder " Funktion" festgelegt werden.

Hinweis

Sie können auch die API-Verwaltungserweiterung für Visual Studio Code verwenden, um Ihre APIs zu importieren und zu verwalten. Führen Sie das Lernprogramm zur API-Verwaltungserweiterung aus, um zu beginnen.

Importieren einer Azure-Funktions-App als neue API

So erstellen Sie eine neue API aus einer Azure-Funktions-App:

Navigieren Sie im Azure-Portal zu Ihrem API-Verwaltungsdienst.
Wählen Sie APIs>APIs im linken Bereich aus.
Wählen Sie unter "Aus Azure-Ressource erstellen" die Option "Funktions-App" aus:
Wählen Sie die Schaltfläche "Durchsuchen" aus :
Klicken Sie auf die Schaltfläche " Auswählen " unter " Erforderliche Einstellungen konfigurieren ", um aus der Liste der verfügbaren Funktions-Apps auszuwählen:
Suchen Sie die Funktions-App, aus der Sie Funktionen importieren möchten, wählen Sie sie aus, und klicken Sie dann auf "Auswählen":
Wählen Sie die Funktionen aus, die Sie importieren möchten, und klicken Sie auf "Auswählen". Sie können nur Funktionen importieren, die über einen HTTP-Trigger und eine Autorisierungsstufe "Anonym" oder " Funktion " verfügen.
Wechseln Sie zur Vollansicht , und weisen Sie Ihrer neuen API ein Produkt zu.
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 abonniert werden, erhalten sie einen Abonnementschlüssel für jede API im Produkt. Wenn Sie die API-Verwaltungsinstanz erstellt haben, sind Sie Administrator und sind standardmäßig für jedes Produkt abonniert.

In einigen Preisstufen enthalten API-Verwaltungsinstanzen zwei Standardbeispielprodukte:
- Anlasser
- Unbegrenzt
Geben Sie bei Bedarf weitere Einstellungen an. Sie können einstellungen auch später über die Registerkarte "Einstellungen " angeben. Diese Einstellungen werden im Ersten API-Lernprogramm zum Importieren und Veröffentlichen erläutert.
Wählen Sie "Erstellen" aus.

Anfügen einer Funktions-App an eine vorhandene API

So fügen Sie eine Funktions-App an eine vorhandene API an:

Wählen Sie in Ihrer Azure API Management-DienstinstanzAPIs> im linken Bereich aus.
Wählen Sie eine API aus, in die Sie eine Funktions-App importieren möchten. Wählen Sie die Auslassungspunkte (...) neben der API und dann Importieren aus:
Wählen Sie die Funktions-App-Kachel aus.
Wählen Sie im Fenster "Aus Funktions-App importieren" die Option "Durchsuchen" aus:
Klicken Sie auf die Schaltfläche " Auswählen " unter " Erforderliche Einstellungen konfigurieren ", um aus der Liste der verfügbaren Funktions-Apps auszuwählen:
Suchen Sie die Funktions-App, aus der Sie Funktionen importieren möchten, wählen Sie sie aus, und klicken Sie dann auf "Auswählen":
Wählen Sie die Funktionen aus, die Sie importieren möchten, und klicken Sie dann auf "Auswählen":
Wählen Sie "Importieren" aus:

Autorisierung

Wenn Sie eine Azure-Funktions-App importieren, werden diese Elemente automatisch generiert:

Ein Hostschlüssel in der Funktions-App. Der Schlüssel wird benannt apim-<your API Management service instance name>.
Ein benannter Wert in der API-Verwaltungsinstanz mit dem Namen <your Azure function app instance name>-key. Dieser Wert enthält den Hostschlüssel.

Für APIs, die nach dem 4. April 2019 erstellt wurden, wird der Hostschlüssel in HTTP-Anforderungen von der API-Verwaltung an die Funktions-App in einem Header übergeben. Bei älteren APIs wird der Hostschlüssel als Abfrageparameter übergeben. Sie können dieses Verhalten ändern, indem Sie den PATCH BackendREST-API-Aufruf für die Backend Entität verwenden, die der Funktions-App zugeordnet ist.

Warnung

Durch das Entfernen oder Ändern des Hostschlüsselwerts der Azure-Funktion-App oder des benannten Werts in der API-Verwaltung wird die Kommunikation zwischen den Diensten deaktiviert. Die Werte werden nicht automatisch synchronisiert.

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

Zugreifen auf einen Funktions-App-Hostschlüssel

Navigieren Sie zu Ihrer Azure-Funktions-App-Instanz:
Wählen Sie im Abschnitt "Funktionen " im linken Bereich "App-Schlüssel" aus:
Suchen Sie die Schlüssel im Abschnitt "Hostschlüssel ":

Zugreifen auf den benannten Wert in der API-Verwaltung

Navigieren Sie zu Ihrer API-Verwaltungsinstanz, und wählen Sie im linken Bereich APIs>benannte Werte aus. Der App-Schlüssel der Azure-Funktion wird 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.

Wählen Sie die im vorherigen Abschnitt erstellte API aus.
Wählen Sie die Registerkarte Testen aus.
Wählen Sie den Vorgang aus, den Sie testen möchten.
- Auf der Seite werden Felder für Abfrageparameter und Header angezeigt.
- Eine der Kopfzeilen ist Ocp-Apim-Subscription-Key. Dieser Header ist für den Produktabonnementschlüssel vorgesehen, der der API zugeordnet ist.
- Wenn Sie die API-Verwaltungsinstanz erstellt haben, sind Sie Administrator, sodass der Schlüssel automatisch ausgefüllt wird.
Wählen Sie Send (Senden) aus.

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

Freigeben über