Job Scheduler - Get Item Schedule

Служба:: Core

Версия API:: v1

Получение существующего расписания для элемента.

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

Для API элементов используются следующие типы областей:

Универсальная область: Item.Read.All или Item.ReadWrite.All
Конкретная область: itemType. Read.All или itemType. ReadWrite.All (например: Notebook.Read.All)

Дополнительные сведения об областях см. в статье области.

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

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

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules/{scheduleId}

Параметры URI

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

Ответы

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

200 OK

Имя	Тип	Описание
200 OK	ItemSchedule	Успешно получите расписание.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: НедостаточноPrivileges — вызывающий объект не имеет достаточных разрешений для доступа к элементу ItemNotFound — запрошенный идентификатор элемента не найден

ItemSchedule

Успешно получите расписание.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

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

НедостаточноPrivileges — вызывающий объект не имеет достаточных разрешений для доступа к элементу
ItemNotFound — запрошенный идентификатор элемента не найден

Примеры

get item schedule example

get item schedule with execution data example

get item schedule example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/DefaultJob/schedules/3546052c-ae64-4526-b1a8-52af7761426f

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

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

{
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "enabled": true,
  "createdDateTime": "2024-04-28T05:35:20.5366667",
  "configuration": {
    "startDateTime": "2024-04-28T00:00:00",
    "endDateTime": "2024-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Cron",
    "interval": 10
  },
  "owner": {
    "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
    "type": "User"
  }
}

get item schedule with execution data example

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

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/12345678-1234-1234-1234-123456789abc/items/87654321-4321-4321-4321-abcdef123456/jobs/DefaultJob/schedules/11111111-2222-3333-4444-555555555555

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

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

{
  "id": "11111111-2222-3333-4444-555555555555",
  "enabled": true,
  "createdDateTime": "2024-04-28T05:35:20.5366667",
  "configuration": {
    "startDateTime": "2024-04-28T00:00:00",
    "endDateTime": "2024-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Weekly",
    "times": [
      "10:00",
      "16:00"
    ],
    "weekdays": [
      "Monday",
      "Wednesday",
      "Friday"
    ]
  },
  "executionData": {
    "tableName": "Table2",
    "optimizeSettings": {
      "vOrder": false
    }
  },
  "owner": {
    "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "type": "User"
  }
}

Определения

Имя	Описание
CronScheduleConfig
DailyScheduleConfig
DayOfMonth	Указывает дату запуска задания. Значение должно быть допустимой датой. В противном случае он будет пропущен.
DayOfWeek	Дни недели
EntireTenantPrincipal	Представляет субъект клиента
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
GroupPrincipal	Представляет группу безопасности.
GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.
ItemSchedule	Расписание элементов.
MonthlyScheduleConfig
OrdinalWeekday	Указывает порядковый номер недели и будний день для активации задания. Значение должно быть допустимой датой. В противном случае он будет пропущен.
PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
ServicePrincipalPrincipal	Представляет субъект-службу Microsoft Entra.
ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Представляет профиль субъекта-службы.
UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.
UserPrincipal	Представляет субъект пользователя Microsoft Entra.
WeekIndex	Неделя месяца.
WeeklyScheduleConfig

CronScheduleConfig

Объект

Имя	Тип	Описание
endDateTime	string (date-time)	Время окончания этого расписания. Время окончания должно быть позже времени начала. Он должен находиться в формате UTC, используя формат ГГГГ-ММ-ДДTHH:мм:ssZ.
interval	integer (int32) minimum: 1 maximum: 5270400	Интервал времени в минутах. Число от 1 до 5270400 (10 лет).
localTimeZoneId	string	Реестр идентификаторов часового пояса на локальном компьютере для Windows см. в часовых поясов по умолчанию
startDateTime	string (date-time)	Время начала этого расписания. Если время начала находится в прошлом, он будет запускать задание мгновенно. Время находится в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:мм:ssZ.
type	string: Cron	Тип конфигурации расписания. С течением времени могут добавляться дополнительные типы.

DailyScheduleConfig

Объект

Имя	Тип	Описание
endDateTime	string (date-time)	Время окончания этого расписания. Время окончания должно быть позже времени начала. Он должен находиться в формате UTC, используя формат ГГГГ-ММ-ДДTHH:мм:ssZ.
localTimeZoneId	string	Реестр идентификаторов часового пояса на локальном компьютере для Windows см. в часовых поясов по умолчанию
startDateTime	string (date-time)	Время начала этого расписания. Если время начала находится в прошлом, он будет запускать задание мгновенно. Время находится в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:мм:ssZ.
times	string[]	Список интервалов времени в формате hh:mm. Максимальное количество слотов времени, которые можно использовать, составляет 100.
type	string: Daily	Тип конфигурации расписания. С течением времени могут добавляться дополнительные типы.

DayOfMonth

Объект

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

Имя	Тип	Описание
dayOfMonth	integer (int32) minimum: 1 maximum: 31	Указывает дату запуска задания, используя значение от 1 до 31. Например, 2 означает второй день месяца. Дата должна быть допустимой. Если указана недопустимая дата, например 31 февраля, она автоматически пропустит месяц, включающий 31-й день.
occurrenceType	string: DayOfMonth	Перечислитель, который перечисляет день для запуска заданий. С течением времени могут добавляться дополнительные типы.

