Megosztás a következőn keresztül:

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

  • Cikk

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.

Fontos

Ez a funkció előzetes verzióban érhető el.

Feljegyzés

A szolgáltatásnév hitelesítése a Notebook CRUD API-hoz érhető el. A notebook API futtatása egyelőre nem támogatott.

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.

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 Futtassa a jegyzetfüzetet paraméterezéssel.
Elemfeladat-példány megszakítása A jegyzetfüzet-feladat futtatásának megszakítása.
Elemfeladat-példány lekérése A jegyzetfüzet futási állapotának lekérése.

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

Notebook REST API-használati példák

Az alábbi utasítások segítségével tesztelhet használati példákat adott jegyzetfüzet nyilvános API-jaihoz, és ellenőrizheti az eredményeket.

Feljegyzés

Ezek a forgatókönyvek csak a jegyzetfüzet-egyedi használati példákat fedik le. A hálóelemek gyakori API-példáit itt nem ismertetjük.

Előfeltételek

A Fabric Rest API egységes végpontot határoz meg a műveletekhez. Cserélje le a helyőrzőket {WORKSPACE_ID} és {ARTIFACT_ID} a megfelelő értékeket, amikor a cikkben szereplő példákat követi.

Jegyzetfüzet létrehozása definícióval

Jegyzetfüzetelem létrehozása meglévő .ipynb fájllal:

Kérelem

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/items

{
    "displayName":"Notebook1",
    "type":"Notebook",
    "definition" : {
        "format": "ipynb",
        "parts": [
            {
                "path": "artifact.content.ipynb",
                "payload": "eyJuYmZvcm1hdCI6NCwibmJmb3JtYXRfbWlub3IiOjUsImNlbGxzIjpbeyJjZWxsX3R5cGUiOiJjb2RlIiwic291cmNlIjpbIiMgV2VsY29tZSB0byB5b3VyIG5ldyBub3RlYm9va1xuIyBUeXBlIGhlcmUgaW4gdGhlIGNlbGwgZWRpdG9yIHRvIGFkZCBjb2RlIVxuIl0sImV4ZWN1dGlvbl9jb3VudCI6bnVsbCwib3V0cHV0cyI6W10sIm1ldGFkYXRhIjp7fX1dLCJtZXRhZGF0YSI6eyJsYW5ndWFnZV9pbmZvIjp7Im5hbWUiOiJweXRob24ifX19",
                "payloadType": "InlineBase64"
            }
        ]
    }
}

A kérelem hasznos adatai a következő mintajegyzetfüzetből konvertált base64 sztring.

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

Feljegyzés

A jegyzetfüzet alapértelmezett tóházát vagy csatolt környezetét a jegyzetfüzet tartalmának metadata.trident.lakehouse vagy metadata.trident.environmenta csatolt környezetnek a módosításával módosíthatja.

Jegyzetfüzet lekérése definícióval

A jegyzetfüzet tartalmának lekéréséhez használja az alábbi API-t. A Fabric támogatja, hogy .ipynb formátumban állítsa be a formátumot a lekérdezési sztringben egy .ipynb jegyzetfüzet lekéréséhez.

Kérelem

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

Válasz

Állapotkód: 200

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

Jegyzetfüzet futtatása igény szerint

Ütemezze a jegyzetfüzet futtatását az alábbi API-val. A Spark-feladat egy sikeres kérés után elkezdi a végrehajtást.

A Fabric támogatja a kérelem törzsének átadását parameters a jegyzetfüzet futtatásának paraméterezéséhez. Az értékeket a jegyzetfüzet paramétercellája használja fel.

A jegyzetfüzet-futtatás Spark-munkamenetének személyre szabására is használható configuration . configuration ugyanazt a szerződést osztja meg a Spark-munkamenet konfigurációs varázsló parancsával.

Kérelem

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

Válasz

Állapotkód: 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

Ezzel a lehetőséggel locationaz Elemfeladat-példány lekérése lehetőséggel megtekintheti a feladat állapotát, vagy a Mégse elemfeladat-példány használatával megszakíthatja az aktuális jegyzetfüzet-futtatásokat.

Kapcsolódó tartalom