Schedule interface

Package:

azure-devops-extension-api

Properties

branchFilters
daysToBuild	Days for a build (flags enum for days of the week)
scheduleJobId	The Job Id of the Scheduled job that will queue the scheduled build. Since a single trigger can have multiple schedules and we want a single job to process a single schedule (since each schedule has a list of branches to build), the schedule itself needs to define the Job Id. This value will be filled in when a definition is added or updated. The UI does not provide it or use it.
scheduleOnlyWithChanges	Flag to determine if this schedule should only build if the associated source has been changed.
startHours	Local timezone hour to start
startMinutes	Local timezone minute to start
timeZoneId	Time zone of the build schedule (String representation of the time zone ID)

Property Details

branchFilters

branchFilters: string[]

Property Value

string[]

daysToBuild

Days for a build (flags enum for days of the week)

daysToBuild: ScheduleDays

Property Value

ScheduleDays

scheduleJobId

The Job Id of the Scheduled job that will queue the scheduled build. Since a single trigger can have multiple schedules and we want a single job to process a single schedule (since each schedule has a list of branches to build), the schedule itself needs to define the Job Id. This value will be filled in when a definition is added or updated. The UI does not provide it or use it.

scheduleJobId: string

Property Value

string

scheduleOnlyWithChanges

Flag to determine if this schedule should only build if the associated source has been changed.

scheduleOnlyWithChanges: boolean

Property Value

boolean

startHours

Local timezone hour to start

startHours: number

Property Value

number

startMinutes

Local timezone minute to start

startMinutes: number

Property Value

number

timeZoneId

Time zone of the build schedule (String representation of the time zone ID)

timeZoneId: string

Property Value

string