Develop Azure Functions using Visual Studio

Visual Studio lets you develop, test, and deploy C# class library functions to Azure. If this experience is your first with Azure Functions, see An introduction to Azure Functions.

This article provides details about how to use Visual Studio to develop C# class library functions and publish them to Azure. There are two models for developing C# class library functions: the Isolated worker model and the In-process model.

Unless otherwise noted, procedures and examples shown are for Visual Studio 2022. For more information about Visual Studio 2022 releases, see the release notes or the preview release notes.

Prerequisites

• Visual Studio 2022, including the Azure development workload.

• Other resources that you need, such as an Azure Storage account, are created in your subscription during the publishing process.

• If you don't have an Azure subscription, create a trial account before you begin.

Create an Azure Functions project

The Azure Functions project template in Visual Studio creates a C# class library project that you can publish to a function app in Azure. You can use a function app to group functions as a logical unit for easier management, deployment, scaling, and sharing of resources.

1. From the Visual Studio menu, select File > New > Project.

2. In Create a new project, enter functions in the search box, choose the Azure Functions template, and then select Next.

3. In Configure your new project, enter a Project name for your project, and then select Create. The function app name must be valid as a C# namespace, so don't use underscores, hyphens, or any other nonalphanumeric characters.

4. For the Create a new Azure Functions application settings, use the values in the following table:

   Setting	Value	Description
   .NET version	.NET 6 Isolated	This value creates a function project that runs in an isolated worker process. Isolated worker process supports other non-LTS version of .NET and also .NET Framework. For more information, see Azure Functions runtime versions overview.
   Function template	HTTP trigger	This value creates a function triggered by an HTTP request.
   Storage account (AzureWebJobsStorage)	Storage emulator	Because a function app in Azure requires a storage account, one is assigned or created when you publish your project to Azure. An HTTP trigger doesn't use an Azure Storage account connection string; all other trigger types require a valid Azure Storage account connection string.
   Authorization level	Anonymous	The created function can be triggered by any client without providing a key. This authorization setting makes it easy to test your new function. For more information, see Authorization level.

   

   Setting	Value	Description
   .NET version	.NET 6	This value creates a function project that runs in-process with version 4.x of the Azure Functions runtime. For more information, see Azure Functions runtime versions overview.
   Function template	HTTP trigger	This value creates a function triggered by an HTTP request.
   Storage account (AzureWebJobsStorage)	Storage emulator	Because a function app in Azure requires a storage account, one is assigned or created when you publish your project to Azure. An HTTP trigger doesn't use an Azure Storage account connection string; all other trigger types require a valid Azure Storage account connection string.
   Authorization level	Anonymous	The created function can be triggered by any client without providing a key. This authorization setting makes it easy to test your new function. For more information, see Authorization level.

   

   Make sure you set the Authorization level to Anonymous. If you choose the default level of Function, you're required to present the function key in requests to access your function endpoint.

5. Select Create to create the function project and HTTP trigger function.

The new project has the following files:

• host.json: Lets you configure the Functions host. These settings apply both when running locally and in Azure. For more information, see host.json reference.

• local.settings.json: Maintains settings used when running functions locally. These settings aren't used when running in Azure. For more information, see Local settings file.

  Important

  Because the local.settings.json file can contain secrets, you must exclude it from your project source control. Make sure the Copy to Output Directory setting for this file is set to Copy if newer.

Local settings

When running in a function app in Azure, settings required by your functions are stored securely in app settings. During local development, these settings are instead added to the Values object in the local.settings.json file. The local.settings.json file also stores settings used by local development tools.

Because the local.settings.json may contain secrets, such as connection strings, you should never store it in a remote repository. To learn more about local settings, see Local settings file.

Visual Studio doesn't automatically upload the settings in local.settings.json when you publish the project. To make sure that these settings also exist in your function app in Azure, upload them after you publish your project. For more information, see Function app settings. The values in a ConnectionStrings collection are never published.

