Hantera och köra notebooks i Fabric med API:er

REST API:et för Microsoft Fabric tillhandahåller en tjänstslutpunkt för CRUD-åtgärder (Create, Read, Update och Delete) för ett Fabric-objekt. I den här artikeln beskrivs tillgängliga REST-API:er för notebook-filer och deras användning.

Med notebook-API:er kan datatekniker och dataforskare automatisera sina egna pipelines och enkelt och effektivt etablera CI/CD. Dessa API:er gör det också enkelt för användare att hantera och manipulera notebook-objekt i Fabric och integrera notebook-filer med andra verktyg och system. Notebook-filer kan orkestreras från Fabric-pipelines och externa schemaläggare via dessa API:er, vilket möjliggör sömlös integrering med automatiserade arbetsflöden.

Dessa åtgärder för objekthantering är tillgängliga för anteckningsböcker:

Åtgärd beskrivning
Skapa objekt Skapar en notebook i en arbetsyta.
Uppdatera objekt Uppdaterar metadatan för en anteckningsbok.
Uppdatera objektdefinition Uppdaterar innehållet i en notebook-fil.
Ta bort objekt Tar bort en notebook.
Hämta objekt Hämtar metadata för en digital anteckningsbok.
Hämta objektdefinition Hämtar innehållet i en notebook.
Listobjekt Visa en lista över alla objekt på en arbetsyta.

Mer information finns i Objekt – REST API.

Följande jobbschemaläggningsåtgärder är tillgängliga för notebook-filer:

Åtgärd beskrivning
Köra objektjobb på begäran Kör en notebook på begäran med stöd för parameterisering, sessionskonfiguration (till exempel Spark-/beräkningsinställningar), miljö- och körningsval samt urval av mål-Fabric Lakehouse.
Avbryt objektjobbinstans Avbryt en notebook-jobbkörning.
Hämta objektjobbinstans Hämta status för anteckningsbokskörning och hämta avslutsvärdet som körningen returnerar.

Mer information finns i Jobbschemaläggare.

Kommentar

Tjänstens huvudnamnsautentisering stöds för både ITEMS REST API (CRUD-åtgärder för notebook-filer) och Job Scheduler API (körning, övervakning och annullering). Detta möjliggör säker obevakad automatisering och CI/CD-scenarier. Lägg till tjänstens huvudnamn på arbetsytan med en lämplig roll (administratör, medlem eller deltagare) för att hantera och köra notebook-filer.

Utgångsvärden från anteckningsbokskörningar

Notebook-körningar som körs via Job Scheduler-API:et kan returnera ett avslutsvärde som du kan använda för villkorsstyrd orkestrering. Avslutsvärdet visas i fältet för exitValue svarsnyttolasten Hämta objektjobbinstans .

En notebook kan ange sitt slutvärde genom att anropa mssparkutils.notebook.exit("your-value") innan körningen är avslutad. Utgångsvärdet är en sträng och kan koda valfri utfallssignal, "success"till exempel , "no_rows_processed"eller ett JSON-serialiserat resultat.

Externa orkestratorer, fabric pipelines och andra automatiseringsverktyg kan anropa Hämta instans av objektjobb efter att körningen har slutförts för att läsa av utgångsvärdet och fatta beslut baserat på resultaten. Som exempel:

  1. Skicka ett objektjobb på begäran med parametrar och körningsinställningar.
  2. Avsök Hämta objektjobbinstans tills status den är Completed (eller Failed).
  3. Läs exitValue från svaret för att fastställa nästa steg i arbetsflödet.

Det här mönstret möjliggör villkorlig orkestrering och nedströmssignalering baserat på körningsresultat för notebook-filer.

Helomfattande exempel

I följande exempel visas hur du skickar en notebook-körning och hämtar dess status och slutvärde. För det fullständiga schemat för förfrågningskroppen, inklusive parametrar, sessionskonfiguration och Lakehouse-urvalsfält, se Job Scheduler - Kör vid behov Objektjobb API-referensen.

Steg 1: Skicka in en körning

Använd slutpunkten Kör på begäran-objektjobb för att starta en notebook-körning:

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

Svaret returneras 202 Accepted med en Location rubrik som innehåller URL:en för den jobbinstans som du använder för att övervaka körningen.

Steg 2: Hämta körningsstatus och slutvärde

Använd URL:en från Location rubriken för att kontrollera status och läsa avslutsvärdet när körningen är klar:

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

Exempelsvar (förkortat):

{
  "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"
}

Läs exitValue för att fastställa resultatet och förgrena automatiseringslogik i enlighet med detta.

  • Last updated on