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

Διαχείριση του περιβάλλοντος μέσω δημόσιων API

  • Άρθρο

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

Σημαντικό

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

Σύνοψη των διαθέσιμων API περιβάλλοντος

API Περιγραφή Category
Δημιουργία περιβάλλοντος Δημιουργήστε ένα νέο περιβάλλον στον χώρο εργασίας. Γενική
Λήψη περιβάλλοντος Λάβετε τα μετα-δεδομένα ενός περιβάλλοντος. Η απόκριση περιλαμβάνει την κατάσταση του περιβάλλοντος. Γενική
Ενημέρωση περιβάλλοντος Ενημερώστε τα μετα-δεδομένα ενός περιβάλλοντος, όπως το όνομα και η περιγραφή. Γενική
Διαγραφή περιβάλλοντος Διαγράψτε ένα υπάρχον περιβάλλον. Γενική
Περιβάλλον λίστας στον χώρο εργασίας Λήψη της λίστας περιβάλλοντος σε έναν χώρο εργασίας. Γενική
Δημοσίευση περιβάλλοντος Ενεργοποιήστε τη δημοσίευση του περιβάλλοντος με τις τρέχουσες εκκρεμείς αλλαγές. Γενική
Δημοσίευση ακύρωσης Ακύρωση συνεχούς δημοσίευσης του περιβάλλοντος Γενική
Λήψη δημοσιευμένου Spark compute Λάβετε τις ρυθμίσεις παραμέτρων υπολογισμού Spark που είναι αποτελεσματικές. Υπολογιστικό σπινθήρα
Λήψη υπολογισμού Spark προεργασίας Λάβετε τις πλήρεις ρυθμίσεις παραμέτρων υπολογισμού προεργασίας. Οι ρυθμίσεις παραμέτρων προεργασίας περιλαμβάνουν τις δημοσιευμένες και εκκρεμείς υπολογιστικές ρυθμίσεις. Υπολογιστικό σπινθήρα
Λήψη δημοσιευμένων βιβλιοθηκών Λάβετε τη λίστα βιβλιοθήκης που είναι αποτελεσματική. Βιβλιοθήκες
Λήψη βιβλιοθηκών προετοιμασίας Λάβετε την πλήρη λίστα βιβλιοθήκης προεργασίας. Αυτή η λίστα περιλαμβάνει τις δημοσιευμένες και εκκρεμείς βιβλιοθήκες. Βιβλιοθήκες
Αποστολή βιβλιοθηκών προεργασίας Προσθήκη μίας προσαρμοσμένης βιβλιοθήκης ή μίας/πολλαπλής δημόσιας βιβλιοθήκης στο περιβάλλον. Βιβλιοθήκες
Διαγραφή βιβλιοθηκών προεργασίας Διαγραφή μίας προσαρμοσμένης βιβλιοθήκης προεργασίας ή όλης της δημόσιας βιβλιοθήκης. Βιβλιοθήκες

Μάθετε περισσότερα σχετικά με τα δημόσια API περιβάλλοντος στα API στοιχείου - Περιβάλλον

Περιπτώσεις χρήσης δημόσιου API περιβάλλοντος

Αυτή η ενότητα σάς καθοδηγεί σε διάφορα συνήθη σενάρια κατά τον χειρισμό του περιβάλλοντος. Μπορείτε να αντικαταστήσετε τα {WORKSPACE_ID} και {ARTIFACT_ID} στα παρακάτω παραδείγματα με κατάλληλες τιμές.

Δημιουργία νέου περιβάλλοντος

Μπορείτε να δημιουργήσετε ένα νέο κενό περιβάλλον χρησιμοποιώντας το παρακάτω API.

  • Δείγμα αίτησης

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

{
    "displayName": "Environment_1",
    "description": "An environment description"
}

Διαχείριση βιβλιοθηκών προεργασίας

Μπορείτε να χρησιμοποιήσετε τα API βιβλιοθηκών αποστολής/διαγραφής προεργασίας για να διαχειριστείτε την ενότητα βιβλιοθήκης στο περιβάλλον

