Hallitse ja suorita muistikirjoja Fabricissa ohjelmointirajapintojen avulla

Microsoft Fabricin REST-ohjelmointirajapinta tarjoaa palvelupäätepisteen Fabric-kohteen (CRUD) luomiselle, lukemiselle, päivittämiselle ja poistamiselle. Tässä artikkelissa kuvataan käytettävissä olevat muistikirjan REST-ohjelmointirajapinnat ja niiden käyttö.

Muistikirjan ohjelmointirajapintojen avulla tietoteknikot ja tietotutkijat voivat automatisoida omat putket ja kätevästi ja tehokkaasti muodostaa CI/CD:n. Näiden ohjelmointirajapintojen avulla käyttäjät voivat myös hallita ja käsitellä Fabric-muistikirjakohteita sekä integroida muistikirjoja muihin työkaluihin ja järjestelmiin. Muistikirjoja voidaan orkestroida Fabric-putkista ja ulkoisista ajastimista näiden API-rajapintojen kautta, mikä mahdollistaa saumattoman integraation automatisoituihin työnkulkuihin.

Nämä kohteiden hallintatoiminnot ovat käytettävissä muistikirjoissa:

Toimi Kuvaus
Luo kohde Luo muistikirjan työtilan sisälle.
Päivitä kohde Päivittää muistikirjan metatiedot.
Kohteen määrityksen päivittäminen Päivittää muistikirjan sisällön.
Poista kohde Poistaa muistikirjan.
Hae kohde Hakee muistikirjan metatiedot.
Hae kohteen määritys Hakee muistikirjan sisällön.
Luettelokohde Luettele kaikki työtilan kohteet.

Lisätietoja on artikkelissa Kohteet – REST-ohjelmointirajapinta.

Muistikirjoille on saatavilla seuraavat Työn ajoitus -toiminnot:

Toimi Kuvaus
Suorita pyydettäessä suoritettava kohdetyö Aja muistikirja tarpeen mukaan, joka tukee parametrisointia, istuntoasetuksia (kuten Spark/laskenta-asetuksia), ympäristön ja ajonaikaisen valinnan sekä kohteen Fabric Lakehouse -valintaa.
Peruuta nimiketyön esiintymä Peruuta muistikirjan työn suoritus.
Hae kohdetyön esiintymä Hae muistikirjan suoritustila ja hae suorituksen palauttama exit-arvo.

Lisätietoja on kohdassa Työn ajoitus.

Muistiinpano

Palvelupään todennus on tuettu sekä Items REST API:lle (notebook CRUD -toiminnot) että Job Scheduler API:lle (suoritus, valvonta ja peruutus). Tämä mahdollistaa turvalliset valvomattomat automaatio- ja CI/CD-skenaariot. Lisää palvelupäähenkilö työtilaan sopivalla roolilla (ylläpitäjä, jäsen tai avustaja) muistikirjojen hallintaan ja suorittamiseen.

Exit-arvot muistikirjan suorituksista

Notebook-suoritukset, jotka suoritetaan Job Scheduler API:n kautta, voivat palauttaa exit-arvon, jota voit käyttää ehdolliseen orkestrointiin. Exit-arvo näkyy exitValue Get Item Job Instance -vastekuorman kentässä.

Muistikirja voi asettaa poistumisarvonsa kutsumalla mssparkutils.notebook.exit("your-value") ennen suorituksen päättymistä. Exit-arvo on merkkijono, joka voi koodata minkä tahansa tulossignaalin—esimerkiksi "success", "no_rows_processed", tai JSON-sarjoitetun tuloksen.

Ulkoiset orkestroijat, Fabric-putket ja muut automaatiotyökalut voivat kutsua Get Item Job Instance -toimintoa suorituksen jälkeen lukeakseen exit-arvon ja haarautuakseen tuloksista. Esimerkkejä:

  1. Lähetä Run on demand -tehtävä parametreineen ja suoritusasetuksineen.
  2. Kysely Hanki Item Job Instance , kunnes status on Completed (tai Failed).
  3. Lue exitValue vastauksesta määrittääksesi seuraavan vaiheen työnkulussasi.

Tämä malli mahdollistaa ehdollisen orkestroinnin ja jälkivirran signaloinnin muistikirjan suoritustulosten perusteella.

Esimerkki koko lopusta

Seuraava esimerkki näyttää, miten lähetetään muistikirjan suoritus ja haetaan sen tila sekä poistumisarvo. Täydellisen pyyntörunkoskeeman, mukaan lukien parametrit, istuntokonfiguraatiot ja Lakehouse-valintakentät, löydät Job Scheduler - Run on demand Item Job API -viittauksesta.

Vaihe 1: Lähetä juoksu

Käytä Run on demand Item Job -päätepistettä aloittaaksesi muistikirjan suorituksen:

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

Vastaus palautuu 202 Accepted otsikolla Location , joka sisältää sen työinstanssin URL-osoitteen, jota käytät suorituksen seuraamiseen.

Vaihe 2: Hae suoritustila ja exit-arvo

Käytä otsikon URL-osoitetta Location tarkistaaksesi tilan ja lue exit-arvon suorituksen jälkeen:

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

Esimerkkivastaus (lyhennetty):

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

Lue exitValue selvittääksesi lopputuloksen ja haarautataksesi automaatiologiikkasi sen mukaisesti.

  • Last updated on