Custom Pools - Update Workspace Custom Pool

服务:

Spark

API 版本:

v1

更新自定义池。

权限

调用方必须具有 管理员 工作区角色。

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体 和 托管标识	是的

接口

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

URI 参数

名称	在	必需	类型	说明
poolId	path	True	string (uuid)	自定义池 ID。
workspaceId	path	True	string (uuid)	工作区 ID。

请求正文

名称	类型	说明
autoScale	AutoScaleProperties	自动缩放。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	动态执行程序分配。
name	string	自定义池名称。 名称长度必须介于 1 到 64 个字符之间，并且必须仅包含字母、数字、短划线、下划线和空格。 自定义池名称在工作区中必须是唯一的。 “初学者池”是保留的自定义池名称。
nodeFamily	NodeFamily	节点系列。
nodeSize	NodeSize	节点大小。

响应

名称	类型	说明
200 OK	CustomPool	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： UnknownError - 发生错误。

示例

Update custom pool example

示例请求

HTTP

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

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

示例响应

状态代码:

200

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

定义

名称	说明
AutoScaleProperties	自动缩放属性。
CustomPool	自定义池。
CustomPoolType	自定义池类型。 可能会随着时间的推移添加其他 CustomPoolType 类型。
DynamicExecutorAllocationProperties	动态执行程序分配代理。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
NodeFamily	节点系列。 可能会随着时间的推移添加其他 NodeFamily 类型。
NodeSize	节点大小。 可能会随着时间的推移添加其他 NodeSize 类型。
UpdateCustomPoolRequest	更新自定义池请求有效负载。

AutoScaleProperties

Object

自动缩放属性。

名称	类型	说明
enabled	boolean	自动缩放的状态。 False - Disabled，true - Enabled。
maxNodeCount	integer (int32) minimum: 1	最大节点计数。
minNodeCount	integer (int32) minimum: 1	最小节点计数。

CustomPool

Object

自定义池。

名称	类型	说明
autoScale	AutoScaleProperties	自动缩放。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	动态执行程序分配。
id	string (uuid)	自定义池 ID。
name	string	自定义池名称。
nodeFamily	NodeFamily	节点系列。
nodeSize	NodeSize	节点大小。
type	CustomPoolType	自定义池类型。

CustomPoolType

枚举

自定义池类型。 可能会随着时间的推移添加其他 CustomPoolType 类型。

值	说明
Capacity	容量级别自定义池
Workspace	工作区级别自定义池

DynamicExecutorAllocationProperties

Object

动态执行程序分配代理。

名称	类型	说明
enabled	boolean	动态执行程序分配的状态。 False - Disabled，true - Enabled。
maxExecutors	integer (int32) minimum: 1	最大执行程序。
minExecutors	integer (int32) minimum: 1	最小执行程序。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

NodeFamily

枚举

节点系列。 可能会随着时间的推移添加其他 NodeFamily 类型。

值	说明
MemoryOptimized	内存优化

NodeSize

枚举

节点大小。 可能会随着时间的推移添加其他 NodeSize 类型。

值	说明
Large	大型节点大小
Medium	中等节点大小
Small	小节点大小
XLarge	XLarge 节点大小
XXLarge	XXLarge 节点大小

UpdateCustomPoolRequest

Object

更新自定义池请求有效负载。

名称	类型	说明
autoScale	AutoScaleProperties	自动缩放。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	动态执行程序分配。
name	string	自定义池名称。 名称长度必须介于 1 到 64 个字符之间，并且必须仅包含字母、数字、短划线、下划线和空格。 自定义池名称在工作区中必须是唯一的。 “初学者池”是保留的自定义池名称。
nodeFamily	NodeFamily	节点系列。
nodeSize	NodeSize	节点大小。