Azure Function Time Trigger Tutorial and Example

If you're new to Azure Functions, a time trigger is a type of trigger that allows your function to run at a specified time or interval.

Azure Functions can be triggered by a time schedule, which is defined in the function's configuration. This schedule can be set to run once, daily, weekly, or monthly, depending on your needs.

To create a time trigger in Azure Functions, you'll need to use the `TimerTrigger` attribute in C# or the `@schedule` property in JavaScript. This attribute specifies the time at which the function should run.

Azure Functions also supports a `Schedule` property that allows you to specify a schedule for your function to run. This can be useful if you need to run your function at a specific time every day or week.

For another approach, see: Azure Ad Token Expiration Time

You can manually run a timer-triggered function, but for now, let's focus on the basics.

A timer trigger in Azure Functions lets you run a function on a schedule, which is specified using a CRON expression.

You might like: Azure Function Timer Trigger

To create a timer trigger function, you'll need to sign in to your Microsoft Azure account with the subscription to the resource group and storage account.

You can sign in to your Azure account by pressing Ctrl + Shift + P to open the Command Palette in VS Code, starting to type Azure Sign in, and selecting the option.

When creating a new project, select C# as the programming language and continue selecting the options as you create the project, including .NET runtime, template, and create new timer trigger.

A CRON expression is a string that consists of six or seven fields separated by whitespace, representing a time schedule.

Here's a breakdown of the CRON expression fields:

After creating the timer trigger function, you'll need to select a storage account for debugging and internal use, and you can emulate a local instance or select an existing storage account.

Once you've selected a storage account, you can deploy the function to Azure by right-clicking on the project in the Explorer pane and selecting "Deploy to Function App".

Explore further: Azure Logic App Blob Storage Trigger

When working with Azure Function time triggers, you have two options: CRON expressions and TimeSpan values.

A CRON expression is a string that consists of six or seven fields separated by whitespace, specifying the schedule on which the function should be triggered.

You can use a TimeSpan value to specify the time interval between each function invocation, which is different from a CRON expression.

Here are some examples of TimeSpan values: "01:00:00" is triggered every hour, "00:01:00" is triggered every minute, "25:00:00:00" is triggered every 25 days, and "1.00:00:00" is triggered every day.

Time Span is a unique way to specify the time interval between each function invocation. Unlike a NCRONTAB expression, it doesn't rely on a specific schedule, but rather on a timer that triggers the function again after a certain period.

The TimeSpan format is expressed as a string, which can be either hh:mm:ss or dd:hh:mm, depending on the value. If the first two digits are less than 24, the format is hh:mm:ss.

Here are some examples of TimeSpan formats:

The timer will invoke the function again immediately when it completes after running longer than the specified interval, which makes it a great option for tasks that need to be repeated at regular intervals.

Unlike the queue trigger, the timer trigger doesn't retry after a function fails. It simply isn't called again until the next time on the schedule.

A TimeSpan value specifies the time interval between each function invocation in Azure Functions, and it's expressed as a string in the format hh:mm:ss or dd:hh:mm.

A CRON expression is used to specify the schedule for a timer trigger function, and it's a string that consists of six or seven fields separated by whitespace.

The TimeSpan format is used to specify the time interval between function invocations, and it can be used only for a function app that runs on an App Service Plan.

Here are some examples of TimeSpan values:

In Azure, timer trigger functions use a CRON expression to specify when they should be triggered. A CRON expression is a string that consists of six or seven fields separated by whitespace, representing a time schedule.

You can put the schedule expression in an app setting and set this property to the app setting name wrapped in % signs, as %ScheduleAppSetting%. This allows you to decouple the schedule from the function code.

To specify the schedule for a timer trigger function, you need to enter a CRON expression. This is done in the configuration step for your timer trigger function.

Here are the details of the Schedule attribute property:

A timer trigger is a powerful tool in Azure Functions that allows you to run a function on a schedule. You can use a CRON expression or a TimeSpan value to specify the schedule.

To set up a timer trigger, you can use the Timer Trigger template in your project. In this template, you can specify the schedule using a CRON expression or a TimeSpan value. For example, you can use the CRON expression "0 10 * * * *" to run a function every day at 10:00 AM.

You can also use a TimeSpan value to specify the schedule. For example, you can use the TimeSpan value "01:00:00" to run a function every hour. If the function runs longer than the specified interval, the timer will immediately invoke the function again.

If you want to run a function on a specific time zone, you can set the WEBSITE_TIME_ZONE app setting to the name of the desired time zone. For example, you can set it to "Eastern Standard Time" to run a function in Eastern Time.

Here are some examples of CRON expressions and TimeSpan values that you can use to specify the schedule:

You can also use the Timer Trigger attribute to specify the schedule. This attribute has properties such as Schedule, RunOnStartup, and UseMonitor that you can use to configure the timer trigger. For example, you can set the Schedule property to a CRON expression or a TimeSpan value to specify the schedule.

It's worth noting that you can manually invoke a timer trigger using an HTTP webhook. This can be useful in scenarios such as integration testing, slot swaps, and initial deployment of a function.

Azure Functions uses the NCrontab library to interpret NCRONTAB expressions, which are similar to CRON expressions but include an additional sixth field for time precision in seconds.

To use a time zone other than Coordinated Universal Time (UTC) with your CRON expression, create an app setting for your function app named WEBSITE_TIME_ZONE. The value of this setting depends on the operating system and plan on which your function app runs.

You can set the WEBSITE_TIME_ZONE setting to the name of the desired time zone as given by the second line from each pair given by the Windows command tzutil.exe /L, or to the name of the desired time zone as shown in the tz database for Linux.

