Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is the simplest way to run a timer-triggered Azure Function locally once?

I have a few C# Azure Functions that run on a schedule using timer triggers. I've set them up like so, where %TimerSchedule% refers to a cron expression in the app settings:

public static void Run([TimerTrigger("%TimerSchedule%")]TimerInfo myTimer, TraceWriter log) 

During development, I often want to run the functions locally using Azure Functions Tools for Visual Studio + Azure Functions Core Tools. But when I hit F5 to debug the function locally it (usually) doesn't run immediately. Instead, it starts waiting for the next occurrence as per the timer schedule. So for example, if my cron expression says to run daily at 8PM, I'd have to wait until 8PM for the function to actually run on my machine.

So my question is: What is the simplest and best way to make a function run once locally?

Things I have tried or considered:

  1. Use a more frequent timer schedule just for local development
    • This is OK but not perfect – you still have to wait a little bit unless it's very frequent, and if it's very frequent then the function might run multiple times. This is what I'm doing now.
  2. Write a console app or unit test that directly calls the function's Run() method
    • This isn't 100% straightforward because you have to provide TimerInfo and TraceWriter arguments to Run() – and I've found surprisingly little documentation for that.

Microsoft's Strategies for testing your code in Azure Functions page is not very helpful on this topic – it only mentions timer triggers as a way to test other trigger types.

In a perfect world, I'd hit F5 and the function would immediately run once – just like developing a "normal" .NET app.

like image 836
Reilly Wood Avatar asked Oct 04 '17 03:10

Reilly Wood


People also ask

How do I trigger a timer trigger Azure function manually?

Navigate to your function app in the Azure portal, select App Keys, and then the _master key. In the Edit key section, copy the key value to your clipboard, and then select OK. After copying the _master key, select Code + Test, and then select Logs.

How do you run a timer trigger Azure function locally in Visual Studio 2019?

Go to the Azure icon in the Activity bar. Under Local Project , find the function you want to run, right click, and select "Execute Function Now".

How do I call Azure function locally?

Copy the settings file to the root of the Functions project next to the DLL, open a command prompt from there, and run “func start.” The Function will run based off the same trigger it would use if hosted in Azure or it can be manually triggered for testing using a local HTTP endpoint.


1 Answers

I had the same question, and used the DEBUG-flag to have the RunOnStartup only while debugging:

        public static void Run(             [TimerTrigger("* 0 7 * * 1-5" #if DEBUG             , RunOnStartup=true #endif             )]TimerInfo myTimer, TraceWriter log)         { 
like image 93
BerDev Avatar answered Sep 28 '22 03:09

BerDev