TimerTriggerOptions interface

Package:

@azure/functions

Properties

runOnStartup	If true, the function is invoked when the runtime starts. For example, the runtime starts when the function app wakes up after going idle due to inactivity, when the function app restarts due to function changes, and when the function app scales out. Use with caution. runOnStartup should rarely if ever be set to true, especially in production.
schedule	A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule
useMonitor	When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute

Property Details

runOnStartup

If true, the function is invoked when the runtime starts. For example, the runtime starts when the function app wakes up after going idle due to inactivity, when the function app restarts due to function changes, and when the function app scales out. Use with caution. runOnStartup should rarely if ever be set to true, especially in production.

runOnStartup?: boolean

Property Value

boolean

schedule

A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule

schedule: string

Property Value

string

useMonitor

When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute

useMonitor?: boolean

Property Value

boolean