快速入门：在 Azure 中通过命令行创建 Python 函数

  • 项目

在本文中，你将使用命令行工具创建响应 HTTP 请求的 Python 函数。 在本地测试代码后，将代码部署到 Azure Functions 的无服务器环境。

本文介绍 Azure Functions 支持的两种 Python 编程模型。 使用顶部的选择器选择编程模型。

注意

v2 编程模型提供了基于装饰器的方法来创建函数。 若要详细了解 Python v2 编程模型，请参阅开发人员参考指南。

完成本快速入门会从你的 Azure 帐户中扣取最多几美分的费用。

本文还提供了基于 Visual Studio 代码的版本。

配置本地环境

在开始之前，必须满足以下要求：

  • Azurite 存储模拟器。 虽然也可以使用实际的 Azure 存储帐户，但本文假定你使用的是此模拟器。

重要

Functions 目前不支持 ARM64 设备上的 Python 函数开发。 若要在具有 M1 芯片的 Mac 上开发 Python 函数，必须在仿真的 x86 环境中运行。 若要了解详细信息，请参阅 ARM64 上的 x86 仿真。

安装 Azure Functions Core Tools

建议的 Core Tools 安装方法取决于本地开发计算机的操作系统。

以下步骤使用 Windows 安装程序 (MSI) 安装 Core Tools v4.x。 若要详细了解其他基于包的安装程序，请参阅 Core Tools 自述文件。

基于Windows 版本下载并运行 Core Tools 安装程序：

如果之前使用 Windows 安装程序 (MSI) 在 Windows 上安装 Core Tools，则应在安装最新版本之前从“添加/移除程序”中卸载旧版本。

创建并激活虚拟环境

在适当的文件夹中，运行以下命令以创建并激活一个名为 .venv 的虚拟环境。 请务必使用 Azure Functions 支持的 Python 3.9、3.8 或 3.7。

python -m venv .venv

source .venv/bin/activate

如果 Python 未在 Linux 分发版中安装 venv 包，请运行以下命令：

sudo apt-get install python3-venv

所有后续命令将在这个已激活的虚拟环境中运行。

创建本地函数

在 Azure Functions 中，有一个函数项目是一个或多个单独函数（每个函数响应特定的触发器）的容器。 项目中的所有函数共享相同的本地和宿主配置。

在本部分，你将创建包含单个函数的函数项目。

  1. 按如下所示运行 func init 命令，在名为 LocalFunctionProj 的文件夹中创建使用指定运行时的函数项目。

    func init LocalFunctionProj --python

  2. 转到项目文件夹。

    cd LocalFunctionProj

    此文件夹包含项目的各个文件，其中包括名为 local.settings.json 和 host.json 的配置文件。 由于 local.settings.json 可以包含从 Azure 下载的机密，因此，默认情况下，该文件会从 .gitignore 文件的源代码管理中排除。

  3. 使用以下命令将一个函数添加到项目，其中，--name 参数是该函数 (HttpExample) 的唯一名称，--template 参数指定该函数的触发器 (HTTP)。

    func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"

    func new 创建一个与函数名称匹配的、包含项目所选语言适用的代码文件的子文件夹，以及一个名为 function.json 的配置文件。

在本部分中，将创建一个函数项目并添加 HTTP 触发的函数。

  1. 运行 func init 命令（如下所示），在名为 LocalFunctionProj 的文件夹中创建使用指定运行时和指定编程模型版本的函数项目。

    func init LocalFunctionProj --python -m V2

  2. 转到项目文件夹。

    cd LocalFunctionProj

    此文件夹包含项目的各个文件，其中包括名为 local.settings.json 和 host.json 的配置文件。 由于 local.settings.json 可以包含从 Azure 下载的机密，因此，默认情况下，该文件会从 .gitignore 文件的源代码管理中排除。

  3. function_app.py 文件可以包含项目中的所有函数。 打开此文件，将现有内容替换为以下代码，从而添加名为 HttpExample 的 HTTP 触发的函数：

    import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="HttpExample")
@app.route(route="hello")
def test_function(req: func.HttpRequest) -> func.HttpResponse:
    return func.HttpResponse("HttpExample function processed a request!")

  4. 打开 local.settings.json 项目文件，并确认 AzureWebJobsFeatureFlags 设置的值为 EnableWorkerIndexing。 这是 Functions 将项目正确解释为 Python v2 模型所必需的。 将项目发布到 Azure 后，将此相同的设置添加到应用程序设置。

  5. 在 local.settings.json 文件中，更新 AzureWebJobsStorage 设置，如以下示例所示：

    "AzureWebJobsStorage": "UseDevelopmentStorage=true",

    这会告知本地 Functions 主机将存储模拟器用于 Python v2 模型当前所需的存储连接。 将项目发布到 Azure 时，需要改用默认存储帐户。 如果改用 Azure 存储帐户，请在此处设置存储帐户连接字符串。

启动存储模拟器

默认情况下，本地开发使用 Azurite 存储模拟器。 当 local.settings.json 项目文件中的 AzureWebJobsStorage 设置设为 UseDevelopmentStorage=true 时，将使用此模拟器。 使用模拟器时，必须在运行函数之前启动本地 Azurite 存储模拟器。

如果 local.settings.json 中的 AzureWebJobsStorage 设置已设为 Azure 存储帐户的连接字符串，而不是 UseDevelopmentStorage=true，则可以跳过此步骤。

使用以下命令启动 Azurite 存储模拟器：

azurite

有关详细信息，请参阅运行 Azurite

