TimerDurableClientOptions interface

タイマーによってトリガーされる Durable Client 関数のオプションを構成します。

Extends

Omit<TimerFunctionOptions, "handler">

プロパティ

handler

継承されたプロパティ

extraInputs

呼び出し中にオプションのセカンダリ入力セットの構成を行い、context.extraInputs.get() を使用してこれらの値を取得します

extraOutputs

呼び出し中にオプションのセカンダリ出力セットの構成を行う場合は、これらの値を context.extraOutputs.set()

retry

成功した完了または再試行の最大数に達するまで、失敗した実行を再実行するオプションの再試行ポリシー。 詳細 については、こちらを参照してください。

return

関数のオプションのプライマリ出力の構成 これは、呼び出し時に関数ハンドラーの戻り値として設定する必要があるメイン出力です。

runOnStartup

true の場合、関数はランタイムの開始時に呼び出されます。 たとえば、ランタイムは、非アクティブのためアイドル状態になった後、関数アプリが関数の変更によって再起動されたとき、関数アプリがスケールアウトされたときに、関数アプリが起動したときに起動します。注意して使用. runOnStartup は、特に運用環境で、trueに設定されることはほとんどありません。

schedule

スケジュールを指定する形式 '{second} {minute} {hour} {day} {month} {day} {day}' の cron 式

trigger
useMonitor

true の場合、スケジュールは保持され、再起動しても正しいスケジュールを維持できます。 間隔が >= 1 分のスケジュールの場合、既定値は true です

プロパティの詳細

handler

handler: TimerDurableClientHandler

プロパティ値

継承されたプロパティの詳細

extraInputs

呼び出し中にオプションのセカンダリ入力セットの構成を行い、context.extraInputs.get() を使用してこれらの値を取得します

extraInputs?: FunctionInput[]

プロパティ値

継承元 Omit.extra入力

extraOutputs

呼び出し中にオプションのセカンダリ出力セットの構成を行う場合は、これらの値を context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

プロパティ値

継承元 Omit.extraOutputs を省略します

retry

成功した完了または再試行の最大数に達するまで、失敗した実行を再実行するオプションの再試行ポリシー。 詳細 については、こちらを参照してください。

retry?: RetryOptions

プロパティ値

継承元 省略.再試行

return

関数のオプションのプライマリ出力の構成 これは、呼び出し時に関数ハンドラーの戻り値として設定する必要があるメイン出力です。

return?: FunctionOutput

プロパティ値

継承元 省略.戻り

runOnStartup

true の場合、関数はランタイムの開始時に呼び出されます。 たとえば、ランタイムは、非アクティブのためアイドル状態になった後、関数アプリが関数の変更によって再起動されたとき、関数アプリがスケールアウトされたときに、関数アプリが起動したときに起動します。注意して使用. runOnStartup は、特に運用環境で、trueに設定されることはほとんどありません。

runOnStartup?: boolean

プロパティ値

boolean

継承元 Omit.runOnStartup

schedule

スケジュールを指定する形式 '{second} {minute} {hour} {day} {month} {day} {day}' の cron 式

schedule: string

プロパティ値

string

継承元 省略スケジュール

trigger

trigger?: TimerTrigger

プロパティ値

継承元 省略.trigger

useMonitor

true の場合、スケジュールは保持され、再起動しても正しいスケジュールを維持できます。 間隔が >= 1 分のスケジュールの場合、既定値は true です

useMonitor?: boolean

プロパティ値

boolean

継承元 Omit.useモニター