Movatterモバイル変換


[0]ホーム

URL:


Skip to main content

This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.

Download Microsoft EdgeMore info about Internet Explorer and Microsoft Edge
Table of contentsExit editor mode

Quickstart: Create and deploy function code to Azure using Visual Studio Code

Feedback

In this article

Use Visual Studio Code to create a function that responds to HTTP requests from a template. Use GitHub Copilot to improve the generated function code, verify code updates locally, and then deploy it to the serverless Flex Consumption hosting plan in Azure Functions.

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

Make sure to select your preferred development language at the top of the article.

Prerequisites

  • Node.js 18.x or above. Use thenode --version command to check your version.

Install or update Core Tools

The Azure Functions extension for Visual Studio Code integrates with Azure Functions Core Tools so that you can run and debug your functions locally in Visual Studio Code using the Azure Functions runtime. Before getting started, it's a good idea to install Core Tools locally or update an existing installation to use the latest version.

In Visual Studio Code, select F1 to open the command palette, and then search for and run the commandAzure Functions: Install or Update Core Tools.

This command tries to either start a package-based installation of the latest version of Core Tools or update an existing package-based installation. If you don't have npm or Homebrew installed on your local computer, you must insteadmanually install or update Core Tools.

Create your local project

In this section, you use Visual Studio Code to create a local Azure Functions project in your preferred language. Later in the article, you update, run, and then publish your function code to Azure.

  1. In Visual Studio Code, pressF1 to open the command palette and search for and run the commandAzure Functions: Create New Project....

  2. Choose the directory location for your project workspace and chooseSelect. You should either create a new folder or choose an empty folder for the project workspace. Don't choose a project folder that is already part of a workspace.

  3. Provide the following information at the prompts:

    PromptSelection
    Select a languageChooseC#.
    Select a .NET runtimeChoose.NET 8.0 LTS.
    Select a template for your project's first functionChooseHTTP trigger.
    Provide a function nameTypeHttpExample.
    Provide a namespaceTypeMy.Functions.
    Authorization levelChooseAnonymous, which enables anyone to call your function endpoint. For more information, seeAuthorization level.
    Select how you would like to open your projectChooseOpen in current window.
    PromptSelection
    Select a languageChooseJava.
    Select a version of JavaChooseJava 8,Java 11,Java 17 orJava 21, the Java version on which your functions run in Azure. Choose a Java version that you've verified locally.
    Provide a group IDChoosecom.function.
    Provide an artifact IDChoosemyFunction.
    Provide a versionChoose1.0-SNAPSHOT.
    Provide a package nameChoosecom.function.
    Provide an app nameChoosemyFunction-12345.
    Select a template for your project's first functionChooseHTTP trigger.
    Select the build tool for Java projectChooseMaven.
    Select how you would like to open your projectChooseOpen in current window.
    PromptSelection
    Select a languageChooseJavaScript.
    Select a JavaScript programming modelChooseModel V4.
    Select a template for your project's first functionChooseHTTP trigger.
    Provide a function nameTypeHttpExample.
    Authorization levelChooseAnonymous, which enables anyone to call your function endpoint. For more information, seeAuthorization level.
    Select how you would like to open your projectChooseOpen in current window.
    PromptSelection
    Select a languageChooseTypeScript.
    Select a JavaScript programming modelChooseModel V4.
    Select a template for your project's first functionChooseHTTP trigger.
    Provide a function nameTypeHttpExample.
    Authorization levelChooseAnonymous, which enables anyone to call your function endpoint. For more information, seeAuthorization level.
    Select how you would like to open your projectChooseOpen in current window.
    PromptSelection
    Select a languageChoosePython.
    Select a Python interpreter to create a virtual environmentChoose your preferred Python interpreter. If an option isn't shown, type in the full path to your Python binary.
    Select a template for your project's first functionChooseHTTP trigger.
    Name of the function you want to createEnterHttpExample.
    Authorization levelChooseANONYMOUS, which lets anyone call your function endpoint. For more information, seeAuthorization level.
    Select how you would like to open your projectChooseOpen in current window.
    PromptSelection
    Select a language for your function projectChoosePowerShell.
    Select a template for your project's first functionChooseHTTP trigger.
    Provide a function nameTypeHttpExample.
    Authorization levelChooseAnonymous, which enables anyone to call your function endpoint. For more information, seeAuthorization level.
    Select how you would like to open your projectChooseOpen in current window.

    Using this information, Visual Studio Code generates a code project for Azure Functions with an HTTP trigger function endpoint. You can view the local project files in the Explorer. To learn more about files that are created, seeGenerated project files.

  1. In the local.settings.json file, update theAzureWebJobsStorage setting as in the following example:

    "AzureWebJobsStorage": "UseDevelopmentStorage=true",

    This tells the local Functions host to use the storage emulator for the storage connection required by the Python v2 model. When you publish your project to Azure, this setting uses the default storage account instead. If you're using an Azure Storage account during local development, set your storage account connection string here.

