Skip to main content

ScheduleInfo

Properties

NameTypeDescriptionNotes
ScheduleTaskIdInt64The unique identifier for the scheduled task.[optional]
ScheduleTaskNameStringThe display name of the scheduled task.[optional]
TaskTypeNameStringThe type or category of the scheduled task.[optional]
IntervalInt32The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions.[optional]
ScheduleTypeStringThe scheduling type, such as ""Daily"", ""Weekly"", or ""Manual"" etc.[optional]
ActiveBooleanIndicates whether the scheduled task is currently active.[optional] [default to $false]
StartTimeInt64The start time for the scheduled task, represented as epoch seconds.[optional]
EndTimeInt64The end time for the scheduled task, represented as epoch seconds.[optional]
DaysOfWeek[]StringA list of days of the week when the task should run (e.g., ""Monday"", ""Wednesday"").[optional]
RunAfterScheduleTaskIdInt64The ID of another scheduled task that triggers this scheduled task upon its completion.[optional]
RunAfterScheduleTaskNameStringThe name of the scheduled task that must complete before this task runs.[optional]
ApplicationIdInt64The unique identifier of the application associated with the scheduled task.[optional]
CreatedByDisplayNameStringThe display name of the user who created the scheduled task.[optional]
NextRunInt64The next scheduled run time for the task, represented as epoch seconds.[optional]
LastRunInt64The last run time of the task, represented as epoch seconds.[optional]

Examples

  • Prepare the resource
$ScheduleInfo = Initialize-V2025ScheduleInfo  -ScheduleTaskId 1001 `
-ScheduleTaskName Daily Data Sync `
-TaskTypeName DataSync `
-Interval 1440 `
-ScheduleType Daily `
-Active true `
-StartTime 1762237200 `
-EndTime 1762240800 `
-DaysOfWeek [Monday, Wednesday, Friday] `
-RunAfterScheduleTaskId 1000 `
-RunAfterScheduleTaskName Pre-Sync Task `
-ApplicationId 2001 `
-CreatedByDisplayName Jane Doe `
-NextRun 1762323600 `
-LastRun 1762237200
  • Convert the resource to JSON
$ScheduleInfo | ConvertTo-JSON

[Back to top]