Bagikan melalui

Mengelola lingkungan melalui API publik

  • Artikel

Microsoft Fabric REST API menyediakan titik akhir layanan untuk operasi buat, baca, perbarui, dan hapus (CRUD) item Fabric. Artikel ini menjelaskan REST API lingkungan yang tersedia dan penggunaannya.

Penting

Fitur ini dalam pratinjau.

Ringkasan API lingkungan yang tersedia

API Deskripsi Kategori
Membuat lingkungan Buat lingkungan baru di ruang kerja. Umum
Mendapatkan lingkungan Dapatkan metadata lingkungan. Respons mencakup status lingkungan. Umum
Memperbarui lingkungan Perbarui metadata lingkungan, seperti nama dan deskripsi. Umum
Menghapus lingkungan Menghapus lingkungan yang sudah ada. Umum
Mencantumkan lingkungan di ruang kerja Dapatkan daftar lingkungan di ruang kerja. Umum
Menerbitkan lingkungan Picu penerbitan lingkungan dengan perubahan tertunda saat ini. Umum
Menerbitkan pembatalan Membatalkan penerbitan lingkungan yang sedang berlangsung Umum
Dapatkan komputasi Spark yang diterbitkan Dapatkan konfigurasi komputasi Spark yang efektif. Komputasi Spark
Dapatkan komputasi Spark penahapan Dapatkan konfigurasi komputasi penahapan lengkap. Konfigurasi penahapan mencakup konfigurasi komputasi yang diterbitkan dan tertunda. Komputasi Spark
Mendapatkan pustaka yang diterbitkan Dapatkan daftar pustaka yang efektif. Pustaka
Mendapatkan pustaka penahapan Dapatkan daftar pustaka penahapan lengkap. Daftar ini mencakup pustaka yang diterbitkan dan tertunda. Pustaka
Mengunggah pustaka penahapan Menambahkan satu pustaka kustom atau satu/beberapa pustaka publik di lingkungan. Pustaka
Menghapus pustaka penahapan Hapus satu pustaka kustom penahapan atau semua pustaka publik. Pustaka

Pelajari selengkapnya tentang API publik lingkungan di API Item - Lingkungan

Kasus penggunaan API publik lingkungan

Bagian ini memancang Anda melalui beberapa skenario umum saat berhadapan dengan lingkungan. Anda dapat mengganti {WORKSPACE_ID} dan {ARTIFACT_ID} dalam contoh berikut dengan nilai yang sesuai.

Membuat lingkungan baru

Anda dapat membuat lingkungan kosong baru menggunakan API berikut.

  • Permintaan sampel

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

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

Mengelola pustaka penahapan

Anda dapat menggunakan API pustaka penahapan unggah/hapus untuk mengelola bagian pustaka di lingkungan

Periksa pustaka yang diterbitkan untuk lingkungan

Sebelum menambahkan/menghapus pustaka, Anda dapat menggunakan API dapatkan pustaka yang diterbitkan untuk memeriksa pustaka apa yang saat ini efektif.

  • Permintaan sampel

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

  • Respon sampel

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

Mengunggah pustaka

API untuk mengunggah pustaka penahapan menerima satu file pada satu waktu. Jenis file yang didukung adalah .whl, .jar, .tar.gz, .py , dan environment.yml untuk pustaka publik. Anda dapat menentukan file melalui tipe konten multipart/form-data.

Catatan

  • Untuk memanipulasi pustaka publik secara lebih efisien, sangat disarankan untuk menyusun semua pustaka yang diharapkan dari PyPI dan conda dalam file environment.yml.
  • API pengunggahan memungkinkan hingga 200 MB file dalam satu permintaan, pustaka yang melebihi batas ukuran ini saat ini tidak didukung di API publik.

  • Sampel permintaan

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

Menghapus pustaka

Dengan menentukan nama file pustaka lengkap dengan akhiran jenis, Anda dapat menghapus satu pustaka pada satu waktu.

Catatan

  • Jika Anda menentukan environment.yml sebagai file yang akan dihapus, Anda akan menghapus semua pustaka publik.
  • Jika Anda ingin menghapus subset pustaka publik yang ada, gunakan pustaka unggahan sebagai gantinya dan unggah environment.yml yang hanya berisi pustaka yang diharapkan. Environment.yml yang diunggah menggantikan bagian pustaka publik yang ada sepenuhnya.

  • Sampel permintaan

    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

Mengelola komputasi Spark penahapan

Anda dapat menggunakan komputasi Spark penahapan pembaruan untuk mengelola komputasi Spark.

Periksa komputasi Spark yang diterbitkan untuk lingkungan

Sebelum mengubah konfigurasi untuk lingkungan, Anda dapat menggunakan API komputasi Spark yang diterbitkan untuk memeriksa konfigurasi komputasi Spark apa yang saat ini efektif.

  • Permintaan sampel

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

  • Respon sampel

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

Memperbarui konfigurasi komputasi

Anda dapat memperbarui runtime Spark, beralih ke kumpulan lain, menyempurnakan konfigurasi komputasi, dan menambahkan/menghapus properti Spark melalui pengeditan isi permintaan API ini.

Jika Anda ingin menghapus properti Spark yang sudah ada, Anda perlu menentukan nilai seperti null halnya kunci yang ingin Anda hapus, seperti yang diperlihatkan dalam contoh berikut.

  • Permintaan sampel

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

Membuat perubahan efektif

Menggunakan set API berikut untuk menerbitkan perubahan.

Mempersiapkan penerbitan

Lingkungan dapat menerima satu penerbitan pada satu waktu. Sebelum menerbitkan lingkungan, Anda dapat memvalidasi status lingkungan dan memiliki tinjauan akhir tentang perubahan penahapan. Setelah lingkungan berhasil diterbitkan, semua konfigurasi dalam status penahapan menjadi efektif.

  • Langkah 1: dapatkan metadata lingkungan

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

    Dalam isi respons, Anda dapat mengetahui dengan jelas status lingkungan. Pastikan tidak ada penerbitan yang sedang berlangsung sebelum Anda beralih ke langkah berikutnya.

  • Langkah 2: dapatkan pustaka penahapan/komputasi Spark untuk memiliki tinjauan akhir

    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

Memicu penerbitan lingkungan

Perubahan yang Anda buat untuk pustaka penahapan dan komputasi Spark di-cache tetapi mengharuskan penerbitan menjadi efektif. Ikuti contoh berikut untuk memicu penerbitan.

  • Permintaan sampel

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

  • Respon sampel

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

Selama penerbitan, Anda juga dapat memanggil API berikut untuk membatalkannya .

  • Permintaan sampel

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

Konten terkait