Jaa

Hallitse ja suorita muistikirjoja Fabricissa ohjelmointirajapintojen avulla

  • Artikkeli

Microsoft Fabricin REST-ohjelmointirajapinta tarjoaa palvelupäätepisteen Fabric-kohteen (CRUD) luomiselle, lukemiselle, päivittämiselle ja poistamiselle. Tässä artikkelissa kuvataan käytettävissä olevat muistikirjan REST-ohjelmointirajapinnat ja niiden käyttö.

Tärkeä

Tämä ominaisuus on esikatselutilassa.

Muistiinpano

Palvelun päänimitodentaminen on käytettävissä Notebook CRUD -ohjelmointirajapinnalle. Sitä ei tueta suoritusmuistikirjan ohjelmointirajapinnassa toistaiseksi.

Muistikirjan ohjelmointirajapintojen avulla tietoteknikot ja tietotutkijat voivat automatisoida omat putket ja kätevästi ja tehokkaasti muodostaa CI/CD:n. Näiden ohjelmointirajapintojen avulla käyttäjät voivat myös hallita ja käsitellä Fabric-muistikirjakohteita sekä integroida muistikirjoja muihin työkaluihin ja järjestelmiin.

Nämä kohteiden hallintatoiminnot ovat käytettävissä muistikirjoissa:

Toimi Kuvaus
Luo kohde Luo muistikirjan työtilan sisälle.
Päivitä kohde Päivittää muistikirjan metatiedot.
Kohteen määrityksen päivittäminen Päivittää muistikirjan sisällön.
Poista kohde Poistaa muistikirjan.
Hae kohde Hakee muistikirjan metatiedot.
Hae kohteen määritys Hakee muistikirjan sisällön.
Luettelokohde Luettele kaikki työtilan kohteet.

Lisätietoja on artikkelissa Kohteet – REST-ohjelmointirajapinta.

Muistikirjoille on saatavilla seuraavat Työn ajoitus -toiminnot:

Toimi Kuvaus
Suorita pyydettäessä suoritettava kohdetyö Suorita muistikirja, jossa on parametrisointia.
Peruuta nimiketyön esiintymä Peruuta muistikirjatyön suorittaminen.
Hae kohdetyön esiintymä Hae muistikirjan suoritustila.

Lisätietoja on kohdassa Työn ajoitus.

Muistikirjan REST-ohjelmointirajapinnan käyttöesimerkkejä

Seuraavien ohjeiden avulla voit testata käyttöesimerkkejä tietyistä muistikirjan julkisista ohjelmointirajapinnoista ja tarkistaa tulokset.

Muistiinpano

Nämä skenaariot kattavat vain muistikirjassa ainutlaatuisia käyttöesimerkkejä. Fabric-kohteen yleisiä ohjelmointirajapintaesimerkkejä ei käsitellä tässä.

Edellytykset

Fabric Rest -ohjelmointirajapinta määrittää yhtenäisen päätepisteen toiminnoille. Korvaa paikkamerkit {WORKSPACE_ID} ja {ARTIFACT_ID} sopivilla arvoilla, kun seuraat tämän artikkelin esimerkkejä.

Luo muistikirja määrityksellä

Luo muistikirjakohde, jossa on olemassa oleva .ipynb-tiedosto, ja muita lähdetiedostotyyppejä.

Pyydä

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

Pyynnön tiedot ovat base64-merkkijono, joka on muunnettu seuraavasta näytemuistikirjasta.

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

Muistiinpano

Voit muuttaa muistikirjan oletusjärvitalon tai siihen liittyvän ympäristön muuttamalla muistikirjan sisältöä metadata.trident.lakehouse tai metadata.trident.environment.

Hanki muistikirja, jossa on määritelmä

Hae muistikirjan sisältö käyttämällä seuraavaa ohjelmointirajapintaa. Fabric tukee muotoa .ipynb kyselymerkkijonossa, jotta saat .ipynb-muistikirjan.

Pyydä

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

Response

Tilakoodi: 200

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

Suorita muistikirja pyynnöstä

Ajoita muistikirja suoritettavaksi käyttäen seuraavaa ohjelmointirajapintaa. Spark-työn suorittaminen alkaa onnistuneen pyynnön jälkeen.

Kangas tukee välittämistä parameters pyynnön runkoon muistikirjan suorituksen parametrisoimiseksi. Arvot kulutetaan muistikirjan parametrisolussa.

Voit myös configuration mukauttaa muistikirjan Spark-istuntoa. configurationjakaa saman sopimuksen Spark-istunnon määritysten taikakomennon kanssa.

Pyydä

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

Tilakoodi: 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

Kun käytät kohdetta , voit tarkastella työn tilaa Hae kohdetyön esiintymä -parametrilla locationtai peruuttaa nykyisen muistikirjatyön suorituksen Käyttämällä Peruuta kohdetyön esiintymä -funktiota.

Liittyvä sisältö