Del via

Generer invokasjonskode for User Data Functions

Når du har publisert User Data Functions, kan du kalle dem fra Fabric-elementer eller eksterne applikasjoner. I stedet for å skrive invokasjonskoden fra bunnen av, bruk funksjonen Generate invocation code for automatisk å lage ferdige kodemaler.

Velg kodegenereringsalternativet basert på integrasjonsscenarioet ditt:

  • Fabric Notebooks-kode (Python) – For å kalle funksjoner fra Fabric Notebooks, som er en måte å integrere med Fabric-elementer på. For andre Fabric-elementer som Pipelines og Activator, se integrasjonsdokumentasjonen.
  • Klientapplikasjonskode (Python, C#, Node.js) – For å kalle funksjonene dine fra eksterne applikasjoner via det unike REST-endepunktet som hver funksjon eksponerer. Dette muliggjør integrasjon med webapplikasjoner, tjenester eller ethvert system utenfor Fabric.
  • OpenAPI-spesifikasjon (JSON, YAML) – For API-administrasjonsplattformer, AI-agenter eller genererende klient-SDK-er. Bruk dette til å integrere funksjonene dine med Azure API Management, konfigurere AI-systemer eller generere biblioteker for eksterne applikasjoner.

Forutsetning

Før du genererer invocation-kode, trenger du:

  • Et publisert User Data Functions-element med minst én funksjon
  • Tilgang til User Data Functions-elementet i Fabric-portalen
  • Minst Execute-tillatelse på User Data Functions-elementet for å generere og bruke invocation-kode

Generer kode for Fabric Notebooks

Når du integrerer med Fabric-elementer, bruk dette alternativet for å kalle funksjonene dine fra Fabric Notebooks. Den genererte koden bruker det innebygde mssparkutils.userDataFunction verktøyet, som gir en enkel måte å påkalle funksjoner uten å håndtere autentisering eller endepunkter. Dette er ideelt for databehandlingsarbeidsflyter, utforskende analyser og maskinlæringspipelines i Fabric-miljøet.

  1. Åpne User Data Functions-elementet ditt i Fabric-portalen.

  2. På fanen Hjem , velg Generer invocation code>Client-kode.

  3. Under Invoke from velger du Notebook fra nedtrekksmenyen.

  4. Velg funksjonsnavnet du vil aktivere.

  5. Koden genereres automatisk i Python. (Python er det eneste språket tilgjengelig for notatbok-invokasjon.)

    Skjermbilde som viser den genererte aktiveringskoden for notatblokker.

  6. Kopier den genererte kodebiten.

  7. Lim det inn i en ny celle i Fabric Notebook din.

  8. Oppdater funksjonsparametrene med dine faktiske verdier. Den genererte koden inkluderer en kommentar som viser hvor man skal oppdateres:

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

  9. Kjør cellen for å aktivere funksjonen din.

For mer informasjon, se Fabric Notebook User Data Functions-verktøy.

Generer kode for klientapplikasjoner

Når du integrerer med eksterne applikasjoner, bruk dette alternativet for å kalle funksjonene dine via det unike REST-endepunktet som hver funksjon eksponerer. Den genererte koden inkluderer autentiseringsoppsett ved bruk av Microsoft Entra ID og håndterer HTTP-forespørsels-/svarflyten. Dette gjør det mulig å kalle Fabric-funksjonene dine fra webapper, mobilapper, mikrotjenester eller ethvert system utenfor Fabric-miljøet.

  1. Åpne User Data Functions-elementet ditt i Fabric-portalen.

  2. På fanen Hjem , velg Generer invocation code>Client-kode.

  3. Under Påkall fra, velg klientapplikasjon fra nedtrekksmenyen.

  4. Velg funksjonsnavnet du vil aktivere.

  5. Velg ditt programmeringsspråk:

    • Python
    • C#
    • Node.js

    Skjermbilde som viser klientkodeutdataene.

  6. Kopier den genererte koden og legg den til i applikasjonen din.

  7. Gå gjennom kodestrukturen:

    • Autentisasjon – Brukes InteractiveBrowserCredential til å skaffe en token (kun for utvikling/testing)
    • Endepunkt-URL – Det unike REST-endepunktet for din spesifikke funksjon
    • Forespørselskropp – Inneholder inputparametrene funksjonen din forventer

  8. Oppdater seksjonen request_body med dine faktiske parameterverdier. Den genererte koden inkluderer en kommentar som viser hvor man skal oppdateres:

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

  9. For produksjonsapplikasjoner, erstatt autentiseringskoden med korrekt Microsoft Entra ID-applikasjonsregistrering. Den genererte koden inkluderer en advarsel og lenke til veiledning for produksjonsautentisering.

For en komplett gjennomgang inkludert oppsett av produksjonsautentisering, se Kall User Data Functions fra en Python-applikasjon.

Generer OpenAPI-spesifikasjon

Når du trenger å integrere funksjonene dine med API-administrasjonsplattformer, AI-agenter eller generere klient-SDK-er for eksterne applikasjoner, bruk dette alternativet for å lage en OpenAPI-spesifikasjon. OpenAPI-spesifikasjonen gir en maskinlesbar beskrivelse av funksjonens REST-endepunkter, noe som gjør det enkelt for verktøy og systemer å oppdage og integrere med funksjonene dine programmessig.

  1. Åpne User Data Functions-elementet ditt i Fabric-portalen.

  2. På Hjem-fanen velger du Generer invocation-kode>OpenAPI-spesifikasjon.

  3. I dialogen Generer OpenAPI-spesifikasjonen , velg ditt utdataformat:

    • JSON
    • YAML

    Skjermbilde som viser OpenAPI-spesifikasjonen.

  4. Kopier den genererte spesifikasjonen. Spesifikasjonen inkluderer:

    • Alle publiserte funksjoner i User Data Functions-elementet
    • Forespørsels- og svarskjemaer for hver funksjon
    • Autentiseringskrav (bærertoken)
    • Standard HTTP-feilsvar (400, 401, 403, 408, 413, 500)
    • Funksjonssammendrag og beskrivelser (fra docstrings)

Forbedre OpenAPI-utdataene med docstrings

Kvaliteten på OpenAPI-spesifikasjonen din avhenger av dokumentasjonen i funksjonskoden din. Når systemer som Azure API Management, AI-agenter eller API-dokumentasjonsverktøy bruker OpenAPI-spesifikasjonen din, er de avhengige av klare beskrivelser for å forstå hva funksjonene dine gjør.

OpenAPI-generatoren henter automatisk ut informasjon fra funksjonsdokumentstrengene dine. Legg til disse egenskapene i funksjonene dine for å lage omfattende API-dokumentasjon:

  • Sammendrag – Énlinjeforklaring som vises i API-kataloger og høynivåvisninger
  • Beskrivelse - Detaljert forklaring på hva funksjonen gjør, hvilke input den forventer, og hva den returnerer

Eksempelfunksjon med riktig dokumentasjon:

@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()}!"