DayOfWeek

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

Дни недели

Значение	Описание
Monday	Понедельник
Tuesday	Вторник
Wednesday	Среда
Thursday	Четверг
Friday	Пятница
Saturday	Суббота
Sunday	Воскресенье

EntireTenantPrincipal

Объект

Представляет субъект клиента

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
type	string: EntireTenant	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

GroupDetails

Объект

Группировка конкретных сведений. Применимо, если тип субъекта Group.

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

GroupPrincipal

Объект

Представляет группу безопасности.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
groupDetails	GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
id	string (uuid)	Идентификатор субъекта.
type	string: Group	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

GroupType

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

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

Значение	Описание
Unknown	Тип основной группы неизвестен.
SecurityGroup	Субъект — это группа безопасности.
DistributionList	Субъект — это список рассылки.

ItemSchedule

Объект

Расписание элементов.

Имя	Тип	Описание
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig MonthlyScheduleConfig WeeklyScheduleConfig	Фактические данные содержат время и выходные дни этого расписания.
createdDateTime	string (date-time)	Созданная метка времени этого расписания в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:мм:ssZ.
enabled	boolean	Включено ли это расписание. True — включено, false — отключено.
executionData	object	Данные выполнения для запланированного задания. Это исправлено статические данные, определенные определенным типом задания элемента.
id	string (uuid)	Идентификатор расписания.
owner	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Удостоверение пользователя, создавшего это расписание или последнее изменение.

MonthlyScheduleConfig

Объект

Имя	Тип	Описание
endDateTime	string (date-time)	Время окончания этого расписания. Время окончания должно быть позже времени начала. Он должен находиться в формате UTC, используя формат ГГГГ-ММ-ДДTHH:мм:ssZ.
localTimeZoneId	string	Реестр идентификаторов часового пояса на локальном компьютере для Windows см. в часовых поясов по умолчанию
occurrence	MonthlyOccurrence: DayOfMonth OrdinalWeekday	Дата запуска задания.
recurrence	integer (int32) minimum: 1 maximum: 12	Задает интервал повтора ежемесячного задания. Например, если задано значение 1, задание активируется каждый месяц.
startDateTime	string (date-time)	Время начала этого расписания. Если время начала находится в прошлом, он будет запускать задание мгновенно. Время находится в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:мм:ssZ.
times	string[]	Список интервалов времени в формате hh:mm. Максимальное количество слотов времени, которые можно использовать, составляет 100.
type	string: Monthly	Тип конфигурации расписания. С течением времени могут добавляться дополнительные типы.

OrdinalWeekday

Объект

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

Имя	Тип	Описание
occurrenceType	string: OrdinalWeekday	Перечислитель, который перечисляет день для запуска заданий. С течением времени могут добавляться дополнительные типы.
weekIndex	WeekIndex	Неделя месяца.
weekday	DayOfWeek	День недели для активации заданий.

PrincipalType

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

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

Значение	Описание
User	Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal	Субъект является субъектом-службой Microsoft Entra.
Group	Субъект — это группа безопасности.
ServicePrincipalProfile	Субъект — это профиль субъекта-службы.
EntireTenant	Субъект представляет всех пользователей клиента.

ServicePrincipalDetails

Объект

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя	Тип	Описание
aadAppId	string (uuid)	Microsoft Entra AppId субъекта-службы.

ServicePrincipalPrincipal

Объект

Представляет субъект-службу Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalDetails	ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
type	string: ServicePrincipal	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ServicePrincipalProfileDetails

Объект

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя	Тип	Описание
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Родительский субъект профиля субъекта-службы.

ServicePrincipalProfilePrincipal

Объект

Представляет профиль субъекта-службы.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

UserDetails

Объект

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя	Тип	Описание
userPrincipalName	string	Основное имя пользователя.

UserPrincipal

Объект

Представляет субъект пользователя Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
type	string: User	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails	UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.

WeekIndex

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

Неделя месяца.

Значение	Описание
First	Первый.
Second	Секунда.
Third	Третий.
Fourth	Четвёртый.
Fifth	Пятый.

WeeklyScheduleConfig

Объект

Имя	Тип	Описание
endDateTime	string (date-time)	Время окончания этого расписания. Время окончания должно быть позже времени начала. Он должен находиться в формате UTC, используя формат ГГГГ-ММ-ДДTHH:мм:ssZ.
localTimeZoneId	string	Реестр идентификаторов часового пояса на локальном компьютере для Windows см. в часовых поясов по умолчанию
startDateTime	string (date-time)	Время начала этого расписания. Если время начала находится в прошлом, он будет запускать задание мгновенно. Время находится в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:мм:ssZ.
times	string[]	Список интервалов времени в формате hh:mm. Максимальное количество слотов времени, которые можно использовать, составляет 100.
type	string: Weekly	Тип конфигурации расписания. С течением времени могут добавляться дополнительные типы.
weekdays	DayOfWeek[]	Список рабочих дней разрешено не более семи элементов.