Items - Create Spark Job Definition

Служба:: SparkJobDefinition

Версия API:: v1

Создает определение задания Spark в указанной рабочей области.
Этот API поддерживает длительные операции (LRO).

Чтобы создать определение задания Spark с помощью общедоступного определения, см. статью определение задания Spark.

Разрешения

Вызывающий объект должен иметь роль рабочей области участника .

Обязательные делегированные области

SparkJobDefinition.ReadWrite.All или Item.ReadWrite.All

Ограничения

Чтобы создать определение задания Spark, рабочая область должна находиться в поддерживаемой емкости Fabric. Дополнительные сведения см. в статье типов лицензий Microsoft Fabric.

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.

Тождество	Поддержка
Пользователь	Да
субъекта-службы и управляемых удостоверений	Да

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

Текст запроса

Имя	Обязательно	Тип	Описание
displayName	True	string	Отображаемое имя определения задания Spark. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
definition		SparkJobDefinitionPublicDefinition	Общедоступное определение задания Spark.
description		string	Описание определения задания Spark. Максимальная длина — 256 символов.
folderId		string (uuid)	Идентификатор папки. Если задание Spark не задано или не задано значение NULL, оно создается в рабочей области в качестве папки.

Ответы

Имя	Тип	Описание
201 Created	SparkJobDefinition	Успешно создано
202 Accepted		Запрос принят, подготовка определения задания Spark выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: InvalidItemType — тип элемента недопустим ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется. Поврежденный Payload — предоставленные полезные данные повреждены. WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Имя

Тип

Описание

201 Created

SparkJobDefinition

Успешно создано

202 Accepted

Запрос принят, подготовка определения задания Spark выполняется.

Заголовки

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

InvalidItemType — тип элемента недопустим
ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется.
Поврежденный Payload — предоставленные полезные данные повреждены.
WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Примеры

Create a spark job definition example

Create a spark job definition with public definition example

Create a spark job definition example

Образец запроса

HTTP

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

Образец запроса

HTTP

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	Сведения об ответе на ошибку.
ItemTag	Представляет тег, примененный к элементу.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.
SparkJobDefinition	Объект определения задания Spark.
SparkJobDefinitionProperties	Свойства определения задания Spark.
SparkJobDefinitionPublicDefinition	Объект общедоступного определения задания Spark. Дополнительные сведения о создании общедоступного определения задания Spark см. в этой статье.
SparkJobDefinitionPublicDefinitionPart	Объект части определения определения задания Spark.

CreateSparkJobDefinitionRequest

Object

Создайте полезные данные запроса определения задания Spark.

Имя	Тип	Описание
definition	SparkJobDefinitionPublicDefinition	Общедоступное определение задания Spark.
description	string	Описание определения задания Spark. Максимальная длина — 256 символов.
displayName	string	Отображаемое имя определения задания Spark. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
folderId	string (uuid)	Идентификатор папки. Если задание Spark не задано или не задано значение NULL, оно создается в рабочей области в качестве папки.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

ItemTag

Object

Представляет тег, примененный к элементу.

Имя	Тип	Описание
displayName	string	Имя тега.
id	string (uuid)	Идентификатор тега.

ItemType

Перечисление

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение	Описание
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Задание копирования.
Dashboard	Панель мониторинга PowerBI.
DataPipeline	Конвейер данных.
Dataflow	Поток данных.
Datamart	Datamart PowerBI.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Поток Конструктора цифровых двойников.
Environment	Среда.
Eventhouse	Хранилище событий.
Eventstream	Поток событий.
GraphQLApi	API для элемента GraphQL.
KQLDashboard	Панель мониторинга KQL.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
Lakehouse	Озеро.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
MirroredAzureDatabricksCatalog	Зеркальный каталог azure databricks.
MirroredDatabase	Зеркальная база данных.
MirroredWarehouse	Зеркальный склад.
MountedDataFactory	ПодключеннаяdataFactory.
Notebook	Записная книжка.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Reflex	Рефлекс.
Report	Отчет PowerBI.
SQLDatabase	База данных SQLDatabase.
SQLEndpoint	Конечная точка SQL.
SemanticModel	Семантическая модель PowerBI.
SparkJobDefinition	Определение задания Spark.
VariableLibrary	ПеременнаяLibrary.
Warehouse	Склад.
WarehouseSnapshot	Моментальный снимок хранилища.

PayloadType

Перечисление

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение	Описание
InlineBase64	Встроенная база 64.

SparkJobDefinition

Object

Объект определения задания Spark.

Имя	Тип	Описание
description	string	Описание элемента.
displayName	string	Отображаемое имя элемента.
folderId	string (uuid)	Идентификатор папки.
id	string (uuid)	Идентификатор элемента.
properties	SparkJobDefinitionProperties	Свойства определения задания Spark.
tags	ItemTag[]	Список примененных тегов.
type	ItemType	Тип элемента.
workspaceId	string (uuid)	Идентификатор рабочей области.

SparkJobDefinitionProperties

Object

Свойства определения задания Spark.

Имя	Тип	Описание
oneLakeRootPath	string	Путь OneLake к корневому каталогу SparkJobDefinition.

SparkJobDefinitionPublicDefinition

Object

Объект общедоступного определения задания Spark. Дополнительные сведения о создании общедоступного определения задания Spark см. в этой статье.

Имя	Тип	Описание
format	string	Формат определения элемента. Поддерживаемый формат: `SparkJobDefinitionV1`.
parts	SparkJobDefinitionPublicDefinitionPart[]	Список частей определения.

SparkJobDefinitionPublicDefinitionPart

Object

Объект части определения определения задания Spark.

Имя	Тип	Описание
path	string	Путь к части определения задания Spark.
payload	string	Полезные данные общедоступного определения задания Spark.
payloadType	PayloadType	Тип полезных данных.

Поделиться через

Items - Create Spark Job Definition

Разрешения

Обязательные делегированные области

Ограничения

Поддерживаемые удостоверения Microsoft Entra

Интерфейс

Параметры URI

Текст запроса

Ответы

Примеры

Create a spark job definition example

Образец запроса

Пример ответа

Create a spark job definition with public definition example

Образец запроса

Пример ответа

Определения

CreateSparkJobDefinitionRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

SparkJobDefinition

SparkJobDefinitionProperties

SparkJobDefinitionPublicDefinition

SparkJobDefinitionPublicDefinitionPart