Your code can also read the function app settings values as environment variables. For more information, see Environment variables.

Configure the project for local development

The Functions runtime uses an Azure Storage account internally. For all trigger types other than HTTP and webhooks, set the Values.AzureWebJobsStorage key to a valid Azure Storage account connection string. Your function app can also use the Azurite emulator for the AzureWebJobsStorage connection setting required by the project. To use the emulator, set the value of AzureWebJobsStorage to UseDevelopmentStorage=true. Change this setting to an actual storage account connection string before deployment. For more information, see Local storage emulator.

To set the storage account connection string:

1. In the Azure portal, navigate to your storage account.

2. In the Access keys tab, below Security + networking, copy the Connection string of key1.

3. In your project, open the local.settings.json file and set the value of the AzureWebJobsStorage key to the connection string you copied.

4. Repeat the previous step to add unique keys to the Values array for any other connections required by your functions.

Add a function to your project

In C# class library functions, the bindings used by the function are defined by applying attributes in the code. When you create your function triggers from the provided templates, the trigger attributes are applied for you.

1. In Solution Explorer, right-click your project node and select Add > New Azure Function.

2. Enter a Name for the class, and then select Add.

3. Choose your trigger, set the required binding properties, and then select Add. The following example shows the settings for creating a Queue storage trigger function.

   

   For an Azure Storage service trigger, check the Configure connection box and you're prompted to choose between using an Azurite storage emulator or referencing a provisioned Azure storage account. Select Next and if you choose a storage account, Visual Studio tries to connect to your Azure account and get the connection string. Choose Save connection string value in Local user secrets file and then Finish to create the trigger class.

   This trigger example uses an application setting for the storage connection with a key named QueueStorage. This key, stored in the local.settings.json file, either references the Azurite emulator or an Azure storage account.

4. Examine the newly added class. For example, the following C# class represents a basic Queue storage trigger function:

   You see a static Run() method attributed with Function. This attribute indicates that the method is the entry point for the function.

using System;
using Azure.Storage.Queues.Models;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Logging;

namespace Company.Function
{
    public class QueueTriggerCSharp
    {
        private readonly ILogger<QueueTriggerCSharp> _logger;

        public QueueTriggerCSharp(ILogger<QueueTriggerCSharp> logger)
        {
            _logger = logger;
        }

        [Function(nameof(QueueTriggerCSharp))]
        public void Run([QueueTrigger("PathValue", Connection = "ConnectionValue")] QueueMessage message)
        {
            _logger.LogInformation($"C# Queue trigger function processed: {message.MessageText}");
        }
    }
}

::: zone-end

using System;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;

namespace Company.Function
{
    public class QueueTriggerCSharp
    {
        [FunctionName("QueueTriggerCSharp")]
        public void Run([QueueTrigger("PathValue", Connection = "ConnectionValue")]string myQueueItem, ILogger log)
        {
            log.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
        }
    }
}

A binding-specific attribute is applied to each binding parameter supplied to the entry point method. The attribute takes the binding information as parameters. In the previous example, the first parameter has a QueueTrigger attribute applied, indicating a Queue storage trigger function. The queue name and connection string setting name are passed as parameters to the QueueTrigger attribute. For more information, see Azure Queue storage bindings for Azure Functions.

Use the above procedure to add more functions to your function app project. Each function in the project can have a different trigger, but a function must have exactly one trigger. For more information, see Azure Functions triggers and bindings concepts.

Add bindings

As with triggers, input and output bindings are added to your function as binding attributes. Add bindings to a function as follows:

1. Make sure you configure the project for local development.

2. Add the appropriate NuGet extension package for the specific binding by finding the binding-specific NuGet package requirements in the reference article for the binding. For example, find package requirements for the Event Hubs trigger in the Event Hubs binding reference article.

