Create your first function using Visual Studio Code
Azure Functions lets you execute your code in a serverless environment without having to first create a VM or publish a web application.
In this article, you learn how to use the Azure Functions extension for Visual Studio Code to create and test a "hello world" function on your local computer using Microsoft Visual Studio Code. You then publish the function code to Azure from Visual Studio Code.
To complete this quickstart:
Install version 2.x of the Azure Functions Core Tools, which is still in preview.
Install the specific requirements for your chosen language:
Language Extension C# C# for Visual Studio Code
.NET Core CLI tools*
Java Debugger for Java
* Also required by Core Tools.
Install the Azure Function extension
The Azure Functions extension is used to create, test, and deploy functions to Azure.
In Visual Studio Code, open Extensions and search for
azure functions, or open this link in Visual Studio Code.
Select Install to install the extension to Visual Studio Code.
Restart Visual Studio Code and select the Azure icon on the Activity bar. You should see an Azure Functions area in the Side Bar.
Create an Azure Functions project
The Azure Functions project template in Visual Studio Code creates a project that can be published to a function app in Azure. A function app lets you group functions as a logical unit for management, deployment, and sharing of resources.
In Visual Studio Code, select the Azure logo to display the Azure: Functions area, and then select the Create New Project icon.
Choose a location for your project workspace and choose Select.
This article was designed to be completed outside of a workspace. In this case, do not select a project folder that is part of a workspace.
Select a template for the first function for your project. Provide a name for your function.
When prompted, choose Add to workspace.
Visual Studio Code creates the function app project in a new workspace. This project contains the host.json and local.settings.json configuration files, plus any language-specific project files. You also get a new Git repository in the project folder.
Create an HTTP triggered function
From Azure: Functions, choose the Create Function icon.
Select the folder with your function app project and select the HTTP trigger function template.
HTTPTriggerfor the function name and press Enter, then select Anonymous authentication.
A function is created in your chosen language using the template for an HTTP-triggered function.
You can add input and output bindings to your function by modifying the function.json file. For more information, see Azure Functions triggers and bindings concepts.
Now that you've created your function project and an HTTP-triggered function, you can test it on your local computer.
Test the function locally
Azure Functions Core Tools lets you run an Azure Functions project on your local development computer. You're prompted to install these tools the first time you start a function from Visual Studio Code.
To test your function, set a breakpoint in the function code and press F5 to start the function app project. Output from Core Tools is displayed in the Terminal panel.
In the Terminal panel, copy the URL endpoint of your HTTP-triggered function.
Paste the URL for the HTTP request into your browser's address bar. Append the query string
?name=<yourname>to this URL and execute the request. Execution is paused when the breakpoint is hit.
When you continue the execution, the following shows the response in the browser to the GET request:
To stop debugging, press Shift + F5.
After you've verified that the function runs correctly on your local computer, it's time to publish the project to Azure.
Sign in to Azure
Before you can publish your app, you must sign in to Azure.
In the Azure: Functions area, choose Sign in to Azure.... If you don't already have one, you can Create a free Azure account.
When prompted, select Copy & Open, or copy the displayed code and open https://aka.ms/devicelogin in your browser.
Paste the copied code in the Device Login page, verify the sign in for Visual Studio Code, then select Continue.
Complete the sign in using your Azure account credentials. After you have successfully signed in, you can close the browser.
Publish the project to Azure
Visual Studio Code lets you publish your functions project directly to Azure. In the process, you create a function app and related resources in your Azure subscription. The function app provides an execution context for your functions. The project is packaged and deployed to the new function app in your Azure subscription.
This article assumes that you are creating a new function app.
Publishing to an existing function app overwrites the content of that app in Azure.
In the Azure: Functions area, select the Deploy to Function App icon.
If not signed-in, you are prompted to Sign in to Azure. You can also Create a free Azure account. After successful sign in from the browser, go back to Visual Studio Code.
If you have multiple subscriptions, Select a subscription for the function app, then choose + Create New Function App in Azure.
Type a globally unique name that identifies your function app and press Enter. Valid characters for a function app name are
Choose + Create New Resource Group, type a resource group name, like
myResourceGroup, and press enter. You can also use an existing resource group.
Choose + Create New Storage Account, type a globally unique name of the new storage account used by your function app and press Enter. Storage account names must be between 3 and 24 characters in length and may contain numbers and lowercase letters only. You can also use an existing account.
Choose a location in a region near you or near other services your functions access.
When you press Enter, the following Azure resources are created in your subscription:
- Resource group: Contains all of the created Azure resources. The name is based on your function app name.
- Storage account: A standard Storage account is created with a unique name that is based on your function app name.
- Hosting plan: A consumption plan is created in the West US region to host your serverless function app.
- Function app: Your project is deployed to and runs in this new function app.
A notification is displayed after your function app is created and the deployment package is applied. Select View Output in this notification to view the creation and deployment results, including the Azure resources that you created.
Back in the Azure: Functions area, expand the new function app under your subscription. Expand Functions, right-click HttpTrigger, and then choose Copy function URL.
Test your function in Azure
Copy the URL of the HTTP trigger from the Output panel. As before, make sure to add the query string
?name=<yourname>to the end of this URL and execute the request.
The URL that calls your HTTP-triggered function should be in the following format:
Paste this new URL for the HTTP request into your browser's address bar. The following shows the response in the browser to the remote GET request returned by the function:
You have used Visual Studio Code to create a function app with a simple HTTP-triggered function. You may also want to learn more about local testing and debugging from the Terminal or command prompt using the Azure Functions Core Tools.
Send feedback about: