Spark Compute - Update Staging Settings

服务:

Environment

API 版本:

v1

注释

此 API 处于预览状态。

更新环境暂存 spark 计算。 如果要删除 spark 属性，请将其值设置为 null。

权限

对环境项的写入权限。

所需的委派范围

Environment.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/sparkcompute

URI 参数

名称	在	必需	类型	说明
environmentId	path	True	string (uuid)	环境 ID。
workspaceId	path	True	string (uuid)	工作区 ID。

请求正文

名称	类型	说明
driverCores	integer (int32)	Spark 驱动程序核心。
driverMemory	string	Spark 驱动程序内存。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	动态执行程序分配。
executorCores	integer (int32)	Spark 执行程序核心。
executorMemory	string	Spark 执行程序内存。
instancePool	InstancePool	环境池必须是有效的自定义池。 默认工作区池的名称 初学者池。
runtimeVersion	string	运行时版本，找到受支持的 构造运行时。 例如：1.3
sparkProperties	object	Spark 属性。

响应

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

示例

Update environment staging spark compute example

示例请求

HTTP

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

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

示例响应

状态代码:

200

{
  "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": {
    "spark.acls.enable": "false"
  },
  "runtimeVersion": "1.2"
}

定义

名称	说明
CustomPoolType	自定义池类型。 可能会随着时间的推移添加其他 CustomPoolType 类型。
DynamicExecutorAllocationProperties	动态执行程序分配代理。
EnvironmentSparkCompute
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
InstancePool	池的实例。
UpdateEnvironmentSparkComputeRequest

CustomPoolType

枚举

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

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

DynamicExecutorAllocationProperties

Object

动态执行程序分配代理。

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

EnvironmentSparkCompute

Object

名称	类型	说明
driverCores	integer (int32)	Spark 驱动程序核心。
driverMemory	string	Spark 驱动程序内存。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	动态执行程序分配。
executorCores	integer (int32)	Spark 执行程序核心。
executorMemory	string	Spark 执行程序内存。
instancePool	InstancePool	环境池必须是有效的自定义池。 “初学者池”表示使用初学者池。
runtimeVersion	string	运行时版本，找到受支持的 构造运行时。 例如：1.3
sparkProperties	object	Spark 属性。

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	与错误相关的资源详细信息。

InstancePool

Object

池的实例。

名称	类型	说明
id	string (uuid)	实例池 ID。
name	string	实例池名称。
type	CustomPoolType	实例池类型。

UpdateEnvironmentSparkComputeRequest

Object

名称	类型	说明
driverCores	integer (int32)	Spark 驱动程序核心。
driverMemory	string	Spark 驱动程序内存。
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	动态执行程序分配。
executorCores	integer (int32)	Spark 执行程序核心。
executorMemory	string	Spark 执行程序内存。
instancePool	InstancePool	环境池必须是有效的自定义池。 默认工作区池的名称 初学者池。
runtimeVersion	string	运行时版本，找到受支持的 构造运行时。 例如：1.3
sparkProperties	object	Spark 属性。