3. Use the following command in the Package Manager Console to install a specific package:

   Install-Package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE> -Version <TARGET_VERSION>
   

   Install-Package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE> -Version <TARGET_VERSION>
   

   In this example, replace <BINDING_TYPE> with the name specific to the binding extension and <TARGET_VERSION> with a specific version of the package, such as 4.0.0. Valid versions are listed on the individual package pages at NuGet.org.

4. If there are app settings that the binding needs, add them to the Values collection in the local setting file.

   The function uses these values when it runs locally. When the function runs in the function app in Azure, it uses the function app settings. Visual Studio makes it easy to publish local settings to Azure.

5. Add the appropriate binding attribute to the method signature. In the following example, a queue message triggers the function, and the output binding creates a new queue message with the same text in a different queue.

    public class QueueTrigger
   {
       private readonly ILogger _logger;
   
       public QueueTrigger(ILoggerFactory loggerFactory)
       {
           _logger = loggerFactory.CreateLogger<QueueTrigger>();
       }
   
       [Function("CopyQueueMessage")]
       [QueueOutput("myqueue-items-destination", Connection = "QueueStorage")]
       public string Run([QueueTrigger("myqueue-items-source", Connection = "QueueStorage")] string myQueueItem)
       {
           _logger.LogInformation($"C# Queue trigger function processed: {myQueueItem}");
           return myQueueItem;
       }
   }
   

   The QueueOutput attribute defines the binding on the method. For multiple output bindings, you would instead place this attribute on a string property of the returned object. For more information, see Multiple output bindings.

   public static class SimpleExampleWithOutput
   {
       [FunctionName("CopyQueueMessage")]
       public static void Run(
           [QueueTrigger("myqueue-items-source", Connection = "QueueStorage")] string myQueueItem, 
           [Queue("myqueue-items-destination", Connection = "QueueStorage")] out string myQueueItemCopy,
           ILogger log)
       {
           log.LogInformation($"CopyQueueMessage function processed: {myQueueItem}");
           myQueueItemCopy = myQueueItem;
       }
   }
   

   The Queue attribute on the out parameter defines the output binding.

   The connection to Queue storage is obtained from the QueueStorage setting. For more information, see the reference article for the specific binding.

For a full list of the bindings supported by Functions, see Supported bindings.

Run functions locally

Azure Functions Core Tools lets you run Azure Functions project on your local development computer. When you press F5 to debug a Functions project, the local Functions host (func.exe) starts to listen on a local port (usually 7071). Any callable function endpoints are written to the output, and you can use these endpoints for testing your functions. For more information, see Work with Azure Functions Core Tools. You're prompted to install these tools the first time you start a function from Visual Studio.

To start your function in Visual Studio in debug mode:

1. Press F5. If prompted, accept the request from Visual Studio to download and install Azure Functions Core (CLI) tools. You might also need to enable a firewall exception so that the tools can handle HTTP requests.

2. With the project running, test your code as you would test a deployed function.

   When you run Visual Studio in debug mode, breakpoints are hit as expected.

For a more detailed testing scenario using Visual Studio, see Testing functions.

Publish to Azure

When you publish your functions project to Azure, Visual Studio uses zip deployment to deploy the project files. When possible, you should also select Run-From-Package so that the project runs in the deployment (.zip) package. For more information, see Run your functions from a package file in Azure.

Don't deploy to Azure Functions using Web Deploy (msdeploy).

Use the following steps to publish your project to a function app in Azure.

1. In Solution Explorer, right-click the project and select Publish. In Target, select Azure then Next.

   

2. Select Azure Function App (Windows) for the Specific target, which creates a function app that runs on Windows, and then select Next.

   

3. In the Function Instance, choose Create a new Azure Function...

   