Når du genererer OpenAPI-spesifikasjonen, fyller summary disse docstring-verdiene ut og-feltene description i OpenAPI-skjemaet, noe som gjør det enklere for utviklere og systemer å forstå hvordan de skal bruke funksjonene dine.

Vanlige bruksområder for generert kode

Når du har generert invokasjonskoden din, kan du bruke den til å integrere funksjonene dine i ulike scenarioer:

Integrasjoner av tekstilprodukter:

  • Kallefunksjoner fra Notebooks for databehandling, maskinlæring og utforskende analyse
  • Orkestrere funksjoner i Pipelines for datatransformasjonsarbeidsflyter
  • Triggerfunksjoner fra Aktivator-regler som respons på sanntidshendelser

Eksterne applikasjonsintegrasjoner:

  • Kall funksjoner fra webapper, mobilapper eller mikrotjenester ved bruk av klientapplikasjonskode
  • Importer OpenAPI-spesifikasjoner til Azure API Management eller andre API-gatewayer for sentralisert administrasjon
  • Generer klient-SDK-er ved hjelp av OpenAPI Generator for konsistent integrasjon på tvers av flere systemer
  • Konfigurer AI-agenter til å oppdage og kalle funksjonene dine ved hjelp av OpenAPI-spesifikasjonen
  • Test og valider funksjoner ved hjelp av verktøy som Postman eller Swagger UI

Relatert innhold

  • Last updated on