Start the emulator

  1. In Visual Studio Code, pressF1 to open the command palette. In the command palette, search for and selectAzurite: Start.

  2. Check the bottom bar and verify that Azurite emulation services are running. If so, you can now run your function locally.

Run the function locally

Visual Studio Code integrates withAzure Functions Core tools to let you run this project on your local development computer before you publish to Azure.

  1. To start the function locally, pressF5 or theRun and Debug icon in the left-hand side Activity bar. TheTerminal panel displays the Output from Core Tools. Your app starts in theTerminal panel. You can see the URL endpoint of your HTTP-triggered function running locally.

    Screenshot of the Local function VS Code output.

    If you have trouble running on Windows, make sure that the default terminal for Visual Studio Code isn't set toWSL Bash.

  2. With Core Tools still running inTerminal, choose the Azure icon in the activity bar. In theWorkspace area, expandLocal Project >Functions. Right-click (Windows) orCtrl - click (macOS) the new function and chooseExecute Function Now....

    Execute function now from Visual Studio Code

  3. InEnter request body you see the request message body value of{ "name": "Azure" }. Press Enter to send this request message to your function.

  4. When the function executes locally and returns a response, a notification is raised in Visual Studio Code. Information about the function execution is shown inTerminal panel.

  5. With theTerminal panel focused, pressCtrl + C to stop Core Tools and disconnect the debugger.

After you verify that the function runs correctly on your local computer, you can optionally use AI tools, such as GitHub Copilot in Visual Studio Code, to update template-generated function code.

Use AI to normalize and validate input

This is an example prompt for Copilot Chat that updates the existing function code to retrieve parameters from either the query string or JSON body, apply formatting or type conversions, and return them as JSON in the response:

Modify the function to accept name, email, and age from the JSON body of therequest. If any of these parameters are missing from the query string, readthem from the JSON body. Return all three parameters in the JSON response, applying these rules:Title-case the nameLowercase the emailConvert age to an integer if possible, otherwise return "not provided"Use sensible defaults if any parameter is missingMake sure that any added packages are compatible with the version of the packages already in the project
Modify the function to accept name, email, and age from the JSON body of therequest. If any of these parameters are missing from the query string, readthem from the JSON body. Return all three parameters in the JSON response, applying these rules:Title-case the nameLowercase the emailConvert age to an integer if possible, otherwise return "not provided"Use sensible defaults if any parameter is missing
Modify the function to accept name, email, and age from the JSON body of therequest. If any of these parameters are missing from the query string, readthem from the JSON body. Return all three parameters in the JSON response, applying these rules:Title-case the nameLowercase the emailConvert age to an integer if possible, otherwise return "not provided"Use sensible defaults if any parameter is missingUpdate the FunctionTest.java file to test the new logic.

You can customize your prompt to add specifics as needed, then run the app again locally and verify that it works as expected after the code changes. This time, use a message body like:

{ "name": "devon torres", "email": "torres.devon@contoso.com", "age": "34" }

Tip

GitHub Copilot is powered by AI, so surprises and mistakes are possible. Should you encounter any errors during execution, paste the error message in the chat window, selectAgent mode, and ask Copilot to help resolve the error. For more information, seeCopilot FAQs.

When running inAgent mode, the results of this customization depend on the specific tools available to your agent.

When you are satisfied with your app, you can use Visual Studio Code to publish the project directly to Azure.

Sign in to Azure

Before you can create Azure resources or publish your app, you must sign in to Azure.

  1. If you aren't already signed in, in theActivity bar, select the Azure icon. Then underResources, selectSign in to Azure.

    Screenshot of the sign in to Azure window in Visual Studio Code.

    If you're already signed in and can see your existing subscriptions, go to the next section. If you don't yet have an Azure account, selectCreate an Azure Account. Students can selectCreate an Azure for Students Account.

  2. When you are prompted in the browser, select your Azure account and sign in by using your Azure account credentials. If you create a new account, you can sign in after your account is created.

  3. After you successfully sign in, you can close the new browser window. The subscriptions that belong to your Azure account are displayed in the side bar.

Create the function app in Azure

