Spravujte a spouštějte poznámkové bloky ve Fabric pomocí rozhraní API

Rozhraní MICROSOFT Fabric REST API poskytuje koncový bod služby pro operace vytvoření, čtení, aktualizace a odstranění (CRUD) položky Fabric. Tento článek popisuje dostupná rozhraní REST API poznámkového bloku a jejich použití.

Díky rozhraním API pro poznámkové bloky mohou datoví inženýři a datoví vědci automatizovat své vlastní kanály a pohodlně a efektivně zavést CI/CD. Tato rozhraní API také usnadňují uživatelům správu a manipulaci s položkami poznámkového bloku Fabric a integrují poznámkové bloky s dalšími nástroji a systémy. Notebooky je možné orchestrovat z datových kanálů Fabric a externích plánovačů prostřednictvím těchto rozhraní API, což umožňuje hladkou integraci s automatizovanými pracovními postupy.

Tyto akce správy položek jsou k dispozici pro poznámkové bloky:

Akce	Popis
Vytvořit položku	Vytvoří poznámkový blok v pracovním prostoru.
Aktualizovat položku	Aktualizuje metadata poznámkového bloku.
Aktualizace definice položky	Aktualizuje obsah poznámkového bloku.
Odstranit položku	Odstraní poznámkový blok.
Získat položku	Získá metadata poznámkového bloku.
Získání definice položky	Získá obsah poznámkového bloku.
Položka seznamu	Zobrazí seznam všech položek v pracovním prostoru.

Další informace viz Položky – REST API.

Pro poznámkové bloky jsou k dispozici následující akce plánovače úloh:

Akce	Popis
Spustit úlohu položky na vyžádání	Spouštějte notebook na vyžádání s podporou parametrizace, konfigurace relace (například nastavení Spark/comute), výběru prostředí a runtime a výběru cílového lakehouse.
Zrušit položku instance úlohy	Zrušte běh úlohy poznámkového bloku
Získání instance položky úlohy	Získejte stav spuštění notebooku a načtěte výstupní kód vrácený tímto spuštěním.

Další informace najdete v tématu Plánovač úloh.

Poznámka:

Ověřování principálu služby je podporováno pro obě rozhraní REST API položek (operace CRUD v poznámkovém bloku) i rozhraní API plánovače úloh (spouštění, monitorování a zrušení). To umožňuje zabezpečené bezobslužné automatizace a scénáře CI/CD. Přidejte Service Principal do pracovního prostoru s příslušnou rolí (Admin, Member, nebo Contributor) pro správu a spouštění technických poznámkových bloků.

Výstupní hodnoty ze spuštění poznámkového bloku

Spuštění notebooku prostřednictvím rozhraní API plánovače úloh může vrátit hodnotu ukončení, kterou lze použít k podmíněné orchestraci. Výstupní hodnota se zobrazí v exitValue poli datové části odpovědi Načíst instanci úlohy položky .

Notebook může nastavit svou hodnotu ukončení před dokončením spuštění. Výstupní hodnota je řetězec a může kódovat jakýkoli signál výsledku , "success"například , "no_rows_processed"nebo serializovaný výsledek JSON.

Externí orchestrátory, Fabric kanály a další nástroje pro automatizaci mohou po dokončení spuštění zavolat instanci úlohy Získat položku a přečíst výstupní hodnotu a větvit na základě výsledků. Například:

1. Odešlete úkol pro spuštění položky na vyžádání s parametry a nastavením spuštění.
2. Opakovaně dotazovat instanci úlohy na získání položky dokud status není Completed (neboFailed).
3. Přečtěte si exitValue z odpovědi a zjistěte další krok v pracovním postupu.

Tento vzor umožňuje podmíněnou orchestraci a následné signály založené na výsledcích provádění výpočetních poznámkových bloků.

Kompletní příklad

Následující příklad ukazuje, jak spustit poznámkový blok a zjistit jeho stav a výstupní hodnotu. Kompletní schéma struktury těla požadavku, včetně parametrů, konfigurace relace a polí pro výběr Lakehouse, najdete v referenční dokumentaci rozhraní API Plánovače úloh - Spustit úlohu na vyžádání.

Krok 1: Odeslání spuštění

K zahájení spuštění poznámkového bloku použijte koncový bod úlohy na vyžádání :

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

Krok 2: Načtení stavu spuštění a hodnoty ukončení

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

Příklad odpovědi (zkráceně):

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

Přečtěte si, exitValue abyste mohli odpovídajícím způsobem určit výsledek a rozvětvovat logiku automatizace.