通过

Published - Get Spark Compute (preview)

服务:
Environment
API 版本:
v1

获取环境 Spark 计算。

注释

此 API 是预览版的一部分，仅用于评估和开发目的。 它可能会根据反馈进行更改，不建议将其用于生产。 此预览版 API 将于 2026 年 3 月 1 日弃用，并替换为 此处提供的稳定版本。 新版本引入了中断性变更，并且不向后兼容。 调用此 API 时，调用方必须指定 true 为查询参数 preview的值。

弃用通知

引入了新的查询参数 preview ，以促进此转换：

  • 查询 preview 参数当前默认为 true.
  • 将查询参数的值 preview 设置为 false 使用此 API 的稳定发布版本。
  • 从 2026 年 3 月 1 日起，默认值 preview 将更改为 false。

若要确保兼容性，请将参数显式设置为 preview 所需的值（true 或 false）。

建议通过指定falsepreview查询参数（查询参数的默认值preview将设置为 false API 的弃用日期）来迁移集成以尽快使用发布版本。

发布版本中引入了以下不兼容的更改：

  • 响应属性sparkProperties的类型已从 object ..SparkProperty

Permissions

环境项的读取权限。

所需的委派范围

Item.Read.All 或 Item.ReadWrite.All 或 Environment.Read.All 或 Environment.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?preview={preview}

URI 参数

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

string (uuid)

环境 ID。
workspaceId
 path True

string (uuid)

工作区 ID。
preview
 query True

boolean

此参数指定要使用的 API 版本。 true设置为使用此页面中所述的预览版本，或使用false此处详述的发布版本。 从 2026 年 3 月 1 日起，默认值 preview 将更改为 false。

响应

名称 类型 说明
200 OK

EnvironmentSparkComputePreview

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

示例

Get environment Spark compute example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/sparkcompute?preview=True

示例响应

状态代码:
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

动态执行程序分配代理。
EnvironmentSparkComputePreview
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
InstancePool

池的实例。

CustomPoolType

枚举

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

值 说明
Workspace

工作区自定义池
Capacity

容量自定义池

DynamicExecutorAllocationProperties

Object

动态执行程序分配代理。

名称 类型 说明
enabled

boolean

动态执行程序分配的状态。 False - Disabled，true - Enabled。
maxExecutors

integer (int32)

minimum: 1

动态分配的最大执行程序数，此属性的最小值为 1。 最大值必须低于实例池 maxNodeCount。
minExecutors

integer (int32)

minimum: 1

动态分配的最小执行程序编号和此属性的最小值为 1。 最大值必须小于 maxExecutors。

EnvironmentSparkComputePreview

Object
名称 类型 说明
driverCores

integer (int32)

Spark 驱动程序核心。 必须是以下值之一：4、8、16、32、64。
driverMemory

string

Spark 驱动程序内存。
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

动态执行程序分配。
executorCores

integer (int32)

Spark 执行程序核心。 必须是以下值之一：4、8、16、32、64。
executorMemory

string

Spark 执行程序内存。
instancePool

InstancePool

环境池必须是有效的自定义池。 “初学者池”表示使用初学者池。
runtimeVersion

string

运行时版本，找到支持的 构造运行时。
sparkProperties

object

Spark 属性。 用于定义 Spark 属性的基于字典的协定将于 2026 年 1 月 31 日弃用。 请改用键值对列表。

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

实例池类型。