Sdílet prostřednictvím

Správa a spouštění poznámkových bloků v prostředcích infrastruktury pomocí rozhraní API

  • Článek

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ůležité

Tato funkce je ve verzi Preview.

Díky rozhraním API pro poznámkové bloky můžou datoví inženýři a datoví vědci automatizovat vlastní kanály a pohodlně a efektivně navazovat 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.

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 najdete v tématu Položky – REST API.

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

Akce Popis
Spuštění úlohy položky na vyžádání Spusťte poznámkový blok s parametrizací.
Zrušit instanci úlohy položky Zrušte spuštění úlohy poznámkového bloku.
Získání instance úlohy položky Získání stavu spuštění poznámkového bloku

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

Poznámka:

Ověřování service principal je k dispozici pro rozhraní CRUD API poznámkového bloku a rozhraní API plánovače úloh, což znamená, že můžete použít service principal k provádění CRUD operací a spuštění nebo zrušení běhu poznámkového bloku a získání stavu běhu. Je potřeba přidat služební principal do pracovního prostoru s příslušnou rolí.

Příklady použití rozhraní REST API poznámkového bloku

Pomocí následujících pokynů otestujte příklady použití pro konkrétní veřejná rozhraní API poznámkového bloku a ověřte výsledky.

Poznámka:

Tyto scénáře se týkají pouze příkladů použití jedinečných poznámkových bloků. Tady nejsou popsané běžné příklady rozhraní API pro položky infrastruktury.

Požadavky

Rozhraní REST API fabric definuje jednotný koncový bod pro operace. Zástupné symboly {WORKSPACE_ID} a {ARTIFACT_ID} odpovídající hodnoty nahraďte, když budete postupovat podle příkladů v tomto článku.

Vytvoření poznámkového bloku s definicí

Vytvořte položku poznámkového bloku s existujícím souborem .ipynb a jiným typem zdrojových souborů.

Požádat

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

Datová část v požadavku je řetězec base64 převedený z následujícího ukázkového poznámkového bloku.

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

Výchozí jezero nebo připojené prostředí poznámkového bloku můžete změnit změnou obsahu metadata.trident.lakehouse poznámkového bloku nebo metadata.trident.environment.

Získání poznámkového bloku s definicí

Obsah poznámkového bloku získáte pomocí následujícího rozhraní API. Prostředky infrastruktury podporují nastavení formátu .ipynb v řetězci dotazu pro získání poznámkového bloku .ipynb.

Požádat

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

Response

Stavový kód: 200

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

Spuštění poznámkového bloku na vyžádání

Naplánujte spuštění poznámkového bloku pomocí následujícího rozhraní API. Úloha Sparku se spustí po úspěšném požadavku.

Prostředky infrastruktury podporují předávání parameters textu požadavku pro parametrizaci spuštění poznámkového bloku. Hodnoty jsou spotřebovány buňkou parametru poznámkového bloku.

Můžete také použít configuration k přizpůsobení relace Sparku běhu poznámkového bloku. configurationsdílí stejný kontrakt s příkazem magic konfigurace relace Sparku.

Požádat

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

Response

Stavový kó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

Pomocí locationpříkazu Získat instanci úlohy položky můžete zobrazit stav úlohy nebo zrušit spuštění aktuálního poznámkového bloku pomocí instance úlohy Zrušit položku.

Související obsah