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

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

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

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

配置本地环境

在开始之前,必须满足以下要求:

先决条件检查

验证你的先决条件,这取决于你是使用 Azure CLI 还是使用 Azure PowerShell 创建 Azure 资源。

  • 在终端或命令窗口中,运行 func --version 以检查 Azure Functions Core Tools 的版本是否为 4.x。

  • 运行 az --version 以检查 Azure CLI 版本是否为 2.4 或更高版本。

  • 运行 az login 登录到 Azure 并验证活动订阅。

  • 运行 python --version (Linux/macOS) 或 py --version (Windows),以检查 Python 版本是否报告 3.9.x、3.8.x 或 3.7.x。

创建并激活虚拟环境

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

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](functions-develop-local.md#local-settings-file) 和 [host.json](functions-host-json.md) 的配置文件。 由于 local.settings.json 可以包含从 Azure 下载的机密,因此,默认情况下,该文件会从 .gitignore 文件的源代码管理中排除。

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

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

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

    使用以下命令获取模板列表:

    func templates list -l python
    

(可选)检查文件内容

如果需要,可以跳到在本地运行函数并稍后再检查文件内容。

__init__.py

__init__.py 包含一个根据 function.json 中的配置触发的 main() Python 函数。

import logging

import azure.functions as func


def main(req: func.HttpRequest) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

    name = req.params.get('name')
    if not name:
        try:
            req_body = req.get_json()
        except ValueError:
            pass
        else:
            name = req_body.get('name')

    if name:
        return func.HttpResponse(f"Hello, {name}. This HTTP triggered function executed successfully.")
    else:
        return func.HttpResponse(
             "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response.",
             status_code=200
        )

对于 HTTP 触发器,该函数将接收 function.json 中定义的变量 req 中的请求数据。 reqazure.functions.HttpRequest 类的实例。 在 function.json 中定义为 $return 的返回对象是 azure.functions.HttpResponse 类的一个实例。 有关详细信息,请参阅 Azure Functions HTTP 触发器和绑定

function.json

function.json 是一个配置文件,其中定义了函数的输入和输出 bindings,包括触发器类型。

如果需要,可以更改 scriptFile 以调用不同的 Python 文件。

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

每个绑定都需要一个方向、类型和唯一的名称。 HTTP 触发器具有类型为 httpTrigger 的输入绑定和类型为 http 的输出绑定。

在本地运行函数

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

    func start
    

    在输出的末尾,应显示以下行:

     ...
    
     Now listening on: http://0.0.0.0:7071
     Application started. Press Ctrl+C to shut down.
    
     Http Functions:
    
             HttpExample: [GET,POST] http://localhost:7071/api/HttpExample
     ...
    
     

    注意

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

  2. 将此输出中 HttpExample 函数的 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. 使用 Azure CLI 时,可以启用 param-persist 选项,它自动跟踪所创建资源的名称。 有关详细信息,请参阅 Azure CLI 持久参数

    az config param-persist on
    
  3. 在所选区域中创建名为 AzureFunctionsQuickstart-rg 的资源组。

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

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

    注意

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

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

    az storage account create --name <STORAGE_NAME> --sku Standard_LRS
    

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

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

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

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

    az functionapp create --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.8、3.7 或 3.6,请将 --runtime-version 分别更改为 3.83.73.6。 你必须提供 --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

在 Azure 上调用函数

由于函数使用 HTTP 触发器,因此,可以通过在浏览器中或使用 curl 等工具,向此函数的 URL 发出 HTTP 请求来调用它。

将 publish 命令的输出中显示的完整“调用 URL”复制到浏览器的地址栏,并追加查询参数 ?name=Functions。 浏览器显示的输出应与本地运行函数时显示的输出类似。

在 Azure 上运行函数后浏览器中的输出

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

func azure functionapp logstream <APP_NAME> --browser

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

清理资源

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

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

az group delete --name AzureFunctionsQuickstart-rg

后续步骤

遇到问题? 请告知我们。