In this section, you create a function app in the Flex Consumption plan along with related resources in your Azure subscription. Many of the resource creation decisions are made for you based on default behaviors. For more control over the created resources, you must insteadcreate your function app with advanced options.

  1. In Visual Studio Code, select F1 to open the command palette. At the prompt (>), enter and then selectAzure Functions: Create Function App in Azure.

  2. At the prompts, provide the following information:

    PromptAction
    Select subscriptionSelect the Azure subscription to use. The prompt doesn't appear when you have only one subscription visible underResources.
    Enter a new function app nameEnter a globally unique name that's valid in a URL path. The name you enter is validated to make sure that it's unique in Azure Functions.
    Select a location for new resourcesSelect an Azure region. For better performance, select aregion near you. Only regions supported by Flex Consumption plans are displayed.
    Select a runtime stackSelect the language version you currently run locally.
    Select resource authentication typeSelectManaged identity, which is the most secure option for connecting to thedefault host storage account.

    In theAzure: Activity Log panel, the Azure extension shows the status of individual resources as they're created in Azure.

    Screenshot that shows the log of Azure resource creation.

  3. When the function app is created, the following related resources are created in your Azure subscription. The resources are named based on the name you entered for your function app.

    • Aresource group, which is a logical container for related resources.
    • A function app, which provides the environment for executing your function code. A function app lets you group functions as a logical unit for easier management, deployment, and sharing of resources within the same hosting plan.
    • An Azure App Service plan, which defines the underlying host for your function app.
    • A standardAzure Storage account, which is used by the Functions host to maintain state and other information about your function app.
    • An Application Insights instance that's connected to the function app, and which tracks the use of your functions in the app.
    • A user-assigned managed identity that's added to theStorage Blob Data Contributor role in the new default host storage account.

    A notification is displayed after your function app is created and the deployment package is applied.

    Tip

    By default, the Azure resources required by your function app are created based on the name you enter for your function app. By default, the resources are created with the function app in the same, new resource group. If you want to customize the names of the associated resources or reuse existing resources,publish the project with advanced create options.

Deploy the project to Azure

Important

Deploying to an existing function app always overwrites the contents of that app in Azure.

  1. In the command palette, enter and then selectAzure Functions: Deploy to Function App.

  2. Select the function app you just created. When prompted about overwriting previous deployments, selectDeploy to deploy your function code to the new function app resource.

  3. When deployment is completed, selectView Output to view the creation and deployment results, including the Azure resources that you created. If you miss the notification, select the bell icon in the lower-right corner to see it again.

    Screenshot of the View Output window.

Run the function in Azure

  1. PressF1 to display the command palette, then search for and run the commandAzure Functions:Execute Function Now.... If prompted, select your subscription.

  2. Select your new function app resource andHttpExample as your function.

  3. InEnter request body type{ "name": "Contoso", "email": "me@contoso.com", "age": "34" }, then press Enter to send this request message to your function.

  4. When the function executes in Azure, the response is displayed in the notification area. Expand the notification to review the full response.

Troubleshooting

Use the following table to resolve the most common issues encountered when using this article.

ProblemSolution
Can't create a local function project?Make sure you have theAzure Functions extension installed.
Can't run the function locally?Make sure you have the latest version ofAzure Functions Core Tools installed installed.
When running on Windows, make sure that the default terminal shell for Visual Studio Code isn't set to WSL Bash.
Can't deploy function to Azure?Review the Output for error information. The bell icon in the lower right corner is another way to view the output. Did you publish to an existing function app? That action overwrites the content of that app in Azure.
Couldn't run the cloud-based Function app?Remember to use the query string to send in parameters.

Clean up resources

When you continue to thenext step and add an Azure Storage queue binding to your function, you'll need to keep all your resources in place to build on what you've already done.

Otherwise, you can use the following steps to delete the function app and its related resources to avoid incurring any further costs.

  1. In Visual Studio Code, select the Azure icon to open the Azure explorer.
  2. In the Resource Groups section, find your resource group.
  3. Right-click the resource group and selectDelete.

To learn more about Functions costs, seeEstimating Consumption plan costs.

Next steps

You have usedVisual Studio Code to create a function app with a simple HTTP-triggered function. In the next articles, you expand that function by connecting to either Azure Cosmos DB or Azure Storage. To learn more about connecting to other Azure services, seeAdd bindings to an existing function in Azure Functions. If you want to learn more about security, seeSecuring Azure Functions.


Feedback

Was this page helpful?

YesNoNo

Need help with this topic?

Want to try using Ask Learn to clarify or guide you through this topic?

Suggest a fix?

  • Last updated on

In this article

Was this page helpful?

YesNo
NoNeed help with this topic?

Want to try using Ask Learn to clarify or guide you through this topic?

Suggest a fix?