Using Flask Framework with Azure Functions

Code Sample
08/07/2024

Azure Functions supports WSGI and ASGI-compatible frameworks with HTTP-triggered Python functions. This can be helpful if you are familiar with a particular framework, or if you have existing code you would like to reuse to create the Function app. The following is an example of creating an Azure Function app using Flask.

Prerequisites

Here are some of the prerequisites to get this sample to work for you.

Install Python

A Python version that is supported by Azure Functions is required. Run python --version (Linux/MacOS) or py --version (Windows) to check your Python version reports to a supported version. For more information on installing Python, see How to install Python.

Install Azure Functions Core Tools

Azure Functions Core Tools provides commands to create functions, connect to Azure, and deploy function projects. For more information, see Install Azure Functions Core Tools.

Create a new Azure Function App in VS Code

To create an Azure Function app in VSCode, please go through the Microsoft Docs tutorial on creating your first Azure Function using Visual Studio Code. In the code snippet along with the sample, we name the two python module 'FlaskApp' and 'HandleApproach' with the HTTP trigger.

Setup

Clone or download this sample repository, and open the sample folder in Visual Studio Code or your IDE of choice.

Flask Framework in an Azure Function App

The file requirements.txt is updated to include the following depdendencies.

azure-functions
Flask

Note that azure-functions-worker should not be included in this file as the Python worker is manager by Azure Functions platform and manually managing it may cause unexpected issues.

The following code shows the use of WsgiMiddleware, which redirects the invocations to Flask handler.

import azure.functions as func
from FlaskApp import app

def main(req: func.HttpRequest, context: func.Context) -> func.HttpResponse:
    """Each request is redirected to the WSGI handler.
    """
    return func.WsgiMiddleware(app.wsgi_app).handle(req, context)

The file function.json is modified to include route in the HTTP trigger.

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ],
      "route": "{*route}"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    }
  ]
}

The file host.json is updated to include the HTTP routePrefix.

{
  "version": "2.0",
  "extensions": {
    "http": {
        "routePrefix": ""
    }
  }
}

Running the sample

Testing locally

To run Function Apps using Core Tools, see Run functions locally with Core Tools.

To test locally, run the below to install Flask.

pip install -r requirements.txt

Then, start debug mode and test the function using the HTTP endpoint exposed after the host and the worker load up the function.

Http Functions:
HandleApproach: [GET,POST] http://localhost:7071/<route>

Testing in Azure

You can publish the function app directly from VSCode using the “Publish to Azure option” in the Azure extension. For more information, please refer the guide to publish the project to Azure using Visual Studio Code.

You can use one of these HTTP test tools to see the API in action locally, and on Azure:

Caution

For scenarios where you have sensitive data, such as credentials, secrets, access tokens, API keys, and other similar information, make sure to use a tool that protects your data with the necessary security features, works offline or locally, doesn't sync your data to the cloud, and doesn't require that you sign in to an online account. This way, you reduce the risk around exposing sensitive data to the public.

Running locally helps you to verify the credentials, configuration and business logic.

Calling the URL with Path Parameters

When running this sample, you can try a different URL route as well as parameterize it. For instance, http://<HOST>:7071/hello/Foo to call the Flask app with path param Foo. Another option is have the route as module to provide import guidance, which can be done through changing the url to http://<HOST>:7071/module.

When done locally, please try the following URL in your browser -

http://localhost:7071/hello/Foo

When done in Azure, please try the following URL in your browser -

http://<FunctionAppName>.azurewebsites.net/hello/Foo

Conclusion and Next Steps

This sample helps you setup an app with the Flask framework and can help you get started using web frameworks in Azure Functions.

To learn more about altering Python functions to leverage WSGI and ASGI-compatible frameworks, see Web frameworks.

通过