Job Scheduler - List Item Schedules

Служба:: Core

Версия API:: v1

Получение параметров планирования для одного конкретного элемента.
Этот API поддерживает разбивки на страницы.

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

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

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

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

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

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

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

Интерфейс

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

С использованием необязательных параметров:

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	ItemSchedules	Успешно извлечены все расписания элементов.
Other Status Codes	ErrorResponse	Распространенные коды ошибок: НедостаточноPrivileges — вызывающий объект не имеет достаточных разрешений для доступа к элементу ItemNotFound — запрошенный идентификатор элемента не найден

Имя

Тип

Описание

200 OK

ItemSchedules

Успешно извлечены все расписания элементов.

Other Status Codes

ErrorResponse

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

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

Примеры

List item schedules example

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

HTTP

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

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

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

{
  "value": [
    {
      "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"
      }
    },
    {
      "id": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
      "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",
        "weekdays": [
          "Monday",
          "Tuesday"
        ],
        "times": [
          "18:09",
          "17:12"
        ]
      },
      "owner": {
        "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
        "type": "User"
      }
    },
    {
      "id": "c0ed1d27-32dc-49e6-90ba-cac9b6248c7f",
      "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": "Daily",
        "times": [
          "18:09",
          "17:12"
        ]
      },
      "owner": {
        "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
        "type": "User"
      }
    }
  ]
}

Определения

Имя	Описание
CronScheduleConfig
DailyScheduleConfig
DayOfWeek	Список рабочих дней разрешено не более семи элементов.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.
ItemSchedule	Расписание элементов.
ItemSchedules	список расписаний для этого элемента.
Principal	Представляет удостоверение или группу Microsoft Entra.
PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.
WeeklyScheduleConfig

CronScheduleConfig

Object

Имя	Тип	Описание
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	Строка представляет тип плана. С течением времени могут добавляться дополнительные типы planType.

DailyScheduleConfig

Object

Имя	Тип	Описание
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	Строка представляет тип плана. С течением времени могут добавляться дополнительные типы planType.

DayOfWeek

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

Список рабочих дней разрешено не более семи элементов.

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

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

GroupDetails

Object

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

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

GroupType

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

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

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

ItemSchedule

Object

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

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

ItemSchedules

Object

список расписаний для этого элемента.

Имя	Тип	Описание
continuationToken	string	Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri	string	Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value	ItemSchedule[]	список расписаний для этого элемента.

Principal

Object

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

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
groupDetails	GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalDetails	ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
type	PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails	UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.

PrincipalType

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

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

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

ServicePrincipalDetails

Object

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

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

ServicePrincipalProfileDetails

Object

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

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

UserDetails

Object

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

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

WeeklyScheduleConfig

Object

Имя	Тип	Описание
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	Строка представляет тип плана. С течением времени могут добавляться дополнительные типы planType.
weekdays	DayOfWeek[]	Список рабочих дней разрешено не более семи элементов.

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

Job Scheduler - List Item Schedules

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

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

Интерфейс

Параметры URI

Ответы

Примеры

List item schedules example

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

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

Определения

CronScheduleConfig

DailyScheduleConfig

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemSchedule

ItemSchedules

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

WeeklyScheduleConfig