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

Items - List Spark Job Definitions

Служба:
SparkJobDefinition
Версия API:
v1

Возвращает список определений заданий Spark из указанной рабочей области.
Этот API поддерживает разбивки на страницы.

Разрешения

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

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

Workspace.Read.All или Workspace.ReadWrite.All

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

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

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

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions
С использованием необязательных параметров: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sparkJobDefinitions?continuationToken={continuationToken}

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.
continuationToken
 query

string

Маркер получения следующей страницы результатов.

Ответы

Имя Тип Описание
200 OK

SparkJobDefinitions

Запрос успешно завершен.
Other Status Codes

ErrorResponse

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

  • InvalidItemType — недопустимый тип элемента.

Примеры

List spark job definitions in workspace example

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

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

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

Код состояния:
200 
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "SparkJobDefinition Name 1",
      "description": "A spark job definition description.",
      "type": "SparkJobDefinition",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
      }
    },
    {
      "id": "f697fb63-abd4-4399-9548-be7e3c3c0dac",
      "displayName": "SparkJobDefinition Name 2",
      "description": "A spark job definition description.",
      "type": "SparkJobDefinition",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
      }
    }
  ]
}

Определения

Имя Описание
ErrorRelatedResource

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

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

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

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

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

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

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

Список определений заданий 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

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

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

Моментальный снимок хранилища.

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.

SparkJobDefinitions

Object

Список определений заданий Spark.

Имя Тип Описание
continuationToken

string

Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri

string

Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value

SparkJobDefinition[]

Список определений заданий Spark.