通过

Items - Create Spark Job Definition

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

在指定的工作区中创建 Spark 作业定义。
此 API 支持 长时间运行的作（LRO）。

若要使用公共定义创建 spark 作业定义，请参阅 Spark 作业定义 一文。

权限

调用方必须具有 参与者 或更高版本的工作区角色。

所需的委派范围

SparkJobDefinition.ReadWrite.All 或 Item.ReadWrite.All

局限性

Microsoft Entra 支持的标识

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

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

接口

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

URI 参数

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

string

uuid

工作区 ID。

请求正文

名称 必需 类型 说明
displayName True

string

spark 作业定义显示名称。 显示名称必须遵循项类型的命名规则。
definition

SparkJobDefinitionPublicDefinition

spark 作业定义公共定义。
description

string

spark 作业定义说明。 最大长度为 256 个字符。

响应

名称 类型 说明
201 Created

SparkJobDefinition

已成功创建
202 Accepted

请求已接受，正在进行 spark 作业定义预配。

标头

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

  • InvalidItemType - 项类型无效

  • ItemDisplayNameAlreadyInUse - 项显示名称已被使用。

  • CorruptedPayload - 提供的有效负载已损坏。

示例

Create a spark job definition example
Create a spark job definition with public definition example

Create a spark job definition example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sparkJobDefinitions

{
  "displayName": "SparkJobDefinition 1",
  "description": "A spark job definition description."
}

示例响应

状态代码:
201 
{
  "displayName": "SparkJobDefinition 1",
  "description": "A spark job definition description.",
  "type": "SparkJobDefinition",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a spark job definition with public definition example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sparkJobDefinitions

{
  "displayName": "SparkJobDefinition 1",
  "description": "A spark job definition description.",
  "definition": {
    "format": "SparkJobDefinitionV1",
    "parts": [
      {
        "path": "SparkJobDefinitionV1.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

示例响应

状态代码:
201 
{
  "displayName": "SparkJobDefinition 1",
  "description": "A spark job definition description.",
  "type": "SparkJobDefinition",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

定义

名称 说明
CreateSparkJobDefinitionRequest

创建 spark 作业定义请求有效负载。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
ItemType

项的类型。 可能会随着时间的推移添加其他项类型。
PayloadType

定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。
SparkJobDefinition

spark 作业定义对象。
SparkJobDefinitionProperties

spark 作业定义属性。
SparkJobDefinitionPublicDefinition

Spark 作业定义公共定义对象。 有关如何创建 spark 作业定义公共定义的更多详细信息，请参阅此 文章。
SparkJobDefinitionPublicDefinitionPart

Spark 作业定义定义部件对象。

CreateSparkJobDefinitionRequest

Object

创建 spark 作业定义请求有效负载。

名称 类型 说明
definition

SparkJobDefinitionPublicDefinition

spark 作业定义公共定义。
description

string

spark 作业定义说明。 最大长度为 256 个字符。
displayName

string

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

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

ItemType

Enumeration

项的类型。 可能会随着时间的推移添加其他项类型。

值 说明
Dashboard

PowerBI 仪表板。
DataPipeline

数据管道。
Datamart

PowerBI Datamart。
Environment

环境。
Eventhouse

事件屋。
Eventstream

事件流。
GraphQLApi

GraphQL 项的 API。
KQLDashboard

KQL 仪表板。
KQLDatabase

KQL 数据库。
KQLQueryset

KQL 查询集。
Lakehouse

湖屋
MLExperiment

机器学习试验。
MLModel

机器学习模型。
MirroredDatabase

镜像数据库。
MirroredWarehouse

镜像仓库。
MountedDataFactory

MountedDataFactory。
Notebook

笔记本。
PaginatedReport

PowerBI 分页报表。
Reflex

反射。
Report

PowerBI 报表。
SQLDatabase

SQLDatabase。
SQLEndpoint

SQL 终结点。
SemanticModel

PowerBI 语义模型。
SparkJobDefinition

spark 作业定义。
Warehouse

仓库。

PayloadType

Enumeration

定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。

值 说明
InlineBase64

内联基线 64。

SparkJobDefinition

Object

spark 作业定义对象。

名称 类型 说明
description

string

项说明。
displayName

string

项显示名称。
id

string

uuid

项 ID。
properties

SparkJobDefinitionProperties

spark 作业定义属性。
type

ItemType

项类型。
workspaceId

string

uuid

工作区 ID。

SparkJobDefinitionProperties

Object

spark 作业定义属性。

名称 类型 说明
oneLakeRootPath

string

SparkJobDefinition 根目录的 OneLake 路径。

SparkJobDefinitionPublicDefinition

Object

Spark 作业定义公共定义对象。 有关如何创建 spark 作业定义公共定义的更多详细信息，请参阅此 文章。

名称 类型 说明
format

string

项定义的格式。 支持的格式：SparkJobDefinitionV1。
parts

SparkJobDefinitionPublicDefinitionPart[]

定义部件的列表。

SparkJobDefinitionPublicDefinitionPart

Object

Spark 作业定义定义部件对象。

名称 类型 说明
path

string

spark 作业定义公共定义部件路径。
payload

string

spark 作业定义公共定义部分有效负载。
payloadType

PayloadType

有效负载类型。