Here are some examples of NCRONTAB expressions you can use for the timer trigger in Azure Functions:

Note that the numbers in a NCRONTAB expression refer to a time and date, not a time span.

A fresh viewpoint: Time Series Database Azure

Using NCRONTAB time zones can be a bit tricky, but it's essential to get it right. The default time zone used with CRON expressions is Coordinated Universal Time (UTC).

To change this, you'll need to create an app setting for your function app named WEBSITE_TIME_ZONE. This setting depends on the operating system and plan on which your function app runs.

For Windows, you can set the value to the name of the desired time zone as given by the second line from each pair given by the Windows command tzutil.exe /L. For Linux, you can set the value to the name of the desired time zone as shown in the tz database.

Here's a breakdown of the different operating systems and plans:

Note that WEBSITE_TIME_ZONE and TZ are not currently supported when running on Linux in a Consumption plan, so be aware of this limitation.

Azure Functions uses the NCronTab library to interpret NCRONTAB expressions. An NCRONTAB expression is similar to a CRON expression except that it includes an additional sixth field at the beginning to use for time precision in seconds: {second} {minute} {hour} {day} {month} {day-of-week}.

Each field can have one of the following types of values: a specific value, all values (*), a range (- operator), a set of values (, operator), or an interval value (/ operator).

A specific value is used to trigger the function at a specific time, such as 0 5 * * * * to trigger every hour at minute 5. All values (*) trigger the function at every possible time, such as 0 * * * * *.

A range (- operator) is used to trigger the function within a range of values, such as 5-7 * * * * * to trigger at seconds 5 through 7 during every minute of every hour of each day. A set of values (, operator) is used to trigger the function at specific values, such as 5,8,10 * * * * *.

An interval value (/ operator) is used to trigger the function at intervals, such as 0 */5 * * * * to trigger at every 5th minute of every hour of each day.

NCRONTAB expression supports both five field and six field format. The sixth field position is a value for seconds which is placed at the beginning of the expression.

Expand your knowledge: Azure Just in Time Access

Here's an example of how to use NCRONTAB expressions:

Note that the numbers in a NCRONTAB expression refer to a time and date, not a time span. For example, a 5 in the hour field refers to 5:00 AM, not every 5 hours.

To create a Function App in Azure, head to the search bar, type in Function App, and select it. Click create and fill in the details, selecting the same subscription and resource group as before. We will be using .NET 6 and deploying to the same region we were using before.

The next step is to select the storage account that was just created in the previous step. This will be used for hosting and storing data. You can also select the Plan type as Consumption (Serverless) for a cost-effective option.

To create the timer trigger function, you need to create a new project in VS Code. Open the Azure tab, sign in to your Microsoft Azure account, and create a new project. Select C# as the .NET runtime and create a new timer trigger function with a suitable name and CRON expression.

Consider reading: Azure Function .net 8

Here are the steps to create an Azure timer trigger function in a concise format:

Once you have created the timer trigger function, you can deploy it to Azure by right-clicking on the project in the Explorer pane and selecting “Deploy to Function App”.

Readers also liked: Azure Pipeline Deploy Function App

To create a Function, you'll need to install the Azure tools extension in VS Code and sign in to your Microsoft Azure account. This will allow you to access the Azure tab in the left-hand navigation.

You'll then need to select Create new project and choose a location to store the project locally. VS Code will guide you through creating the Function locally, where you'll select C# as the language and .NET runtime.

When creating the project, you'll need to select Create New Timer Trigger as the template, and enter a Cron expression to specify the schedule. This is done using a CRON expression, which consists of six or seven fields separated by whitespace.

Suggestion: Azure Function C

You'll also need to select a storage account for debugging and internal use, either by emulating a local instance or selecting an existing storage account. Make sure to choose the subscription under which you created the storage account.

Here's a summary of the steps:

Once you've created the project, you may need to install additional dependencies, such as the Microsoft.Azure.WebJobs package. This can be done using the dotnet add package command in the terminal.

After creating the Function, you can deploy it to Azure by right-clicking on the project in the Explorer pane and selecting Deploy to Function App. This will guide you through the process of creating a new Function App in Azure and deploying your function to it.

When your function app scales out to multiple instances, it can be a game-changer for handling increased traffic and workload. Only a single instance of a timer-triggered function is run across all instances.

This means that if there's an outstanding invocation still running, the function won't trigger again until it's completed. This is to prevent duplicate or overlapping work, which can lead to errors and inconsistencies.

If you're scaling out to handle a sudden surge in requests, you can rest assured that your timer-triggered functions will only run once across all instances, even if multiple instances are handling the workload. This ensures that your function app remains efficient and reliable.

Azure functions are a powerful tool for automating tasks, and the timer trigger is one of the most useful features. The timer trigger can be set to execute every five minutes, as seen in the C# example where the function starts at 18:55:00 and the next execution is at 19:00:00.

The timer trigger can be defined using the @TimerTrigger annotation, which uses the same string format as CRON expressions. This allows for a high degree of flexibility and precision in scheduling tasks.

In Python, the timer trigger can be implemented using the azure.functions.TimerRequest object, which is passed to the function. The function can then use this object to determine whether it was triggered by a missed schedule occurrence.

The timer trigger can also be used in TypeScript and JavaScript functions, as seen in the examples provided. These examples show how to implement the timer trigger in different programming languages and frameworks.

The timer trigger is a powerful tool for automating tasks in Azure functions, and it can be used to execute tasks at precise intervals. By using the @TimerTrigger annotation or the azure.functions.TimerRequest object, developers can create complex scheduling tasks with ease.