在本地运行函数

  1. 通过从 LocalFunctionProj 文件夹启动本地 Azure Functions 运行时主机来运行函数。

    func start

    在输出的末尾，必须要显示以下行：

    Screenshot of terminal window output when running function locally.

    注意

    如果 HttpExample 未按如上所示出现，则可能是在项目的根文件夹外启动了主机。 在这种情况下，请按 Ctrl+C 停止主机，转至项目的根文件夹，然后重新运行上一命令。

  2. 将此输出中的 HTTP 函数的 URL 复制到浏览器，并追加查询字符串 ?name=<YOUR_NAME>，使完整 URL 类似于 http://localhost:7071/api/HttpExample?name=Functions。 浏览器应显示回显查询字符串值的响应消息。 当你发出请求时，启动项目时所在的终端还会显示日志输出。

  3. 完成后，按 Ctrl + C 并键入 y 以停止函数主机。

创建函数的支持性 Azure 资源

在将函数代码部署到 Azure 之前，需要创建三个资源：

  • 一个资源组：相关资源的逻辑容器。
  • 一个存储帐户：维护有关项目的状态和其他信息。
  • 一个函数应用：提供用于执行函数代码的环境。 函数应用映射到本地函数项目，可让你将函数分组为一个逻辑单元，以便更轻松地管理、部署和共享资源。

使用以下命令创建这些项。 支持 Azure CLI 和 PowerShell。

  1. 请登录到 Azure（如果尚未这样做）。

    az login

    使用 az login 命令登录到 Azure 帐户。

  2. 在所选区域中创建名为 AzureFunctionsQuickstart-rg 的资源组。

    az group create --name AzureFunctionsQuickstart-rg --location <REGION>

    az group create 命令可创建资源组。 在上述命令中，使用从 <REGION> 命令返回的可用区域代码，将 <REGION> 替换为附近的区域。

    注意

    不能在同一资源组中托管 Linux 和 Windows 应用。 如果名为 AzureFunctionsQuickstart-rg 的现有资源组有 Windows 函数应用或 Web 应用，必须使用其他资源组。

  3. 在资源组和区域中创建常规用途存储帐户。

    az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS

    az storage account create 命令可创建存储帐户。

    在上一个示例中，将 <STORAGE_NAME> 替换为适合你且在 Azure 存储中唯一的名称。 名称只能包含 3 到 24 个数字和小写字母字符。 Standard_LRS 指定 Functions 支持的常规用途帐户。

    在本快速入门中使用的存储帐户只会产生几美分的费用。

  4. 在 Azure 中创建函数应用。

    az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location chinanorth2 --runtime python --runtime-version 3.9 --functions-version 4 --name <APP_NAME> --os-type linux --storage-account <STORAGE_NAME>

    az functionapp create 命令可在 Azure 中创建函数应用。 如果使用的是 Python 3.9、3.8 或 3.7，请将 --runtime-version 分别更改为 3.9、3.8 或 3.7。 你必须提供 --os-type linux，因为 Python 函数无法在 Windows 上运行，这是默认设置。

    在上一个示例中，将 <APP_NAME> 替换为适合自己的全局唯一名称。 <APP_NAME> 也是函数应用的默认 DNS 域。

    此命令将创建一个函数应用，该应用在 Azure Functions 消耗计划下指定的语言运行时中运行，根据本教程产生的用量，此操作是免费的。 该命令还会在同一资源组中创建关联的 Azure Application Insights 实例，可以使用它来监视函数应用和查看日志。 有关详细信息，请参阅监视 Azure Functions。 该实例在激活之前不会产生费用。

将函数项目部署到 Azure

在 Azure 中成功创建函数应用后，便可以使用 func azure functionapp publish 命令部署本地函数项目。

在以下示例中，请将 <APP_NAME> 替换为你的应用的名称。

func azure functionapp publish <APP_NAME>

publish 命令显示类似于以下输出的结果（为简洁起见，示例中的结果已截断）：

...

Getting site publishing info...
Creating archive for current directory...
Performing remote build for functions project.

...

Deployment successful.
Remote build succeeded!
Syncing triggers...
Functions in msdocs-azurefunctions-qs:
    HttpExample - [httpTrigger]
        Invoke url: https://msdocs-azurefunctions-qs.chinacloudsites.cn/api/httpexample

更新应用设置

若要在函数应用中使用 Python v2 模型，需要在 Azure 中添加一个名为 AzureWebJobsFeatureFlags 且值为 EnableWorkerIndexing 的新应用程序设置。 此设置已在 local.settings.json 文件中。

运行以下命令，将此设置添加到 Azure 中的新函数应用。

az functionapp config appsettings set --name <FUNCTION_APP_NAME> --resource-group <RESOURCE_GROUP_NAME> --settings AzureWebJobsFeatureFlags=EnableWorkerIndexing

请将上一示例中的 <FUNCTION_APP_NAME> 和 <RESOURCE_GROUP_NAME> 分别替换为函数应用名称和资源组名称。 此设置已在 local.settings.json 文件中。

在 Azure 中验证

运行以下命令以在 Azure 门户中查看 Application Insights 中的准实时流式处理日志。

func azure functionapp logstream <APP_NAME> --browser

在单独的终端窗口或浏览器中，再次调用远程函数。 终端中显示了 Azure 中函数执行的详细日志。

清理资源

若要继续执行下一步并添加 Azure 存储队列输出绑定，请保留所有资源，以备将来使用。

否则，请使用以下命令删除资源组及其包含的所有资源，以免产生额外的费用。

az group delete --name AzureFunctionsQuickstart-rg

后续步骤

连接到 Azure 存储队列

对本文有疑问？