Administrer og udfør notesbøger i Fabric med API'er

Microsoft Fabric REST API indeholder et tjenesteslutpunkt for oprettelse, læsning, opdatering og sletning (CRUD) af et Fabric-element. I denne artikel beskrives de tilgængelige REST API'er for notesbogen og deres brug.

Med notebook-API'erne kan datateknikere og dataspecialister automatisere deres egne pipelines og nemt og effektivt etablere CI/CD. Disse API'er gør det også nemt for brugerne at administrere og manipulere Fabric-notesbogelementer og integrere notesbøger med andre værktøjer og systemer. Notebooks kan orkestreres fra Fabric-pipelines og eksterne planlæggere via disse API'er, hvilket muliggør problemfri integration med automatiserede workflows.

Disse handlinger til administration af elementer er tilgængelige for notesbøger:

Handling Beskrivelse
Opret element Opretter en notesbog i et arbejdsområde.
Opdater element Opdaterer metadataene for en notesbog.
Opdater elementdefinition Opdaterer indholdet af en notesbog.
Slet element Sletter en notesbog.
Hent element Henter metadataene for en notesbog.
Hent elementdefinition Henter indholdet af en notesbog.
Listeelement Vis alle elementer i et arbejdsområde.

Du kan få flere oplysninger under Elementer – REST API.

Følgende jobstyringshandlinger er tilgængelige for notesbøger:

Handling Beskrivelse
Kør varejob efter behov Kør en notebook on demand med understøttelse af parameterisering, sessionskonfiguration (såsom Spark/compute-indstillinger), valg af miljø og runtime samt målrettet Fabric Lakehouse-valg.
Annuller forekomst af elementjob Aflys et notebook-job-run.
Hent elementjobforekomst Få notebook run-status og hent exit-værdien, som køringen returnerer.

Du kan få flere oplysninger under Jobstyring.

Bemærk

Service principal-autentificering understøttes både for Items REST API'en (notebook CRUD-operationer) og Job Scheduler API'en (eksekvering, overvågning og annullering). Dette muliggør sikker ubemandet automatisering og CI/CD-scenarier. Tilføj serviceprincipalen til arbejdsområdet med en passende rolle (Admin, Medlem eller Bidragyder) til at administrere og eksekvere notebooks.

Exit-værdier fra notebook-kørsler

Notebook-kørsler, der kører via Job Scheduler API, kan returnere en exit-værdi, som du kan bruge til betinget orkestrering. Exit-værdien vises i exitValue feltet for Get Item Job Instance responspayloaden.

En notebook kan indstille sin exit-værdi ved at kalde mssparkutils.notebook.exit("your-value") , før kørslen er færdig. Exit-værdien er en streng og kan kode ethvert resultatsignal – for eksempel "success", "no_rows_processed", eller et JSON-serialiseret resultat.

Eksterne orkestratorer, Fabric-pipelines og andre automatiseringsværktøjer kan kalde Get Item Job Instance efter kørslen er afsluttet for at læse exit-værdien og forgrene på outcomes. Eksempel:

  1. Indsend et Run on Demand-produktjob med parametre og eksekveringsindstillinger.
  2. Poll Get Item Job Instance indtil status er Completed (eller Failed).
  3. Læs exitValue fra svaret for at bestemme næste skridt i din arbejdsgang.

Dette mønster muliggør betinget orkestrering og downstream-signalering baseret på notebookens eksekveringsresultater.

Eksempel fra ende til anden

Følgende eksempel viser, hvordan man kører en notesbog og henter dens status og afslutningsværdi. For det komplette anmodningsskema, inklusive parametre, sessionskonfiguration og Lakehouse-udvælgelsesfelter, se Job Scheduler - Run on demand Item Job API-referencen.

Trin 1: Indsend et løb

Brug Run on demand Item Job-endpointet til at starte en notebook-kørsel:

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

Svaret returnerer 202 Accepted med en Location header, der indeholder URL'en til den jobinstans, du bruger til at overvåge kørslen.

Trin 2: Hent kørselsstatus og afsluttelsesværdi

Brug URL'en fra Location headeren til at tjekke status og læs exit-værdien efter kørslen er afsluttet:

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

Eksempel på svar (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"
}

Læs exitValue for at bestemme resultatet og forgren din automatiseringslogik derefter.

  • Last updated on