Skip to content

Latest commit

 

History

History
163 lines (97 loc) · 12.5 KB

functions-create-your-first-function-visual-studio.md

File metadata and controls

163 lines (97 loc) · 12.5 KB
title description ms.assetid ms.topic ms.date ms.devlang ms.custom adobe-target adobe-target-activity adobe-target-experience adobe-target-content
Quickstart: Create your first C# function in Azure using Visual Studio
In this quickstart, you learn how to use Visual Studio to create and publish a C# HTTP triggered function to Azure Functions.
82db1177-2295-4e39-bd42-763f6082e796
quickstart
11/08/2022
csharp
devx-track-csharp, mvc, devcenter, vs-azure, 23113853-34f2-4f, contperf-fy21q3-portal, mode-ui
true
DocsExp–386541–A/B–Enhanced-Readability-Quickstarts–2.19.2021
Experience B
./functions-create-your-first-function-visual-studio-uiex

Quickstart: Create your first C# function in Azure using Visual Studio

Azure Functions lets you use Visual Studio to create local C# function projects and then easily publish this project to run in a scalable serverless environment in Azure. If you prefer to develop your C# apps locally using Visual Studio Code, you should instead consider the Visual Studio Code-based version of this article.

By default, this article shows you how to create C# functions that run on .NET 6 in the same process as the Functions host. These in-process C# functions are only supported on Long Term Support (LTS) .NET versions, such as .NET 6. When creating your project, you can choose to instead create a function that runs on .NET 6 in an isolated worker process. Isolated worker process supports both LTS and Standard Term Support (STS) versions of .NET. For more information, see Supported versions in the .NET Functions isolated worker process guide.

In this article, you learn how to:

[!div class="checklist"]

  • Use Visual Studio to create a C# class library project.
  • Create a function that responds to HTTP requests.
  • Run your code locally to verify function behavior.
  • Deploy your code project to Azure Functions.

Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Prerequisites

Create a function app 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 Additional information settings, use the values in the following table:

    In-process

    Setting Value Description
    Functions worker .NET 6 When you choose .NET 6, you create a project that runs in-process with the Azure Functions runtime. Use in-process unless you need to run your function app on .NET 7.0 or on .NET Framework 4.8 (preview). To learn more, see Supported versions.
    Function HTTP trigger This value creates a function triggered by an HTTP request.
    Use Azurite for runtime storage account (AzureWebJobsStorage) Enable 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. When you select this option, the Azurite emulator is used.
    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 about keys and authorization, see Authorization keys and HTTP and webhook bindings.

    :::image type="content" source="../../includes/media/functions-vs-tools-create/functions-project-settings-v4.png" alt-text="Screenshot of Azure Functions project settings.":::

    Isolated process

    Setting Value Description
    Functions worker .NET 6 Isolated When you choose .NET 6 Isolated, you create a project that runs in a separate worker process. Choose isolated worker process when you need to run your function app on .NET 7.0 or on .NET Framework 4.8 (preview). To learn more, see Supported versions.
    Function HTTP trigger This value creates a function triggered by an HTTP request.
    Use Azurite for runtime storage account (AzureWebJobsStorage) Enable 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. When you select this option, the Azurite emulator is used.
    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 about keys and authorization, see Authorization keys and HTTP and webhook bindings.

    :::image type="content" source="../../includes/media/functions-vs-tools-create/functions-project-settings-v4-isolated.png" alt-text="Screenshot of Azure Functions project settings.":::

    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.

Visual Studio creates a project and class that contains boilerplate code for the HTTP trigger function type. The boilerplate code sends an HTTP response that includes a value from the request body or query string. The HttpTrigger attribute specifies that the function is triggered by an HTTP request.

Rename the function

The FunctionName method attribute sets the name of the function, which by default is generated as Function1. Since the tooling doesn't let you override the default function name when you create your project, take a minute to create a better name for the function class, file, and metadata.

  1. In File Explorer, right-click the Function1.cs file and rename it to HttpExample.cs.

  2. In the code, rename the Function1 class to HttpExample.

  3. In the HttpTrigger method named Run, rename the FunctionName method attribute to HttpExample.

Your function definition should now look like the following code:

In-process

:::code language="csharp" source="~/functions-docs-csharp/http-trigger-template/HttpExample.cs" range="15-18":::

Isolated process

:::code language="csharp" source="~/functions-docs-csharp/http-trigger-isolated/HttpExample.cs" range="11-13":::

Now that you've renamed the function, you can test it on your local computer.

Run the function locally

Visual Studio integrates with Azure Functions Core Tools so that you can test your functions locally using the full Azure Functions runtime.

[!INCLUDE functions-run-function-test-local-vs]

After you've verified that the function runs correctly on your local computer, it's time to publish the project to Azure.

Publish the project to Azure

Visual Studio can publish your local project to Azure. Before you can publish your project, you must have a function app in your Azure subscription. If you don't already have a function app in Azure, Visual Studio publishing creates one for you the first time you publish your project. In this article, you create a function app and related Azure resources.

[!INCLUDE Publish the project to Azure]

Verify your function in Azure

  1. In Cloud Explorer, your new function app should be selected. If not, expand your subscription > App Services, and select your new function app.

  2. Right-click the function app and choose Open in Browser. This opens the root of your function app in your default web browser and displays the page that indicates your function app is running.

    :::image type="content" source="media/functions-create-your-first-function-visual-studio/function-app-running-azure-v4.png" alt-text="Function app running":::

  3. In the address bar in the browser, append the string /api/HttpExample?name=Functions to the base URL and run the request.

    The URL that calls your HTTP trigger function is in the following format:

    http://<APP_NAME>.azurewebsites.net/api/HttpExample?name=Functions

  4. Go to this URL and you see a response in the browser to the remote GET request returned by the function, which looks like the following example:

    :::image type="content" source="media/functions-create-your-first-function-visual-studio/functions-create-your-first-function-visual-studio-browser-azure.png" alt-text="Function response in the browser":::

Clean up resources

Resources in Azure refer to function apps, functions, storage accounts, and so forth. They're grouped into resource groups, and you can delete everything in a group by deleting the group.

You created Azure resources to complete this quickstart. You may be billed for these resources, depending on your account status and service pricing. Other quickstarts in this collection build upon this quickstart. If you plan to work with subsequent quickstarts, tutorials, or with any of the services you've created in this quickstart, don't clean up the resources.

[!INCLUDE functions-vstools-cleanup]

Next steps

In this quickstart, you used Visual Studio to create and publish a C# function app in Azure with a simple HTTP trigger function.

In-process

To learn more about working with C# functions that run in-process with the Functions host, see Develop C# class library functions using Azure Functions.

Advance to the next article to learn how to add an Azure Storage queue binding to your function:

[!div class="nextstepaction"] Add an Azure Storage queue binding to your function

Isolated process

To learn more about working with C# functions that run in an isolated worker process, see the Guide for running C# Azure Functions in an isolated worker process. Check out .NET supported versions to see other versions of supported .NET versions in an isolated worker process.

Advance to the next article to learn how to add an Azure Storage queue binding to your function:

[!div class="nextstepaction"] Add an Azure Storage queue binding to your function