ItemJobScheduler
Properties
| Property | Type | Attributes | Description |
|---|---|---|---|
configuration | ScheduleConfiguration | Required | The schedule configuration |
enabled | bool | Required | Whether this schedule is enabled |
itemId | string | Required, Identifier | The item ID |
jobType | string | Required, Identifier | The job type. Allowed job types per item type: dataflow: {ApplyChanges, Execute}; datapipeline: {Execute}; lakehouse: {RefreshMaterializedLakeViews} |
workspaceId | string | Required, Identifier | The Workspace ID |
createdDateTime | string | Read-only | The created time stamp of this schedule in UTC, using the YYYY-MM-DDTHH:mm:ssZ format |
id | string | Read-only, Identifier | The Item Job Scheduler ID |
owner | ScheduleOwner | Read-only | The user identity that created this schedule or last modified it |
ScheduleConfiguration
| Property | Type | Attributes | Description |
|---|---|---|---|
endDateTime | string | Required | The end time for this schedule, in UTC using the YYYY-MM-DDTHH:mm:ssZ format. Must be later than startDateTime |
startDateTime | string | Required | The start time for this schedule, in UTC using the YYYY-MM-DDTHH:mm:ssZ format |
type | 'Cron' | 'Daily' | 'Weekly' | 'Monthly' | Required | The type of the schedule plan |
interval | int | The time interval in minutes (1-5270400). Required when type is Cron | |
occurrence | ScheduleOccurrence | A date for triggering the job. Required when type is Monthly | |
recurrence | int | The monthly job repeat interval (1-12). Required when type is Monthly | |
times | string[] | A list of time slots in hh:mm format, at most 100 elements. Required when type is Daily, Weekly, or Monthly | |
weekdays | ('Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday')[] | A list of weekdays, at most 7 elements. Required when type is Weekly |
ScheduleOwner
| Property | Type | Attributes | Description |
|---|---|---|---|
id | string | Read-only | The principal's ID |
type | string | Read-only | The type of the principal |
ScheduleOccurrence
| Property | Type | Attributes | Description |
|---|---|---|---|
occurrenceType | 'DayOfMonth' | 'OrdinalWeekday' | Required | The day for triggering jobs |
dayOfMonth | int | The date to trigger the job (1-31). Required when occurrenceType is DayOfMonth | |
weekday | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday' | The weekday for triggering jobs. Required when occurrenceType is OrdinalWeekday | |
weekIndex | 'First' | 'Second' | 'Third' | 'Fourth' | 'Fifth' | The week of the month. Required when occurrenceType is OrdinalWeekday |