Skip to main content

ItemJobScheduler

Properties

PropertyTypeAttributesDescription
configurationScheduleConfigurationRequiredThe schedule configuration
enabledboolRequiredWhether this schedule is enabled
itemIdstringRequired, IdentifierThe item ID
jobTypestringRequired, IdentifierThe job type. Allowed job types per item type: dataflow: {ApplyChanges, Execute}; datapipeline: {Execute}; lakehouse: {RefreshMaterializedLakeViews}
workspaceIdstringRequired, IdentifierThe Workspace ID
createdDateTimestringRead-onlyThe created time stamp of this schedule in UTC, using the YYYY-MM-DDTHH:mm:ssZ format
idstringRead-only, IdentifierThe Item Job Scheduler ID
ownerScheduleOwnerRead-onlyThe user identity that created this schedule or last modified it

ScheduleConfiguration

PropertyTypeAttributesDescription
endDateTimestringRequiredThe end time for this schedule, in UTC using the YYYY-MM-DDTHH:mm:ssZ format. Must be later than startDateTime
startDateTimestringRequiredThe start time for this schedule, in UTC using the YYYY-MM-DDTHH:mm:ssZ format
type'Cron' | 'Daily' | 'Weekly' | 'Monthly'RequiredThe type of the schedule plan
intervalintThe time interval in minutes (1-5270400). Required when type is Cron
occurrenceScheduleOccurrenceA date for triggering the job. Required when type is Monthly
recurrenceintThe monthly job repeat interval (1-12). Required when type is Monthly
timesstring[]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

PropertyTypeAttributesDescription
idstringRead-onlyThe principal's ID
typestringRead-onlyThe type of the principal

ScheduleOccurrence

PropertyTypeAttributesDescription
occurrenceType'DayOfMonth' | 'OrdinalWeekday'RequiredThe day for triggering jobs
dayOfMonthintThe 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