Έλεγχος δημοσιευμένων βιβλιοθηκών για το περιβάλλον

Πριν από την προσθήκη/διαγραφή της βιβλιοθήκης, μπορείτε να χρησιμοποιήσετε το API βιβλιοθηκών λήψης δημοσιεύσεων για να ελέγξετε ποιες βιβλιοθήκες είναι αποτελεσματικές αυτήν τη στιγμή.

  • Δείγμα αίτησης

    GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries

  • Δείγμα απόκρισης

    {
    "customLibraries": {
        "wheelFiles": [
            "samplewheel-0.18.0-py2.py3-none-any.whl"
        ],
        "pyFiles": [
            "samplepython.py"
        ],
        "jarFiles": [
            "samplejar.jar"
        ],
        "rTarFiles": [
            "sampleR.tar.gz"
        ]
    },
    "environmentYml": "dependencies:\r\n- pip:\r\n  - matplotlib==3.4.3"
}

Αποστολή βιβλιοθηκών

Το API για την αποστολή βιβλιοθήκης προεργασίας δέχεται ένα αρχείο κάθε φορά. Οι υποστηριζόμενοι τύποι αρχείων είναι .whl, .jar, .tar.gz, .py και environment.yml για τη δημόσια βιβλιοθήκη. Μπορείτε να καθορίσετε το αρχείο μέσω του τύπου-περιεχομένου πολλαπλών τμηματικά/δεδομένων φόρμας.

Σημείωμα

  • Για πιο αποτελεσματική διαχείριση της δημόσιας βιβλιοθήκης, συνιστάται ιδιαίτερα να συντάσσετε όλες τις αναμενόμενες βιβλιοθήκες από το PyPI και το conda σε ένα αρχείο environment.yml.
  • Το API αποστολής επιτρέπει έως και 200 MB αρχείο σε μία αίτηση, βιβλιοθήκη που υπερβαίνει αυτό το όριο μεγέθους δεν υποστηρίζεται προς το παρόν στο δημόσιο API.

  • Δείγματα αιτήσεων

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries

Διαγραφή των βιβλιοθηκών

Καθορίζοντας το πλήρες όνομα του αρχείου βιβλιοθήκης με το επίθημα τύπου, μπορείτε να διαγράψετε μία βιβλιοθήκη κάθε φορά.

Σημείωμα

  • Εάν καθορίσετε environment.yml ως το αρχείο που θα διαγραφεί, καταργείτε όλες τις δημόσιες βιβλιοθήκες.
  • Εάν θέλετε να καταργήσετε ένα υποσύνολο της υπάρχουσας δημόσιας βιβλιοθήκης, χρησιμοποιήστε τη βιβλιοθήκη αποστολής και αποστείλετε ένα environment.yml που περιέχει μόνο τις αναμενόμενες βιβλιοθήκες. Το environment.yml που έχει αποσταλεί αντικαθιστά εντελώς την υπάρχουσα ενότητα δημόσιας βιβλιοθήκης.

  • Δείγματα αιτήσεων

    DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?libraryToDelete=fuzzywuzzy-0.18.0-py2.py3-none-any.whl

Διαχείριση υπολογιστικού Spark προεργασίας

Μπορείτε να χρησιμοποιήσετε τον υπολογισμό spark προεργασίας ενημέρωσης για να διαχειριστείτε το υπολογιστικό αποτέλεσμα Spark.

Ελέγξτε το δημοσιευμένο Spark compute για το περιβάλλον

Πριν αλλάξετε τις ρυθμίσεις παραμέτρων για το περιβάλλον, μπορείτε να χρησιμοποιήσετε το API spark compute get published για να ελέγξετε ποιες ρυθμίσεις παραμέτρων υπολογισμού Spark είναι επί του παρόντος αποτελεσματικές.

  • Δείγμα αίτησης

    GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute

  • Δείγμα απόκρισης

    {
    "instancePool": {
        "name": "Starter Pool",
        "type": "Workspace"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
        "enabled": false,
        "minExecutors": 1,
        "maxExecutors": 1
    },
    "sparkProperties": {
        "spark.acls.enable": "false"
    },
    "runtimeVersion": "1.2"
}

