Is there a way to easily only allow a subset of azure functions to run when debugging locally in Visual Studio?

Question

I'm using Visual Studio to write a class library which contains several Azure functions. There is a combination of timer and queue triggered functions. If I'm working on one of the functions and want to debug only it I have to comment out the other functions to keep them also from executing. Is there a way to easily indicate that I only want a subset of the entire set of functions to execute when debugging locally?

score 4 · Answer 1 · answered Dec 21 '17 at 02:30

4

You can configure which functions to load in your host.json (full spec here.) Specifically, you'll want to define a top-level functions property:

{
    "functions": [ "QueueProcessor", "GitHubWebHook" ]
}

(Note this is only meant for local use; you'll want to use the function.json disabled property for published functions.)

answered Dec 21 '17 at 02:30

Katy Shimizu

1,051
5
9

This should be the selected answer! – Greg Sep 17 '18 at 20:33

score 2 · Accepted Answer · answered Dec 20 '17 at 16:50

2

You could make use of the Disable() attribute, however, that's not much better than commenting out code:

public static void Run([TimerTrigger("0 */5 * * * *"), Disable()]TimerInfo myTimer, TraceWriter log)

You could combine the Disable() attribute with #if directive, but it clutters up your code. The Disable() attribute will only be applied if DEBUG is defined.

The following function will run if in release mode, and is disabled if in debug mode.

    [FunctionName("TimerFunction")]
    public static void Run([
        #if DEBUG 
            TimerTrigger("*/5 * * * * *"), Disable()
        #else
            TimerTrigger("*/5 * * * * *")
        #endif
        ]TimerInfo myTimer, TraceWriter log)
    {
        log.Info($"C# Timer trigger function executed at: {DateTime.Now}");
    }

answered Dec 20 '17 at 16:50

Andy T

10,223
5
53
95

2

Looks like you can also add it to the FunctionName attribute which seems a bit cleaner than to the attributes decorating the function parameters. [FunctionName("TimerFunction"), Disable()] – Scott Chamberlin Dec 22 '17 at 14:54
doesnt that disable is ALL the time, not just release mode? – Alex Gordon Sep 27 '20 at 11:04
You can just do this: #if DEBUG [Disable()] #endif – Tony Basallo Oct 25 '21 at 16:03

score 0 · Answer 3 · answered Dec 20 '17 at 16:53

0

You can decorate your function with a DisableAttribute controlled by a settingName from the local.settings.json file.

The following is an example:

[QueueTrigger("%queueName%", Connection = "queues"), Disable("MyFuncABC")]ProcessMessage msg,

answered Dec 20 '17 at 16:53

Roman Kiss

7,925
1
8
21

Is there a way to easily only allow a subset of azure functions to run when debugging locally in Visual Studio?

3 Answers3