Mengelola lingkungan melalui API publik

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.

Memigrasikan API lingkungan ke versi GA stabil mereka

Penting

Rilis GA mencakup pembaruan dalam kontrak permintaan/respons API yang ada, penghentian API, dan API baru. Anda dapat menemukan detailnya di bagian berikut.
Parameter beta kueri baru diperkenalkan untuk memfasilitasi transisi perubahan kontrak permintaan/respons. Parameter kueri beta mengatur ke nilai awal True hingga 31 Maret 2026, sehingga kontrak pratinjau masih tersedia. Atur nilai ke False untuk mulai menggunakan versi Rilis stabil dari kontrak.
Preview parameter kueri telah digantikan oleh beta. Untuk kompatibilitas kebelakang, pratinjau masih didukung dan berperilaku sama dengan beta.
API yang akan dihentikan akan terus didukung hingga 31 Maret 2026; silakan gunakan API yang baru diperkenalkan untuk menggantinya sesegera mungkin.

Pembaruan kontrak permintaan/respons pada API

Kategori	API	Deskripsi	Catatan	Pratinjau versi Swagger	Versi rilis Swagger
Pengoperasian item	Lingkungan untuk publikasi	Aktifkan proses penerbitan lingkungan dengan perubahan yang saat ini tertunda.	Pembaruan terkait kontrak respons.	Lingkungan Publikasi (Pratinjau)	Lingkungan Penerbitan
Tahap Persiapan	Daftar pustaka pemanggungan	Dapatkan daftar pustaka penahapan lengkap. Daftar ini mencakup daftar pustaka yang diterbitkan dan yang masih dalam proses.	Pembaruan terkait kontrak respons.	Mencantumkan pustaka penahapan (Pratinjau)	Mencantumkan pustaka penahapan
Tahap Persiapan	Daftar komputasi Spark tahap persiapan	Dapatkan konfigurasi komputasi penahapan lengkap. Konfigurasi penahapan meliputi konfigurasi komputasi yang sudah diterbitkan dan yang masih dalam status tertunda.	Pembaruan terkait kontrak respons.	Mencantumkan staging komputasi Spark (Pratinjau)	Daftar penahapan komputasi Spark
Tahap Persiapan	Memperbarui komputasi Spark	Perbarui konfigurasi komputasi dan properti Spark untuk lingkungan.	Pembaruan dalam kontrak permintaan dan tanggapan.	Perbarui komputasi Spark (Pratinjau)	Memperbarui komputasi Spark
Diterbitkan	Daftar perpustakaan yang diterbitkan	Dapatkan pustaka yang diterbitkan dan efektif untuk sesi Spark.	Pembaruan terkait kontrak respons.	Daftar pustaka publik (Pratinjau)	Daftar pustaka yang diterbitkan
Diterbitkan	Daftar komputasi Spark yang diterbitkan	Dapatkan konfigurasi komputasi Spark dan properti Spark yang telah dipublikasikan dan berjalan efektif dalam sesi Spark.	Pembaruan terkait kontrak respons.	Daftar pustaka publik (Pratinjau)	Daftar pustaka yang diterbitkan

Parameter beta memiliki nilai default True hingga 31 Maret 2026, yakni, sistem akan menganggap parameter sebagai True jika permintaan dikirim tanpa menentukan parameter ini sampai tanggal penghentian tersebut. Kami sangat menyarankan Anda untuk memigrasikan implementasi ke versi stabil dengan mengatur parameter beta secara eksplisit sesegera mungkin False.

Menggunakan List staging libraries API sebagai contoh, yang memiliki pembaruan dalam respons API.

Saat mengirim permintaan dengan parameter beta sebagai True

Permintaan sampel:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=True

Contoh respons:

