Jegyzetfüzetek kezelése és végrehajtása a Fabricben API-kkal

A Microsoft Fabric REST API szolgáltatásvégpontot biztosít egy Fabric-elem létrehozási, olvasási, frissítési és törlési (CRUD) műveleteihez. Ez a cikk az elérhető notebook REST API-kat és azok használatát ismerteti.

A notebook API-k segítségével az adatmérnökök és az adattudósok automatizálhatják saját folyamataikat, és kényelmesen és hatékonyan hozhatják létre a CI/CD-t. Ezek az API-k megkönnyítik a felhasználók számára a Fabric-jegyzetfüzetelemek kezelését és kezelését, valamint a jegyzetfüzetek más eszközökkel és rendszerekkel való integrálását. A jegyzetfüzetek a Fabric-folyamatokból és külső ütemezőkből vezénylhetők ezen API-k használatával, így zökkenőmentes integrációt tesz lehetővé az automatizált munkafolyamatokkal.

Ezek az elemkezelési műveletek a jegyzetfüzetekhez érhetők el:

Művelet Leírás
Elem létrehozása Létrehoz egy jegyzetfüzetet egy munkaterületen belül.
Elem frissítése Frissíti a jegyzetfüzet metaadatait.
Elemdefiníció frissítése Frissíti a jegyzetfüzet tartalmát.
Elem törlése Jegyzetfüzet törlése.
Elem lekérése Lekéri egy jegyzetfüzet metaadatait.
Elemdefiníció lekérése Lekéri a jegyzetfüzet tartalmát.
Listaelem A munkaterület összes elemének listázása.

További információ: Items – REST API.

A jegyzetfüzetekhez a következő feladatütemező-műveletek érhetők el:

Művelet Leírás
Igény szerinti elemfeladat futtatása Igény szerinti jegyzetfüzet-futtatás támogatása paraméterezéssel, munkamenet-konfigurációval (például Spark/számítási beállításokkal), környezet és futási környezet kiválasztásával, valamint a Fabric Lakehouse célállomásának kiválasztásával.
Elemfeladat-példány megszakítása Jegyzetfüzet-feladat futtatásának megszakítása.
Elemfeladat-példány lekérése Kérje le a jegyzetfüzet futási állapotát, és kérje le a futtatás által visszaadott kilépési értéket.

További információ: Feladatütemező.

Megjegyzés

A szolgáltatásnév hitelesítése az Items REST API (notebook CRUD-műveletek) és a Feladatütemező API (végrehajtás, monitorozás és lemondás) esetében is támogatott. Ez biztonságos felügyelet nélküli automatizálást és CI/CD-forgatókönyveket tesz lehetővé. Adja hozzá a szolgáltatásnevet a munkaterülethez megfelelő szerepkörrel (rendszergazda, tag vagy közreműködő) a jegyzetfüzetek kezeléséhez és végrehajtásához.

Kilépési értékek jegyzetfüzet futtatások eredményeiből

A Feladatütemező API-val végrehajtott notebook futtatások feltételes folyamatirányításhoz használható kilépési értéket adhatnak vissza. A kilépési érték az exitValueElemfeladat-példány lekérése válasz hasznos adat mezőjében jelenik meg.

Egy jegyzetfüzet a futtatás befejezése előtt a mssparkutils.notebook.exit("your-value") hívásával beállíthatja a kilépési értéket. A kilépési érték egy sztring, amely bármilyen eredményjelet képes kódolni , "success""no_rows_processed"például JSON-szerializált eredményt.

A külső vezénylők, Fabric csővezetékek és más automatizálási eszközök meghívhatják az Elem-feladatpéldány lekérése műveletet a futtatás befejezése után, hogy beolvassák a kilépési értéket és az eredmények alapján ágazhatnak el. Például:

  1. Igény szerinti futtatási feladat benyújtása paraméterekkel és végrehajtási beállításokkal.
  2. Poll Elem Feladatpéldány Lekérdezése addig, amíg status vagy Completed (vagy Failed) nem lesz.
  3. Olvassa el exitValue a válaszból a munkafolyamat következő lépésének meghatározásához.

Ez a minta lehetővé teszi a feltételes vezénylést és az alsóbb rétegbeli jelzéseket a jegyzetfüzetek végrehajtási eredményei alapján.

Teljes körű példa

Az alábbi példa bemutatja, hogyan küldhet be egy jegyzetfüzetet, és hogyan kérdezheti le annak állapotát és kilépési értékét. A teljes kérés törzs sémája, beleértve a paramétereket, a munkamenet konfigurációját és a Lakehouse kiválasztási mezőket, lásd a Feladatütemező – Igény szerinti futtatás elemfeladat API referencia.

1. lépés: Futtatás elküldése

Az igény szerinti futtatás elemfeladat-végpont használatával indítsa el a jegyzetfüzet futtatását:

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

2. lépés: A futtatási állapot és a kilépési érték lekérése

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/jobs/execute/instances/{jobInstanceId}?beta=true

Példa válasz (rövidítve):

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

Olvassa el exitValue az eredmény meghatározásához, és ennek megfelelően ágaztasd el az automatizálási logikát.

  • Last updated on