Items - Update Spark Job Definition

Служба:

SparkJobDefinition

Версия API:

v1

Обновляет свойства указанного определения задания Spark.

Разрешения

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

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

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

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

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

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

Интерфейс

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

Параметры URI

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

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

Имя	Тип	Описание
description	string	Описание определения задания Spark. Максимальная длина — 256 символов.
displayName	string	Отображаемое имя определения задания Spark. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.

Ответы

Имя	Тип	Описание
200 OK	SparkJobDefinition	Запрос успешно завершен.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — запрошенный элемент не найден. InvalidRequest — недопустимый запрос на обновление.

Примеры

Update a spark job definition example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sparkJobDefinitions/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "SparkJobDefinition's New name",
  "description": "SparkJobDefinition's New description"
}

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

Код состояния:

200

{
  "displayName": "SparkJobDefinition's New name",
  "description": "SparkJobDefinition's New description",
  "type": "SparkJobDefinition",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
SparkJobDefinition	Объект определения задания Spark.
SparkJobDefinitionProperties	Свойства определения задания Spark.
UpdateSparkJobDefinitionRequest	Обновление запроса определения задания Spark.

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	Сведения об ошибках, связанных с ресурсом.

ItemType

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

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

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

SparkJobDefinition

Object

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

Имя	Тип	Описание
description	string	Описание элемента.
displayName	string	Отображаемое имя элемента.
id	string uuid	Идентификатор элемента.
properties	SparkJobDefinitionProperties	Свойства определения задания Spark.
type	ItemType	Тип элемента.
workspaceId	string uuid	Идентификатор рабочей области.

SparkJobDefinitionProperties

Object

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

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

UpdateSparkJobDefinitionRequest

Object

Обновление запроса определения задания Spark.

Имя	Тип	Описание
description	string	Описание определения задания Spark. Максимальная длина — 256 символов.
displayName	string	Отображаемое имя определения задания Spark. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.