Custom Pools - Create Workspace Custom Pool

服務:

Spark

API 版本:

v1

建立自訂集區。

權限

呼叫者必須具有 系統管理員 工作區角色。

必要的委派範圍

Workspace.ReadWrite.All

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別。

身份	支援
使用者	是的
服務主體 和 受控識別	是的

介面

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

URI 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string (uuid)	工作區標識碼。

要求本文

名稱	必要	類型	Description
autoScale	True	AutoScaleProperties	自動調整。
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	動態執行程式配置。
name	True	string	自訂集區名稱。 名稱長度必須介於 1 到 64 個字元之間，且只能包含字母、數位、虛線、底線和空格。 自訂集區名稱在工作區內必須是唯一的。 「入門集區」是保留的自定義集區名稱。
nodeFamily	True	NodeFamily	節點系列。
nodeSize	True	NodeSize	節點大小。

回應

名稱	類型	Description
201 Created	CustomPool	要求成功完成。 標題 Location: string
Other Status Codes	ErrorResponse	常見的錯誤碼： UnknownError - 發生錯誤。

範例

Create custom pool example

範例要求

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

範例回覆

狀態碼:

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

定義

名稱	Description
AutoScaleProperties	自動調整屬性。
CreateCustomPoolRequest	建立自定義集區要求承載。
CustomPool	自訂集區。
CustomPoolType	自訂集區類型。 可能會隨著時間新增其他 CustomPoolType 類型。
DynamicExecutorAllocationProperties	動態執行程式配置 Proerties。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
NodeFamily	節點系列。 可能會隨著時間新增其他 NodeFamily 類型。
NodeSize	節點大小。 可能會隨著時間新增其他 NodeSize 類型。

AutoScaleProperties

Object

自動調整屬性。

名稱	類型	Description
enabled	boolean	自動調整的狀態。 False - Disabled，true - Enabled。
maxNodeCount	integer (int32) minimum: 1	節點計數上限。
minNodeCount	integer (int32) minimum: 1	節點計數下限。

CreateCustomPoolRequest

Object

建立自定義集區要求承載。

名稱	類型	Description
autoScale	AutoScaleProperties	自動調整。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	動態執行程式配置。
name	string	自訂集區名稱。 名稱長度必須介於 1 到 64 個字元之間，且只能包含字母、數位、虛線、底線和空格。 自訂集區名稱在工作區內必須是唯一的。 「入門集區」是保留的自定義集區名稱。
nodeFamily	NodeFamily	節點系列。
nodeSize	NodeSize	節點大小。

CustomPool

Object

自訂集區。

名稱	類型	Description
autoScale	AutoScaleProperties	自動調整。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	動態執行程式配置。
id	string (uuid)	自訂集區標識碼。
name	string	自訂集區名稱。
nodeFamily	NodeFamily	節點系列。
nodeSize	NodeSize	節點大小。
type	CustomPoolType	自訂集區類型。

CustomPoolType

列舉型別

自訂集區類型。 可能會隨著時間新增其他 CustomPoolType 類型。

值	Description
Workspace	工作區層級自定義集區
Capacity	容量層級自定義集區

DynamicExecutorAllocationProperties

Object

動態執行程式配置 Proerties。

名稱	類型	Description
enabled	boolean	動態執行程式配置的狀態。 False - Disabled，true - Enabled。
maxExecutors	integer (int32) minimum: 1	執行程式上限。
minExecutors	integer (int32) minimum: 1	最小執行程式。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

NodeFamily

列舉型別

節點系列。 可能會隨著時間新增其他 NodeFamily 類型。

值	Description
MemoryOptimized	記憶體優化

NodeSize

列舉型別

節點大小。 可能會隨著時間新增其他 NodeSize 類型。

值	Description
Small	小型節點大小
Medium	中型節點大小
Large	大型節點大小
XLarge	XLarge節點大小
XXLarge	XXLarge節點大小