Freigeben über

Generieren von Aufrufcode für Benutzerdatenfunktionen

Nachdem Sie Ihre Benutzerdatenfunktionen veröffentlicht haben, können Sie sie aus Fabric-Elementen oder externen Anwendungen aufrufen. Anstatt den Aufrufcode von Grund auf neu zu schreiben, verwenden Sie das Feature "Code generieren", um automatisch sofort einsatzbereite Codevorlagen zu erstellen.

Wählen Sie die Codegenerierungsoption basierend auf Ihrem Integrationsszenario aus:

  • Fabric Notebooks-Code (Python) – Zum Aufrufen von Funktionen aus Fabric-Notizbüchern, die eine Möglichkeit zur Integration in Fabric-Elemente sind. Weitere Fabric-Elemente wie Pipelines und Aktivator finden Sie in der Integrationsdokumentation.
  • Clientanwendungscode (Python, C#, Node.js) – Zum Aufrufen Ihrer Funktionen aus externen Anwendungen über den eindeutigen REST-Endpunkt, den jede Funktion verfügbar macht. Dies ermöglicht die Integration in Web-Apps, Dienste oder ein beliebiges System außerhalb von Fabric.
  • OpenAPI-Spezifikation (JSON, YAML) – Für API-Verwaltungsplattformen, KI-Agents oder für das Generieren von Client-SDKs. Verwenden Sie diese Funktion, um Ihre Funktionen in Azure API Management zu integrieren, KI-Systeme zu konfigurieren oder Bibliotheken für externe Anwendungen zu generieren.

Voraussetzungen

Bevor Sie Aufrufcode generieren, benötigen Sie Folgendes:

  • Ein veröffentlichtes Element "Benutzerdatenfunktionen" mit mindestens einer Funktion
  • Zugriff auf das Element "Benutzerdatenfunktionen" im Fabric-Portal
  • Mindestens Execute-Berechtigung für das Element 'Benutzerdatenfunktionen' haben, um den Aufrufcode zu generieren und zu verwenden.

Generieren von Code für Fabric-Notizbücher

Verwenden Sie bei der Integration mit Fabric-Elementen diese Option, um Ihre Funktionen aus Fabric-Notizbüchern aufzurufen. Der generierte Code verwendet das integrierte mssparkutils.userDataFunction Hilfsprogramm, das eine einfache Möglichkeit zum Aufrufen von Funktionen bietet, ohne Authentifizierung oder Endpunkte zu verwalten. Dies ist ideal für Datenverarbeitungsworkflows, explorative Analysen und Machine Learning-Pipelines innerhalb der Fabric-Umgebung.

  1. Öffnen Sie das Element "Benutzerdatenfunktionen" im Fabric-Portal.

  2. Wählen Sie auf der Registerkarte "Start" die Option "Aufrufcode generieren>Clientcode" aus.

  3. Wählen Sie unter "Aufrufen aus" die Option " Notizbuch " aus der Dropdownliste aus.

  4. Wählen Sie den Funktionsnamen aus, den Sie aufrufen möchten.

  5. Der Code wird automatisch in Python generiert. (Python ist die einzige Sprache, die für Notizbuchaufrufcode verfügbar ist.)

    Screenshot des generierten Notizbuchaufrufcodes.

  6. Kopieren Sie den generierten Codeausschnitt.

  7. Fügen Sie sie in eine neue Zelle in Ihr Fabric-Notizbuch ein.

  8. Aktualisieren Sie die Funktionsparameter mit Ihren tatsächlichen Werten. Der generierte Code enthält einen Kommentar, der zeigt, wo aktualisiert werden soll:

    # UPDATE BELOW: Update the request body based on the inputs to your function
myFunctions.hello_fabric(name = "string")

  9. Führen Sie die Zelle aus, um Ihre Funktion aufzurufen.

Weitere Informationen finden Sie unter Fabric Notebook User Data Functions Utilities.

Generieren von Code für Clientanwendungen

Verwenden Sie bei der Integration in externe Anwendungen diese Option, um Ihre Funktionen über den eindeutigen REST-Endpunkt aufzurufen, den jede Funktion verfügbar macht. Der generierte Code enthält das Authentifizierungssetup mithilfe der Microsoft Entra-ID und behandelt den HTTP-Anforderungs-/Antwortfluss. Auf diese Weise können Sie Ihre Fabric-Funktionen aus Web-Apps, mobilen Apps, Microservices oder einem beliebigen System außerhalb der Fabric-Umgebung aufrufen.

  1. Öffnen Sie das Element "Benutzerdatenfunktionen" im Fabric-Portal.

  2. Wählen Sie auf der Registerkarte "Start" die Option "Aufrufcode generierenClientcode" aus.

  3. Wählen Sie unter "Aufrufen aus" die Option "Clientanwendung" aus der Dropdownliste aus.

  4. Wählen Sie den Funktionsnamen aus, den Sie aufrufen möchten.

  5. Wählen Sie Ihre Programmiersprache aus:

    • Python
    • C#
    • Node.js

    Screenshot der Clientcodeausgabe.

  6. Kopieren Sie den generierten Code, und fügen Sie ihn Ihrer Anwendung hinzu.

  7. Überprüfen Sie die Codestruktur:

    • Authentifizierung – Verwendet InteractiveBrowserCredential zum Abrufen eines Tokens (nur für Entwicklung/Test)
    • Endpunkt-URL – Der eindeutige REST-Endpunkt für Ihre spezifische Funktion
    • Anforderungstext – Enthält die Eingabeparameter, die Ihre Funktion erwartet

  8. Aktualisieren Sie den request_body Abschnitt mit den tatsächlichen Parameterwerten. Der generierte Code enthält einen Kommentar, der zeigt, wo aktualisiert werden soll:

    # UPDATE HERE: Update the request body based on the inputs to your function 
request_body = {
    "name": "string"
}

  9. Ersetzen Sie für Produktionsanwendungen den Authentifizierungscode durch die richtige Registrierung der Microsoft Entra-ID-Anwendung. Der generierte Code enthält eine Warnung und einen Link zu Anleitungen für die Produktionsauthentifizierung.

Eine vollständige exemplarische Vorgehensweise, einschließlich des Setups der Produktionsauthentifizierung, finden Sie unter Aufrufen von Benutzerdatenfunktionen aus einer Python-Anwendung.

OpenAPI-Spezifikation generieren

Wenn Sie Ihre Funktionen in API-Verwaltungsplattformen, KI-Agents oder das Generieren von Client-SDKs für externe Anwendungen integrieren müssen, verwenden Sie diese Option, um eine OpenAPI-Spezifikation zu erstellen. Die OpenAPI-Spezifikation bietet eine maschinenlesbare Beschreibung der REST-Endpunkte Ihrer Funktion, wodurch Tools und Systeme programmgesteuert erkannt und in Ihre Funktionen integriert werden können.

  1. Öffnen Sie das Element "Benutzerdatenfunktionen" im Fabric-Portal.

  2. Wählen Sie auf der Registerkarte "Start" Aufrufcode generieren> und OpenAPI-Spezifikation aus.

  3. Wählen Sie im Dialogfeld "OpenAPI-Spezifikation generieren " das Ausgabeformat aus:

    • JSON
    • YAML

    Screenshot der OpenAPI-Spezifikation.

  4. Kopieren Sie die generierte Spezifikation. Die Spezifikation umfasst:

    • Alle veröffentlichten Funktionen im Element "Benutzerdatenfunktionen"
    • Anforderungs- und Antwortschemas für jede Funktion
    • Authentifizierungsanforderungen (Bearertoken)
    • Standardmäßige HTTP-Fehlerantworten (400, 401, 403, 408, 413, 500)
    • Funktionszusammenfassungen und Beschreibungen (aus Docstrings)

Verbessern der OpenAPI-Ausgabe mit Docstrings

Die Qualität Ihrer OpenAPI-Spezifikation hängt von der Dokumentation im Funktionscode ab. Wenn Systeme wie Azure API Management, KI-Agents oder API-Dokumentationstools Ihre OpenAPI-Spezifikation nutzen, verlassen sie sich auf klare Beschreibungen, um zu verstehen, was Ihre Funktionen tun.

Der OpenAPI-Generator extrahiert automatisch Informationen aus Ihren Funktionsdokumenten. Fügen Sie ihren Funktionen diese Eigenschaften hinzu, um eine umfassende API-Dokumentation zu erstellen:

  • Zusammenfassung – Eine zeilenbasierte Erklärung, die in API-Katalogen und Ansichten auf hoher Ebene angezeigt wird
  • Beschreibung – Detaillierte Erläuterung der Funktion, welche Eingaben sie erwartet und was sie zurückgibt

Beispielfunktion mit entsprechender Dokumentation:

@udf.function()
def hello_fabric(name: str) -> str:
    """
    Summary: A Python function that prints your name and the time.
    Description: This function takes a string input and concatenates it with the current time 
    to give you a warm welcome to User Data Functions. Returns a string and provides a log entry.
    """
    logging.info('Python UDF trigger function processed a request.')
    return f"Welcome to Fabric Functions, {name}, at {datetime.datetime.now()}!"

Wenn Sie die OpenAPI-Spezifikation generieren, füllen diese Docstring-Werte die summary und description Felder im OpenAPI-Schema auf, wodurch Entwickler und Systeme einfacher verstehen können, wie Sie Ihre Funktionen verwenden.

Allgemeine Verwendungen für generierten Code

Nachdem Sie Ihren Aufrufcode generiert haben, können Sie ihn verwenden, um Ihre Funktionen in verschiedene Szenarien zu integrieren:

Fabric-Artikel-Integrationen:

  • Aufrufen von Funktionen aus Notizbüchern für die Datenverarbeitung, maschinelles Lernen und explorative Analyse
  • Orchestrieren von Funktionen in Pipelines für Datentransformationsworkflows
  • Auslösen von Funktionen aus Aktivatorregeln als Reaktion auf Echtzeitereignisse

Integrationen externer Anwendungen:

  • Aufrufen von Funktionen aus Web-Apps, mobilen Apps oder Microservices mithilfe von Clientanwendungscode
  • Importieren von OpenAPI-Spezifikationen in Azure API Management oder andere API-Gateways für die zentrale Verwaltung
  • Generieren von Client-SDKs mithilfe des OpenAPI-Generators für eine konsistente Integration in mehrere Systeme
  • Konfigurieren von KI-Agents zum Ermitteln und Aufrufen Ihrer Funktionen mithilfe der OpenAPI-Spezifikation
  • Testen und Überprüfen von Funktionen mithilfe von Tools wie Postman oder Swagger UI

Verwandte Inhalte

  • Last updated on