TimerFunctionOptions interface

Package:

@azure/functions

Extends

TimerTriggerOptions,Partial<FunctionOptions>

Properties

handler
retry	An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more here
trigger

Inherited Properties

extraInputs	Configuration for an optional set of secondary inputs During invocation, get these values with context.extraInputs.get()
extraOutputs	Configuration for an optional set of secondary outputs During invocation, set these values with context.extraOutputs.set()
return	Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation
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

handler

handler: TimerHandler

Property Value

TimerHandler

retry

An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more here

retry?: RetryOptions

Property Value

RetryOptions

trigger

trigger?: TimerTrigger

Property Value

TimerTrigger

Inherited Property Details

extraInputs

Configuration for an optional set of secondary inputs During invocation, get these values with context.extraInputs.get()

extraInputs?: FunctionInput[]

Property Value

FunctionInput[]

Inherited From Partial.extraInputs

extraOutputs

Configuration for an optional set of secondary outputs During invocation, set these values with context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Property Value

FunctionOutput[]

Inherited From Partial.extraOutputs

return

Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation

return?: FunctionOutput

Property Value

FunctionOutput

Inherited From Partial.return

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

Inherited From TimerTriggerOptions.runOnStartup

schedule

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

schedule: string

Property Value

string

Inherited From TimerTriggerOptions.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

useMonitor?: boolean

Property Value

boolean

Inherited From TimerTriggerOptions.useMonitor