Notebooks beheren en uitvoeren in Fabric met API's

De MICROSOFT Fabric REST API biedt een service-eindpunt voor de CRUD-bewerkingen (Create, Read, Update en Delete) van een Fabric-item. In dit artikel worden de beschikbare REST API's voor notebooks en het bijbehorende gebruik beschreven.

Met de notebook-API's kunnen data engineers en gegevenswetenschappers hun eigen pijplijnen automatiseren en efficiënt en efficiënt CI/CD opzetten. Met deze API's kunnen gebruikers ook eenvoudig notebookitems van Fabric beheren en bewerken en notebooks integreren met andere hulpprogramma's en systemen. Notebooks kunnen worden ingedeeld vanuit Fabric-pijplijnen en externe planners via deze API's, waardoor naadloze integratie met geautomatiseerde werkstromen mogelijk is.

Deze itembeheeracties zijn beschikbaar voor notebooks:

Actie Beschrijving
Item maken Hiermee maakt u een notitieblok in een werkruimte.
Item bijwerken Hiermee worden de metagegevens van een notebook bijgewerkt.
Itemdefinitie bijwerken Hiermee werkt u de inhoud van een notitieblok bij.
Item verwijderen Verwijdert een notitieblok.
Item ophalen Haalt de metagegevens van een notebook op.
Itemdefinitie ophalen Hiermee haalt u de inhoud van een notitieblok op.
Lijstitem Alle items in een werkruimte weergeven.

Zie Items - REST API voor meer informatie.

De volgende taakplanneracties zijn beschikbaar voor notebooks:

Actie Beschrijving
Op aanvraag itemtaak uitvoeren Voer een notebook op aanvraag uit met ondersteuning voor parameterisatie, sessieconfiguratie (zoals Spark/compute-instellingen), omgevings- en runtimeselectie en doel-Fabric Lakehouse-selectie.
Itemtaakvoorbeeld annuleren Een uitvoering van een notebooktaak annuleren.
Exemplaar van itemtaak ophalen Haal de uitvoeringsstatus van het notebook op en ontvang de terugkeerwaarde die door de run wordt geretourneerd.

Zie Job Scheduler voor meer informatie.

Notitie

Verificatie van de service principal wordt ondersteund voor zowel de Items REST API (notebook CRUD-bewerkingen) als de Job Scheduler API (uitvoering, bewaking en annulering). Dit maakt veilige automatisering zonder toezicht en CI/CD-scenario's mogelijk. Voeg de service-principal toe aan de werkruimte met de juiste rol (Beheerder, Lid of Medewerker) om notebooks te beheren en uit te voeren.

Waarden van notebookuitvoeringen voor exitwaarden

Notebook-uitvoeringen via de Job Scheduler-API kunnen een afsluitwaarde retourneren die u kunt gebruiken voor voorwaardelijke orkestratie. De afsluitwaarde wordt weergegeven in het exitValue veld van de antwoordpayload van de Ophaalitemtaakinformatie.

Een notebook kan zijn uitgangswaarde instellen door mssparkutils.notebook.exit("your-value") aan te roepen voordat de uitvoering voltooid is. De afsluitwaarde is een tekenreeks en kan elk resultaatsignaal coderen, bijvoorbeeld "success", "no_rows_processed"of een JSON-geserialiseerd resultaat.

Externe orchestrators, Fabric-pipelines en andere automatiseringstools kunnen Itemtaakexemplaren ophalen aanroepen nadat de uitvoering is voltooid om de afsluitwaarde te lezen en vertakkingen op basis van uitkomsten te maken. Voorbeeld:

  1. Dien een Run on demand Item Job in met parameters en uitvoeringsinstellingen.
  2. Poll Get Item Job Instance totdat status is Completed (of Failed).
  3. Lees exitValue uit het antwoord om de volgende stap in uw werkstroom te bepalen.

Dit patroon maakt voorwaardelijke indeling en downstream signalering mogelijk op basis van resultaten van notebookuitvoering.

Allesomvattend voorbeeld

In het volgende voorbeeld wordt getoond hoe u een notebook-run verzendt en de status en afsluitwaarde ophaalt. Zie de Job Scheduler - Run on demand Item Job API-referentie voor het volledige schema van de request body, inclusief parameters, sessieconfiguratie en Lakehouse-selectievelden.

Stap 1: Een run indienen

Gebruik het taakeindpunt Uitvoeren op aanvraag om een notebookuitvoering te starten:

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

Het antwoord retourneert 202 Accepted met een Location-header die de URL van het taakexemplaar bevat dat u gebruikt om de uitvoering te controleren.

Stap 2: Uitvoeringsstatus en uitvoerwaarde ophalen

Gebruik de URL van de Location header om de status te controleren en de afsluitwaarde te lezen nadat de uitvoering is voltooid:

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

Voorbeeldantwoord (afgekort):

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

Lees exitValue om het resultaat te bepalen en vertak uw automatiseringslogica dienovereenkomstig.

  • Last updated on