通过

Workspace Settings - Update Spark Settings

  • 参考
服务:
Spark
API 版本:
v1

更新工作区 spark 设置。

权限

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

所需的委派范围

Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

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

URI 参数

名称 在 必需 类型 说明
workspaceId
 path True

string (uuid)

工作区 ID。

请求正文

名称 类型 说明
automaticLog

AutomaticLogProperties

自动日志设置。
environment

EnvironmentProperties

环境设置。
highConcurrency

HighConcurrencyProperties

高并发设置。
job

SparkJobsProperties

作业管理设置。
pool

PoolProperties

池设置。

响应

名称 类型 说明
200 OK

WorkspaceSparkSettings

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

示例

Update workspace Spark settings default pool using pool ID example
Update workspace Spark settings example

Update workspace Spark settings default pool using pool ID example

示例请求

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

{
  "pool": {
    "defaultPool": {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}

示例响应

状态代码:
200 
{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  }
}

Update workspace Spark settings example

示例请求

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

{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

示例响应

状态代码:
200 
{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

定义

名称 说明
AutomaticLogProperties

自动日志属性。
CustomPoolType

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

环境的属性。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
HighConcurrencyProperties

高并发属性。
InstancePool
PoolProperties

池的属性
SparkJobsProperties

Spark 作业的属性。
StarterPoolProperties

自定义初学者池。
UpdateWorkspaceSparkSettingsRequest

更新工作区 Spark 设置请求有效负载。
WorkspaceSparkSettings

工作区 Spark 设置。

AutomaticLogProperties

Object

自动日志属性。

名称 类型 说明
enabled

boolean

自动日志的状态。 False - Disabled，true - Enabled。

CustomPoolType

枚举

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

值 说明
Capacity

容量级别自定义池
Workspace

工作区级别自定义池

EnvironmentProperties

Object

环境的属性。

名称 类型 说明
name

string

默认环境的名称。 空字符串指示没有工作区默认环境。
runtimeVersion

string

运行时 版本。 例如：1.3

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

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

HighConcurrencyProperties

Object

高并发属性。

名称 类型 说明
notebookInteractiveRunEnabled

boolean

笔记本交互式运行的高并发状态。 False - Disabled，true - Enabled。
notebookPipelineRunEnabled

boolean

笔记本管道运行的高并发状态。 False - Disabled，true - Enabled。

InstancePool

Object
名称 类型 说明
id

string (uuid)

实例池 ID。
name

string

实例池名称。
type

CustomPoolType

实例池类型。

PoolProperties

Object

池的属性

名称 类型 说明
customizeComputeEnabled

boolean

自定义项的计算配置。 False - Disabled，true - Enabled。
defaultPool

InstancePool

工作区的默认池。 它应该是有效的自定义池名称。 “初学者池”表示使用初学者池。
starterPool

StarterPoolProperties

自定义初学者池。 有关配置初学者池的详细信息，请参阅 配置初学者池。

SparkJobsProperties

Object

Spark 作业的属性。

名称 类型 说明
conservativeJobAdmissionEnabled

boolean

保留活动 Spark 作业的最大核心数。 启用此设置后，Fabric 容量将保留活动 Spark 作业所需的最大核心数，通过确保作业纵向扩展时核心可用，确保作业可靠性。 禁用此设置后，将基于所需的最小核心数启动作业，让更多作业同时运行。 有关详细信息，请参阅 工作录取和管理。 False - Disabled，true - Enabled。
sessionTimeoutInMinutes

integer (int32)

minimum: 1
maximum: 20160

终止非活动 Spark 会话的时间。 最大值为 14 天。

StarterPoolProperties

Object

自定义初学者池。

名称 类型 说明
maxExecutors

integer (int32)

minimum: 1

最大执行程序计数。
maxNodeCount

integer (int32)

minimum: 1

最大节点计数。

UpdateWorkspaceSparkSettingsRequest

Object

更新工作区 Spark 设置请求有效负载。

名称 类型 说明
automaticLog

AutomaticLogProperties

自动日志设置。
environment

EnvironmentProperties

环境设置。
highConcurrency

HighConcurrencyProperties

高并发设置。
job

SparkJobsProperties

作业管理设置。
pool

PoolProperties

池设置。

WorkspaceSparkSettings

Object

工作区 Spark 设置。

名称 类型 说明
automaticLog

AutomaticLogProperties

自动日志设置。
environment

EnvironmentProperties

环境设置。
highConcurrency

HighConcurrencyProperties

高并发设置。
job

SparkJobsProperties

作业管理设置。
pool

PoolProperties

池设置。