{
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

Saat mengirim permintaan dengan parameter preview sebagai False

Permintaan sampel:

  GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=False

Contoh respons:

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

API yang tidak digunakan lagi

Penting

API yang akan dihentikan akan terus didukung hingga 31 Maret 2026. Kami sangat menyarankan untuk menggunakan API yang baru diperkenalkan untuk menggantikan implementasi Anda sesegera mungkin.

Kategori	API	Deskripsi	Catatan
Tahap Persiapan	Mengunggah pustaka pengembangan	Tambahkan satu pustaka kustom atau satu/beberapa pustaka publik di lingkungan.	Dukungan hingga 31 Maret 2026, silakan gunakan API yang baru diperkenalkan `Import external libraries`/`Upload custom library` untuk mengganti.
Tahap Persiapan	Menghapus pustaka penahapan	Hapus satu pustaka kustom penahapan atau semua pustaka publik.	Dukungan hingga 31 Maret 2026, silakan gunakan API yang baru diperkenalkan `Remove external library`/`Delete custom library` untuk mengganti.

Berikut beberapa contoh skenario dalam mengelola perpustakaan staging.

Menambahkan pustaka publik di lingkungan Anda

Sebelumnya, Anda dapat menggunakan Upload staging libraries API untuk mengunggah file YAML yang diperbarui, dan sekarang Anda dapat menggunakan Import external libraries API untuk mengimpor YAML yang diperbarui.
Menghapus satu pustaka publik di lingkungan Anda

Sebelumnya, Anda dapat menggunakan Upload staging libraries API untuk mengunggah file YAML yang diperbarui, dan sekarang Anda dapat menggunakan Remove external library API untuk menghapusnya.
Menghapus semua pustaka publik di lingkungan Anda

Sebelumnya, Anda dapat menggunakan Delete staging libraries API untuk menghapus semua pustaka publik, dan sekarang Anda dapat menggunakan Remove external library API untuk menghapus pustaka publik satu per satu atau menggunakan Import external libraries untuk mengunggah file YAML kosong untuk mencapai fungsionalitas yang sama.

API Baru

Kategori	API	Deskripsi	Catatan
Pengoperasian item	Membuat lingkungan dengan definisi	Buat lingkungan baru dengan definisi.	API baru.
Pengoperasian item	Mendapatkan definisi lingkungan	Dapatkan definisi lingkungan.	API baru.
Pengoperasian item	Memperbarui definisi lingkungan	Perbarui definisi lingkungan.	API baru.
Tahap Persiapan	Mengimpor pustaka eksternal	Unggah pustaka eksternal sebagai file environment.yml ke lingkungan. Ini menggantikan daftar pustaka eksternal yang ada di lingkungan.	API baru.
Tahap Persiapan	Mengekspor pustaka eksternal	Dapatkan pustaka eksternal lengkap sebagai file environment.yml .	API baru.
Tahap Persiapan	Hapus pustaka eksternal	Menghapus pustaka eksternal dari lingkungan. API ini menerima satu pustaka pada satu waktu.	API baru.
Tahap Persiapan	Unggah pustaka kustom	Unggah paket kustom di lingkungan. API ini memungkinkan satu unggahan file pada satu waktu. Format file yang didukung .jar, .py, .whl, dan .tar.gz.	API baru.
Tahap Persiapan	Menghapus pustaka kustom	Menghapus paket kustom dari lingkungan. Masukkan nama lengkap paket kustom dengan ekstensi dalam permintaan API untuk menghapusnya.	API baru.
Diterbitkan	Mengekspor pustaka eksternal	Dapatkan pustaka eksternal yang diterbitkan sebagai file environment.yml.	API baru.

API tanpa pembaruan

Kategori	API	Deskripsi
Pengoperasian item	Membuat lingkungan	Buat lingkungan kosong baru di ruang kerja.
Pengoperasian item	Dapatkan lingkungan	Dapatkan metadata lingkungan. Respons mencakup status lingkungan.
Pengoperasian item	Menghapus lingkungan	Menghapus lingkungan yang sudah ada.
Pengoperasian item	Mencantumkan lingkungan	Dapatkan daftar lingkungan di ruang kerja.
Pengoperasian item	Memperbarui lingkungan	Perbarui metadata lingkungan, seperti nama dan deskripsi.
Pengoperasian item	Batalkan penerbitan lingkungan	Batalkan operasi publikasi lingkungan yang sedang berlangsung.

Untuk mempelajari selengkapnya tentang API publik lingkungan, lihat API Item - Lingkungan.

Kasus penggunaan API publik lingkungan

Penting

Bagian ini ditunjukkan dengan versi Rilis API yang stabil.

Bagian ini menunjukkan cara menggunakan API untuk mencapai skenario tertentu saat mengelola Lingkungan. Anda dapat mengganti {WORKSPACE_ID} properti dan {ARTIFACT_ID} dalam contoh berikut dengan nilai yang sesuai.

Membuat lingkungan baru

Untuk membuat lingkungan kosong baru, gunakan API berikut.

Permintaan sampel

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

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

Mengelola bibliotek tahapan

Anda dapat menggunakan API untuk unggah dan hapus pustaka staging dalam mengelola bagian perpustakaan di dalam lingkungan.

Periksa pustaka yang diterbitkan untuk lingkungan

Sebelum Anda menambahkan atau menghapus pustaka, gunakan Get Published Libraries API untuk memeriksa pustaka mana yang saat ini efektif.

Permintaan sampel

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

Respon sampel

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Mengimpor pustaka publik atau mengunggah pustaka kustom

Anda dapat menggunakan Impor pustaka eksternal dan Mengunggah API pustaka kustom untuk menambahkan pustaka publik/kustom baru ke lingkungan Anda. API impor pustaka eksternal menerima file environment.yml sementara jenis file yang didukung adalah .whl, .jar, .tar.gz, .py untuk mengunggah API pustaka kustom.

Catatan

Untuk memanipulasi pustaka publik secara lebih efisien, kami sarankan Anda menyusun semua pustaka yang diharapkan dari PyPI dan Conda dalam file environment.yml .

API pengunggahan memungkinkan hingga file 200 MB 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/importExternalLibraries

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

Menghapus pustaka kustom

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

Catatan

Jika Anda ingin menghapus subset pustaka publik yang ada atau semuanya, impor file YAML yang diperbarui melalui Import public libraries API.

Sampel permintaan

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

Mengelola komputasi Spark untuk persiapan

Anda dapat menggunakan komputasi Spark untuk tahap pembaruan guna mengelola komputasi Spark.

Periksa komputasi Spark yang diterbitkan untuk lingkungan

Sebelum Anda mengubah konfigurasi untuk lingkungan, gunakan Get Published Spark Compute API 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?beta=False

Respon sampel

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

Memperbarui konfigurasi komputasi

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

Anda dapat mengalihkan kumpulan terlampir dengan menentukan nama dan kumpulan tersebut. Tentukan nama kumpulan sebagai Starter Pool untuk mengalihkan kumpulan ke pengaturan default. Untuk mendapatkan daftar lengkap kumpulan kustom ruang kerja yang tersedia dengan REST API, lihat Kumpulan Kustom - Daftar Kumpulan Kustom Ruang Kerja.

Jika Anda ingin menghapus properti Spark yang sudah ada, tetapkan nilainya menjadi null untuk kunci yang ingin Anda hapus.

Permintaan sampel

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/staging/sparkcompute?beta=False

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2"
}

