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 focus mode

Quickstart: Create a function in Azure with Python using Visual Studio Code

  • Article
  • 2024-09-10
Feedback

In this article

In this article, you use Visual Studio Code to create a Python function that responds to HTTP requests. After testing the code locally, you deploy it to the serverless environment of Azure Functions.

This article uses the Python v2 programming model for Azure Functions, which provides a decorator-based approach for creating functions. To learn more about the Python v2 programming model, see theDeveloper Reference Guide

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

There's also aCLI-based version of this article.

This video shows you how to create a Python function in Azure using Visual Studio Code.

The steps in the video are also described in the following sections.

Configure your environment

Before you begin, make sure that you have the following requirements in place:

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 Python. Later in this article, you 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 languageChoosePython (Programming Model V2).
    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.
  4. Visual Studio Code uses the provided information and generates an Azure Functions project with an HTTP trigger. You can view the local project files in the Explorer. The generatedfunction_app.py project file contains your functions.

  5. 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, it's time to 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 and 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 globally unique name for the function appEnter a name that is valid in a URL path. The name you enter is validated to make sure that it's unique in Azure Functions.
    Select a runtime stackSelect the language version you currently run locally.
    Select a location for new resourcesSelect an Azure region. For better performance, select aregion near you.

    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 standardAzure Storage account, which maintains state and other information about your projects.
    • 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.
    • An Application Insights instance that's connected to the function app, and which tracks the use of your functions in the app.

    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": "Azure" }, 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.

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, pressF1 to open the command palette. In the command palette, search for and selectAzure: Open in portal.

  2. Choose your function app and pressEnter. The function app page opens in the Azure portal.

  3. In theOverview tab, select the named link next toResource group.

    Screenshot of select the resource group to delete from the function app page.

  4. On theResource group page, review the list of included resources, and verify that they're the ones you want to delete.

  5. SelectDelete resource group, and follow the instructions.

    Deletion may take a couple of minutes. When it's done, a notification appears for a few seconds. You can also select the bell icon at the top of the page to view the notification.

For more information about Functions costs, seeEstimating Consumption plan costs.

Next steps

You created and deployed a function app with a simple HTTP-triggered function. In the next articles, you expand that function by connecting to a storage service in Azure. To learn more about connecting to other Azure services, seeAdd bindings to an existing function in Azure Functions.

Having issues? Let us know.


Feedback

Was this page helpful?

YesNo

In this article