Custom Pools - Create Workspace Custom Pool

Layanan:

Spark

Versi API:

v1

Buat kumpulan kustom.

Hak akses

Pemanggil harus memiliki peran admin.

Cakupan yang Didelegasikan yang Diperlukan

Workspace.ReadWrite.All

Identitas yang didukung Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Dukungan
Pengguna	Ya
perwakilan Layanan dan identitas terkelola	Ya

Antarmuka

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
workspaceId	path	True	string (uuid)	ID ruang kerja.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
autoScale	True	AutoScaleProperties	Skala otomatis.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Alokasi pelaksana dinamis.
name	True	string	Nama kumpulan kustom. Panjang nama harus antara 1 dan 64 karakter dan hanya boleh berisi huruf, angka, tanda hubung, garis bawah, dan spasi. Nama kumpulan kustom harus unik dalam ruang kerja. "Kumpulan Pemula" adalah nama kumpulan kustom yang dipesan.
nodeFamily	True	NodeFamily	Keluarga node.
nodeSize	True	NodeSize	Ukuran node.

Respons

Nama	Jenis	Deskripsi
201 Created	CustomPool	Permintaan berhasil diselesaikan. Header Location: string
Other Status Codes	ErrorResponse	Kode kesalahan umum: UnknownError - Terjadi kesalahan.

Contoh

Create custom pool example

Permintaan sampel

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

{
  "name": "pool1",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Respon sampel

Kode status:

201

Location: https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7

{
  "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
  "name": "pool1",
  "type": "Workspace",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Definisi

Nama	Deskripsi
AutoScaleProperties	Properti skala otomatis.
CreateCustomPoolRequest	Buat payload permintaan kumpulan kustom.
CustomPool	Kumpulan kustom.
CustomPoolType	Jenis kumpulan kustom. Jenis CustomPoolType tambahan dapat ditambahkan dari waktu ke waktu.
DynamicExecutorAllocationProperties	Proertasi alokasi pelaksana dinamis.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
NodeFamily	Keluarga node. Jenis NodeFamily tambahan dapat ditambahkan dari waktu ke waktu.
NodeSize	ukuran simpul . Jenis NodeSize tambahan dapat ditambahkan dari waktu ke waktu.

AutoScaleProperties

Objek

Properti skala otomatis.

Nama	Jenis	Deskripsi
enabled	boolean	Status skala otomatis. False - Dinonaktifkan, benar - Diaktifkan.
maxNodeCount	integer (int32) minimum: 1	Jumlah simpul maksimum.
minNodeCount	integer (int32) minimum: 1	Jumlah simpul minimum.

CreateCustomPoolRequest

Objek

Buat payload permintaan kumpulan kustom.

Nama	Jenis	Deskripsi
autoScale	AutoScaleProperties	Skala otomatis.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alokasi pelaksana dinamis.
name	string	Nama kumpulan kustom. Panjang nama harus antara 1 dan 64 karakter dan hanya boleh berisi huruf, angka, tanda hubung, garis bawah, dan spasi. Nama kumpulan kustom harus unik dalam ruang kerja. "Kumpulan Pemula" adalah nama kumpulan kustom yang dipesan.
nodeFamily	NodeFamily	Keluarga node.
nodeSize	NodeSize	Ukuran node.

CustomPool

Objek

Kumpulan kustom.

Nama	Jenis	Deskripsi
autoScale	AutoScaleProperties	Skala otomatis.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Alokasi pelaksana dinamis.
id	string (uuid)	ID kumpulan kustom.
name	string	Nama kumpulan kustom.
nodeFamily	NodeFamily	Keluarga node.
nodeSize	NodeSize	Ukuran node.
type	CustomPoolType	Jenis kumpulan kustom.

CustomPoolType

Enumeration

Jenis kumpulan kustom. Jenis CustomPoolType tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Workspace	Kumpulan kustom tingkat ruang kerja
Capacity	Kumpulan kustom tingkat kapasitas

DynamicExecutorAllocationProperties

Objek

Proertasi alokasi pelaksana dinamis.

Nama	Jenis	Deskripsi
enabled	boolean	Status alokasi pelaksana dinamis. False - Dinonaktifkan, benar - Diaktifkan.
maxExecutors	integer (int32) minimum: 1	Pelaksana maksimum.
minExecutors	integer (int32) minimum: 1	Pelaksana minimum.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

NodeFamily

Enumeration

Keluarga node. Jenis NodeFamily tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
MemoryOptimized	Memori dioptimalkan

NodeSize

Enumeration

ukuran simpul . Jenis NodeSize tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Small	Ukuran simpul kecil
Medium	Ukuran simpul sedang
Large	Ukuran simpul besar
XLarge	Ukuran simpul XLarge
XXLarge	Ukuran simpul XXLarge