Membuat perubahan efektif

Gunakan set API berikut untuk menerbitkan perubahan.

Bersiap untuk operasi penerbitan

Lingkungan dapat menerima satu operasi penerbitan pada satu waktu. Sebelum Anda memublikasikan lingkungan Anda, validasi status lingkungan dan lakukan tinjauan akhir tentang perubahan staging. 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 dengan jelas melihat status lingkungan. Pastikan bahwa tidak ada operasi penerbitan yang sedang berlangsung sebelum Anda pindah ke langkah berikutnya.

Langkah 2: Siapkan pustaka penahapan/komputasi Spark untuk ditinjau akhir.

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

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

Memicu operasi publikasi lingkungan

Perubahan yang Anda buat untuk perpustakaan tahap pengujian dan komputasi Spark telah di-cache, tetapi memerlukan penerbitan agar menjadi efektif. Gunakan contoh berikutnya untuk memicu operasi penerbitan. Respons mengikuti pola operasi jangka panjang (LRO) dan kode respons HTTP 202 dapat dikembalikan.

Permintaan sampel

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

Respon sampel

Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

Selama operasi 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

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2025-10-09

Bagikan melalui

Mengelola lingkungan melalui API publik

Memigrasikan API lingkungan ke versi GA stabil mereka

Pembaruan kontrak permintaan/respons pada API

API yang tidak digunakan lagi

API Baru

API tanpa pembaruan

Kasus penggunaan API publik lingkungan

Membuat lingkungan baru

Mengelola bibliotek tahapan

Periksa pustaka yang diterbitkan untuk lingkungan

Mengimpor pustaka publik atau mengunggah pustaka kustom

Menghapus pustaka kustom

Mengelola komputasi Spark untuk persiapan

Periksa komputasi Spark yang diterbitkan untuk lingkungan

Memperbarui konfigurasi komputasi

Membuat perubahan efektif

Bersiap untuk operasi penerbitan

Memicu operasi publikasi lingkungan

Konten terkait

Saran dan Komentar

Sumber Daya Tambahan: