Administrere og kjøre notatblokker i Fabric med API-er

Rest-API-en for Microsoft Fabric tilbyr et tjenesteendepunkt for opprettings-, lese-, oppdaterings- og sletteoperasjoner (CRUD) for et stoffelement. Denne artikkelen beskriver de tilgjengelige REST-API-ene for notatblokken og bruken deres.

Med API-ene for notatblokken kan dataingeniører og dataforskere automatisere sine egne datasamlebånd og enkelt og effektivt etablere CI/CD. Disse API-ene gjør det også enkelt for brukere å administrere og manipulere Fabric-notatblokkelementer, og integrere notatblokker med andre verktøy og systemer. Notatbøker kan orkestreres fra Fabric-pipelines og eksterne planleggere gjennom disse API-ene, noe som muliggjør sømløs integrasjon med automatiserte arbeidsflyter.

Disse handlingene for elementbehandling er tilgjengelige for notatblokker:

Handling Bekrivelse
Opprett element Oppretter en notatblokk i et arbeidsområde.
Oppdater element Oppdaterer metadataene for en notatblokk.
Oppdater elementdefinisjon Oppdaterer innholdet i en notatblokk.
Slett element Sletter en notatblokk.
Hent element Henter metadataene til en notatblokk.
Hent elementdefinisjon Henter innholdet i en notatblokk.
Listeelement Vis alle elementer i et arbeidsområde.

Hvis du vil ha mer informasjon, kan du se Elementer – REST-API.

Følgende handlinger for jobbplanlegging er tilgjengelige for notatblokker:

Handling Bekrivelse
Kjør ved behov elementjobb Kjør en notatbok på forespørsel med støtte for parameterisering, sesjonskonfigurasjon (som Spark/compute-innstillinger), valg av miljø og kjøretid, samt valg av Fabric Lakehouse.
Avbryt elementjobbforekomst Avbestill en notatbokjobb.
Hent forekomst av elementjobb Få notebook-kjørestatus og hent utgangsverdien som returneres av kjøringen.

Hvis du vil ha mer informasjon, kan du se Jobbplanlegging.

Merk

Service principal-autentisering støttes både for Items REST API (notebook CRUD-operasjoner) og Job Scheduler API (utførelse, overvåking og kansellering). Dette muliggjør sikker ubemannet automatisering og CI/CD-scenarier. Legg til tjenesteprinsippet i arbeidsområdet med en passende rolle (Administrator, Medlem eller Bidragsyter) for å administrere og kjøre notatbøker.

Utgangsverdier fra notatbokkjøringer

Notebook-kjøringer kjørt via Job Scheduler API kan returnere en exit-verdi som du kan bruke til betinget orkestrering. Utgangsverdien vises i exitValue feltet til Get Item Job Instance response payload.

En notatbok kan sette sin exit-verdi ved å kalle mssparkutils.notebook.exit("your-value") før kjøringen fullføres. Utgangsverdien er en streng og kan kode hvilket som helst utfallssignal—for eksempel "success", "no_rows_processed", eller et JSON-serialisert resultat.

Eksterne orkestratorer, Fabric-pipelines og andre automatiseringsverktøy kan kalle Get Item Job Instance etter at kjøringen er fullført for å lese exit-verdien og forgrene på resultater. Eksempel:

  1. Send inn en Run on Demand-varejobb med parametere og utførelsesinnstillinger.
  2. Poll Get Item Job Instance til status er Completed (eller Failed).
  3. Les exitValue fra svaret for å bestemme neste steg i arbeidsflyten din.

Dette mønsteret muliggjør betinget orkestrering og nedstrøms signalering basert på utskriftsutførelsesresultater.

Eksempel på ende-til-ende

Følgende eksempel viser hvordan man sender inn en notebook-kjøring og henter status og avslutningsverdi. For det komplette forespørselsskjemaet, inkludert parametere, sesjonskonfigurasjon og Lakehouse-valgfelt, se referansen Job Scheduler - Run on demand Item Job API .

Steg 1: Send inn en søknad

Bruk Run on Demand Item Job-endepunktet for å starte en notebook-kjøring:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{notebookId}/jobs/instances?jobType=RunNotebook

Svaret returnerer 202 Accepted med en Location header som inneholder URL-en til jobbinstansen du bruker for å overvåke kjøringen.

Trinn 2: Hente kjørestatus og avslutningsverdi

Bruk URL-en fra Location headeren for å sjekke status og les avslutningsverdien etter at kjøringen er fullført:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{notebookId}/jobs/instances/{jobInstanceId}

Eksempelsvar (forkortet):

{
  "id": "<jobInstanceId>",
  "itemId": "<notebookId>",
  "jobType": "RunNotebook",
  "invokeType": "OnDemand",
  "status": "Completed",
  "startTimeUtc": "2026-03-01T10:00:00Z",
  "endTimeUtc": "2026-03-01T10:05:00Z",
  "failureReason": null,
  "exitValue": "success"
}

Les exitValue for å avgjøre utfallet og forgren automatiseringslogikken din deretter.

  • Last updated on