Ενημέρωση των υπολογιστικών ρυθμίσεων

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

Μπορείτε να αλλάξετε τον συνδεδεμένο χώρο συγκέντρωσης καθορίζοντας το όνομα και την ομάδα της πισίνας. Καθορίστε το όνομα του χώρου συγκέντρωσης ως Starter Pool για να αλλάξετε τον χώρο συγκέντρωσης στις προεπιλεγμένες ρυθμίσεις. Για να λάβετε την πλήρη λίστα των διαθέσιμων προσαρμοσμένων ομάδων του χώρου εργασίας κατά REST API, ανατρέξτε στο θέμα Προσαρμοσμένοι χώροι συγκέντρωσης - Λίστα Προσαρμοσμένων χώρων εργασίας

Εάν θέλετε να καταργήσετε μια υπάρχουσα ιδιότητα Spark, πρέπει να καθορίσετε την τιμή ως null με το κλειδί που θέλετε να καταργήσετε, όπως φαίνεται στο παρακάτω παράδειγμα.

  • Δείγμα αίτησης

    PATCH https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute

{
    "instancePool": {
        "name": "Starter Pool",
        "type": "Workspace"
    },
    "driverCores": 4,
    "driverMemory": "56g",
    "executorCores": 4,
    "executorMemory": "56g",
    "dynamicExecutorAllocation": {
        "enabled": false,
        "minExecutors": 1,
        "maxExecutors": 1
    },
    "sparkProperties": {
        "spark.acls.enable": null
    },
    "runtimeVersion": "1.2"
}

Καταστήστε τις αλλαγές αποτελεσματικές

Χρήση των παρακάτω συνόλων API για τη δημοσίευση των αλλαγών.

Προετοιμασία για δημοσίευση

Το περιβάλλον μπορεί να δέχεται μία δημοσίευση κάθε φορά. Πριν από τη δημοσίευση του περιβάλλοντός σας, μπορείτε να επικυρώσετε την κατάσταση του περιβάλλοντος και να εξετάσετε οριστικά τις αλλαγές προεργασίας. Όταν το περιβάλλον δημοσιευτεί με επιτυχία, όλες οι ρυθμίσεις παραμέτρων στην κατάσταση προεργασίας καθίστανται αποτελεσματικές.

  • Βήμα 1: Λήψη των μετα-δεδομένων του περιβάλλοντος

    GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/

    Στο σώμα της απόκρισης, μπορείτε να γνωρίζετε με σαφήνεια την κατάσταση του περιβάλλοντος. Βεβαιωθείτε ότι δεν υπάρχει συνεχής δημοσίευση προτού προχωρήσετε στο επόμενο βήμα.

  • Βήμα 2: λάβετε τις βιβλιοθήκες προετοιμασίας/υπολογισμό Spark για να κάνετε μια τελική αναθεώρηση

    GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute

Ενεργοποίηση της δημοσίευσης του περιβάλλοντος

Οι αλλαγές που κάνατε για τις βιβλιοθήκες προεργασίας και το spark compute αποθηκεύονται στο cache, αλλά απαιτούν τη δημοσίευση για να γίνουν αποτελεσματικές. Ακολουθήστε το παρακάτω παράδειγμα για να ενεργοποιήσετε τη δημοσίευση.

  • Δείγμα αίτησης

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish

  • Δείγμα απόκρισης

    {
    "publishDetails":
    {
        "state": "Running",
        "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
        "startTime": "2024-03-29T14:17:09.0697022Z",
        "componentPublishInfo": {
            "sparkLibraries": {
                "state": "Running"
            },
            "sparkSettings": {
                "state": "Running"
            }
        }
    }
}

Κατά τη διάρκεια της δημοσίευσης, μπορείτε επίσης να καλέσετε το παρακάτω API για να το ακυρώσετε .

  • Δείγμα αίτησης

    POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish

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