Κοινή χρήση μέσω

Διαχείριση και εκτέλεση σημειωματάριων στο Fabric με API

  • Άρθρο

Το API REST του Microsoft Fabric παρέχει ένα τελικό σημείο υπηρεσίας για τις λειτουργίες δημιουργίας, ανάγνωσης, ενημέρωσης και διαγραφής (CRUD) ενός στοιχείου Fabric. Αυτό το άρθρο περιγράφει τα διαθέσιμα API REST σημειωματάριου και τη χρήση τους.

Σημαντικό

Αυτή η δυνατότητα είναι σε προεπισκόπηση.

Σημείωμα

Ο έλεγχος ταυτότητας κύριας υπηρεσίας είναι διαθέσιμος για το API Notebook CRUD. Προς το παρόν, δεν υποστηρίζεται για την εκτέλεση του API σημειωματάριου.

Με τα API σημειωματάριου, οι μηχανικοί δεδομένων και οι επιστήμονες δεδομένων μπορούν να αυτοματοποιήσουν τις δικές τους διοχετεύσεις και να δημιουργήσουν εύκολα και αποτελεσματικά CI/CD. Αυτά τα API διευκολύνουν επίσης τους χρήστες να διαχειρίζονται και να χειρίζονται στοιχεία σημειωματάριου Fabric και ενσωματώνουν σημειωματάρια με άλλα εργαλεία και συστήματα.

Αυτές οι ενέργειες διαχείρισης στοιχείων είναι διαθέσιμες για σημειωματάρια:

Ενέργεια Περιγραφή
Δημιουργία στοιχείου Δημιουργεί ένα σημειωματάριο μέσα σε έναν χώρο εργασίας.
Ενημέρωση στοιχείου Ενημερώνει τα μετα-δεδομένα ενός σημειωματάριου.
Ενημέρωση ορισμού στοιχείου Ενημερώνει το περιεχόμενο ενός σημειωματάριου.
Διαγραφή στοιχείου Διαγράφει ένα σημειωματάριο.
Λήψη στοιχείου Λαμβάνει τα μετα-δεδομένα ενός σημειωματάριου.
Λήψη ορισμού στοιχείου Λαμβάνει το περιεχόμενο ενός σημειωματάριου.
Στοιχείο λίστας Παράθεση όλων των στοιχείων σε έναν χώρο εργασίας.

Για περισσότερες πληροφορίες, ανατρέξτε στο θέμα Στοιχεία - API REST.

Οι ακόλουθες ενέργειες χρονοδιαγράμματος εργασίας είναι διαθέσιμες για σημειωματάρια:

Ενέργεια Περιγραφή
Εκτέλεση εργασίας στοιχείου κατ' απαίτηση Εκτελέστε το σημειωματάριο με παραμετροποίηση.
Ακύρωση παρουσίας εργασίας στοιχείου Ακύρωση εκτέλεσης εργασίας σημειωματάριου.
Λήψη παρουσίας εργασίας στοιχείου Λήψη κατάστασης εκτέλεσης σημειωματάριου.

Για περισσότερες πληροφορίες, ανατρέξτε στο θέμα Χρονοδιάγραμμα εργασίας.

Παραδείγματα χρήσης rest API σημειωματάριου

Χρησιμοποιήστε τις παρακάτω οδηγίες για να ελέγξετε παραδείγματα χρήσης για συγκεκριμένα δημόσια API σημειωματάριου και να επαληθεύσετε τα αποτελέσματα.

Σημείωμα

Αυτά τα σενάρια καλύπτουν μόνο παραδείγματα χρήσης σημειωματάριου-μοναδικού. Συνήθη παραδείγματα API στοιχείου fabric δεν καλύπτονται εδώ.

Προαπαιτούμενα στοιχεία

Το API Rest Fabric ορίζει ένα ενοποιημένο τελικό σημείο για λειτουργίες. Αντικαταστήστε τα σύμβολα κράτησης {WORKSPACE_ID} θέσης και {ARTIFACT_ID} με κατάλληλες τιμές όταν ακολουθείτε τα παραδείγματα σε αυτό το άρθρο.

Δημιουργία σημειωματάριου με ορισμό

Δημιουργήστε ένα στοιχείο σημειωματάριου με ένα υπάρχον αρχείο .ipynb και άλλο τύπο αρχείων προέλευσης.

Αίτηση

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

Το ωφέλιμο φορτίο στην αίτηση είναι μια συμβολοσειρά base64 που μετατρέπεται από το ακόλουθο δείγμα σημειωματάριου.

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

Σημείωμα

Μπορείτε να αλλάξετε την προεπιλεγμένη λίμνη σημειωματάριου ή το συνημμένο περιβάλλον αλλάζοντας το περιεχόμενο σημειωματάριου metadata.trident.lakehouse ή metadata.trident.environment.

Λήψη σημειωματάριου με ορισμό

Χρησιμοποιήστε το παρακάτω API για να λάβετε το περιεχόμενο του σημειωματάριου. Το Fabric σάς υποστηρίζει να ορίσετε τη μορφή ως .ipynb στη συμβολοσειρά ερωτήματος για τη λήψη ενός σημειωματάριου .ipynb.

Αίτηση

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

Response

Κωδικός κατάστασης: 200

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

Εκτέλεση σημειωματάριου κατ' απαίτηση

Προγραμματίστε την εκτέλεση του σημειωματάριού σας με το παρακάτω API. Η εργασία Spark ξεκινά να εκτελείται μετά από μια επιτυχημένη αίτηση.

Το Fabric υποστηρίζει τη μεταβίβαση parameters στο σώμα αίτησης για την παραμετροποίηση της εκτέλεσης σημειωματάριου. Οι τιμές καταναλώνονται από το κελί παραμέτρου σημειωματάριου.

Μπορείτε επίσης να χρησιμοποιήσετε configuration το για να εξατομικεύσετε την περίοδο λειτουργίας Spark του σημειωματάριου που εκτελείται. configuration Το θέτει σε κοινή χρήση την ίδια σύμβαση με τη μαγική εντολή ρύθμισης παραμέτρων περιόδου λειτουργίας Spark.

Αίτηση

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

Κωδικός κατάστασης: 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

Με locationτο , μπορείτε να χρησιμοποιήσετε τη λήψη παρουσίας εργασίας στοιχείου για να προβάλετε την κατάσταση της εργασίας ή να χρησιμοποιήσετε την επιλογή Ακύρωση παρουσίας εργασίας στοιχείου για να ακυρώσετε την εκτέλεση του τρέχοντος σημειωματάριου.

Σχετικό περιεχόμενο