Zdieľať cez

Spravovanie a spúšťanie poznámkových blokov v službe Fabric s rozhraniami API

  • Článok

Rozhranie Microsoft Fabric REST API poskytuje koncový bod služby na vytváranie, čítanie, aktualizáciu a odstraňovanie operácií položky služby Fabric. Tento článok popisuje dostupné rozhrania REST API poznámkového bloku a ich používanie.

Dôležité

Táto funkcia je vo verzii Preview.

Pomocou notebookových rozhraní API môžu dátoví inžinieri a dátoví vedci automatizovať svoje vlastné kanály a pohodlne a efektívne vytvárať CI/CD. Tieto rozhrania API tiež uľahčujú používateľom správu a manipuláciu s poznámkovými položkami služby Fabric a integráciu poznámkových blokov s inými nástrojmi a systémami.

Pre poznámkové bloky sú k dispozícii tieto akcie správy položiek:

Akcia Description
Vytvoriť položku Vytvorí poznámkový blok v pracovnom priestore.
Aktualizovať položku Aktualizuje metaúdaje poznámkového bloku.
Aktualizácia definície položky Aktualizuje obsah poznámkového bloku.
Odstrániť položku Odstráni poznámkový blok.
Získať položku Načíta metaúdaje poznámkového bloku.
Načítanie definície položky Načíta obsah poznámkového bloku.
List item (Položka zoznamu) Zobrazenie zoznamu všetkých položiek v pracovnom priestore.

Ďalšie informácie nájdete v téme Položky – REST API.

Pre poznámkové bloky sú k dispozícii tieto akcie plánovača úloh:

Akcia Description
Spustenie úlohy položky na požiadanie Spustite poznámkový blok s parametrizáciou.
Zrušenie inštancie úlohy položky Zrušiť spustenie úlohy notebooku.
Získať inštanciu úlohy položky Získať stav spustenia notebooku.

Ďalšie informácie nájdete v téme Plánovač úloh.

Poznámka

Overovanie objektom služby je k dispozícii pre rozhranie API Notebook CRUD a plánovač úloh, čo znamená, že môžete použiť objekt služby na vykonanie operácií CRUD a spúšťanie/zrušenie spustení poznámkového bloku a získať stav spustenia. Objekt služby musíte pridať do pracovného priestoru s príslušnou rolou.

Príklady používania rozhrania REST API v notebooku

Nasledujúce pokyny môžete použiť na otestovanie príkladov používania konkrétnych verejných rozhraní API poznámkového bloku a overenie výsledkov.

Poznámka

Tieto scenáre sa vzťahujú len na príklady používania, ktoré sú jedinečné pre poznámkové bloky. Nie sú tu zahrnuté bežné príklady API položiek tkaniny.

Požiadavky

Rozhranie Rest API služby Fabric definuje jednotný koncový bod pre operácie. Ak budete postupovať podľa príkladov v tomto článku, nahraďte zástupné symboly {WORKSPACE_ID} a {ARTIFACT_ID} príslušnými hodnotami.

Vytvorenie poznámkového bloku s definíciou

Vytvorte poznámkový blok s existujúcim súborom .ipynb a iným typom zdrojových súborov.

Požiadavka

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/items
 
{
    "displayName":"Notebook1",
    "type":"Notebook",
    "definition" : {
        "format": "ipynb", // Use "fabricGitSource" for source file format.
        "parts": [
            {
                "path": "notebook-content.ipynb", // fabric source file format, .py, .scala, .sql files are supported.
                "payload": "eyJuYmZvcm1hdCI6NCwibmJmb3JtYXRfbWlub3IiOjUsImNlbGxzIjpbeyJjZWxsX3R5cGUiOiJjb2RlIiwic291cmNlIjpbIiMgV2VsY29tZSB0byB5b3VyIG5ldyBub3RlYm9va1xuIyBUeXBlIGhlcmUgaW4gdGhlIGNlbGwgZWRpdG9yIHRvIGFkZCBjb2RlIVxuIl0sImV4ZWN1dGlvbl9jb3VudCI6bnVsbCwib3V0cHV0cyI6W10sIm1ldGFkYXRhIjp7fX1dLCJtZXRhZGF0YSI6eyJsYW5ndWFnZV9pbmZvIjp7Im5hbWUiOiJweXRob24ifX19",
                "payloadType": "InlineBase64"
            }
        ]
    }
}

Údajová časť v požiadavke je reťazec base64 skonvertovaný z nasledujúceho poznámkového bloku ukážky.

{
    "nbformat": 4,
    "nbformat_minor": 5,
    "cells": [
        {
            "cell_type": "code",
            "source": [
                "# Welcome to your new notebook\n# Type here in the cell editor to add code!\n"
            ],
            "execution_count": null,
            "outputs": [],
            "metadata": {}
        }
    ],
    "metadata": {
        "language_info": {
            "name": "python"
        },
        "dependencies": {
            "environment": {
                "environmentId": "6524967a-18dc-44ae-86d1-0ec903e7ca05",
                "workspaceId": "c31eddd2-26e6-4aa3-9abb-c223d3017004"
            },
            "lakehouse": {
                "default_lakehouse": "5b7cb89a-81fa-4d8f-87c9-3c5b30083bee",
                "default_lakehouse_name": "lakehouse_name",
                "default_lakehouse_workspace_id": "c31eddd2-26e6-4aa3-9abb-c223d3017004"
            }
        }
    }
}

Poznámka

Poznámkový blok predvolený lakehouse alebo pripojené prostredie môžete zmeniť zmenou obsahu metadata.trident.lakehouse poznámkového bloku alebo metadata.trident.environment.

Načítanie poznámkového bloku s definíciou

Na načítanie obsahu poznámkového bloku použite nasledujúce rozhranie API. Fabric podporuje nastavenie formátu ako .ipynb v reťazci dotazu na získanie poznámkového bloku .ipynb.

Požiadavka

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/items/{{ARTIFACT_ID}}/GetDefinition?format=ipynb

Odpoveď

Kód stavu: 200

{
    "definition": {
        "parts": [
            {
                "path": "notebook-content.ipynb",
                "payload": "eyJuYmZvcm1hdCI6NCwibmJmb3JtYXRfbWlub3IiOjUsImNlbGxzIjpbeyJjZWxsX3R5cGUiOiJjb2RlIiwic291cmNlIjpbIiMgV2VsY29tZSB0byB5b3VyIG5ldyBub3RlYm9va1xuIyBUeXBlIGhlcmUgaW4gdGhlIGNlbGwgZWRpdG9yIHRvIGFkZCBjb2RlIVxuIl0sImV4ZWN1dGlvbl9jb3VudCI6bnVsbCwib3V0cHV0cyI6W10sIm1ldGFkYXRhIjp7fX1dLCJtZXRhZGF0YSI6eyJsYW5ndWFnZV9pbmZvIjp7Im5hbWUiOiJweXRob24ifX19",
                "payloadType": "InlineBase64"
            }
        ]
    }
}

Spustenie notebooku na požiadanie

Naplánujte spustenie poznámkového bloku pomocou nasledujúceho rozhrania API. Úloha Spark sa začne vykonávať po úspešnej žiadosti.

Fabric podporuje odovzdávanie parameters v tele požiadavky na parametrizáciu spustenia poznámkového bloku. Hodnoty sú spotrebované bunkou parametra poznámkového bloku.

Môžete tiež použiť configuration na prispôsobenie relácie spark notebooku. configuration zdieľa rovnakú zmluvu s Spark relácie magický príkaz.

Požiadavka

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

{
    "executionData": {
        "parameters": {
            "parameterName": {
                "value": "new value",
                "type": "string"
            }
        },
        "configuration": {
            "conf": {
                "spark.conf1": "value"
            },
            "environment": {
                "id": "<environment_id>",
                "name": "<environment_name>"
            },
            "defaultLakehouse": {
                "name": "<lakehouse-name>",
                "id": "<lakehouse-id>",
                "workspaceId": "<(optional) workspace-id-that-contains-the-lakehouse>"
            },
            "useStarterPool": false,
            "useWorkspacePool": "<workspace-pool-name>"
        }
    }
}

Odpoveď

Kód stavu: 202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Pomocou locationfunkcie môžete použiť funkciu Načítať inštanciu úlohy položky na zobrazenie stavu úlohy alebo použiť funkciu Zrušiť inštanciu úlohy položky na zrušenie aktuálneho spustenia poznámkového bloku.

Súvisiaci obsah