4. Create a new instance using the values specified in the following table:

   Setting	Value	Description
   Name	Globally unique name	Name that uniquely identifies your new function app. Accept this name or enter a new name. Valid characters are: a-z, 0-9, and -.
   Subscription	Your subscription	The Azure subscription to use. Accept this subscription or select a new one from the drop-down list.
   Resource group	Name of your resource group	The resource group in which you want to create your function app. Select an existing resource group from the drop-down list or select New to create a new resource group.
   Plan Type	Consumption	When you publish your project to a function app that runs in a Consumption plan, you pay only for executions of your functions app. Other hosting plans incur higher costs.
   Location	Location of the app service	Choose a Location in a region near you or other services your functions access.
   Azure Storage	General-purpose storage account	An Azure storage account is required by the Functions runtime. Select New to configure a general-purpose storage account. You can also choose an existing account that meets the storage account requirements.

   

5. Select Create to create a function app and its related resources in Azure. The status of resource creation is shown in the lower-left of the window.

6. In the Functions instance, make sure that the Run from package file is checked. Your function app is deployed using Zip Deploy with Run-From-Package mode enabled. Zip Deploy is the recommended deployment method for your functions project resulting in better performance.

   

7. Select Finish, and on the Publish page, select Publish to deploy the package containing your project files to your new function app in Azure.

   After the deployment completes, the root URL of the function app in Azure is shown in the Publish tab.

8. In the Publish tab, in the Hosting section, choose Open in Azure portal. This opens the new function app Azure resource in the Azure portal.

   

Function app settings

Visual Studio doesn't upload these settings automatically when you publish the project. Any settings you add in the local.settings.json you must also add to the function app in Azure.

The easiest way to upload the required settings to your function app in Azure is to expand the three dots next to the Hosting section and select the Manage Azure App Service settings link that appears after you successfully publish your project.

Selecting this link displays the Application settings dialog for the function app, where you can add new application settings or modify existing ones.

Local displays a setting value in the local.settings.json file, and Remote displays a current setting value in the function app in Azure. Choose Add setting to create a new app setting. Use the Insert value from Local link to copy a setting value to the Remote field. Pending changes are written to the local settings file and the function app when you select OK.

You can also manage application settings in one of these other ways:

• Use the Azure portal.
• Use the --publish-local-settings publish option in the Azure Functions Core Tools.
• Use the Azure CLI.

Remote Debugging

To debug your function app remotely, you must publish a debug configuration of your project. You also need to enable remote debugging in your function app in Azure.

This section assumes you've already published to your function app using a release configuration.

Remote debugging considerations

• Remote debugging isn't recommended on a production service.
• If you have Just My Code debugging enabled, disable it.
• Avoid long stops at breakpoints when remote debugging. Azure treats a process that is stopped for longer than a few minutes as an unresponsive process, and shuts it down.
• While you're debugging, the server is sending data to Visual Studio, which could affect bandwidth charges. For information about bandwidth rates, see Azure Pricing.
• Remote debugging is automatically disabled in your function app after 48 hours. After 48 hours, you'll need to reenable remote debugging.

Attach the debugger

The way you attach the debugger depends on your execution mode. When debugging an isolated worker process app, you currently need to attach the remote debugger to a separate .NET process, and several other configuration steps are required.

When you're done, you should disable remote debugging.

Disable remote debugging

After you're done remote debugging your code, you should disable remote debugging in the Azure portal. Remote debugging is automatically disabled after 48 hours, in case you forget.

1. In the Publish tab in your project, select the ellipses (...) in the Hosting section, and choose Open in Azure portal. This action opens the function app in the Azure portal to which your project is deployed.

2. In the functions app, select Configuration under settings, choose General Settings, set Remote Debugging to Off, and select Save then Continue.

After the function app restarts, you can no longer remotely connect to your remote processes. You can use this same tab in the Azure portal to enable remote debugging outside of Visual Studio.

Monitoring functions

The recommended way to monitor the execution of your functions is by integrating your function app with Azure Application Insights. You should enable this integration when you create your function app during Visual Studio publishing.

If for some reason the integration wasn't done during publishing, you should still enable Application Insights integration for your function app in Azure.

To learn more about monitoring using Application Insights, see Monitor Azure Functions.

Next steps

For more information about the Azure Functions Core Tools, see Work with Azure Functions Core Tools.