通过命令行创建 Python 函数 - Azure Functions

配置本地环境

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

具有活动订阅的 Azure 帐户。免费创建帐户。

Azure Functions Core Tools 版本 4.x。

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

先决条件检查

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

Azure CLI Azure PowerShell

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

运行 (Get-Module -ListAvailable Az).Version 并验证版本是否为 5.0 或更高版本。

运行 Connect-AzAccount 登录到 Azure 并验证活动订阅。

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

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

创建本地函数项目

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

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

func init LocalFunctionProj --python
转到项目文件夹。
cd LocalFunctionProj
此文件夹包含项目的各个文件，其中包括名为 local.settings.json 和 host.json 的配置文件。 由于 local.settings.json 可以包含从 Azure 下载的机密，因此，默认情况下，该文件会从 .gitignore 文件的源代码管理中排除。
使用以下命令将一个函数添加到项目，其中，--name 参数是该函数 (HttpExample) 的唯一名称，--template 参数指定该函数的触发器 (HTTP)。
func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"
func new 创建一个与函数名称匹配的、包含项目所选语言适用的代码文件的子文件夹，以及一个名为 function.json 的配置文件。
使用以下命令获取模板列表：
func templates list -l python
运行 func init 命令（如下所示），在名为 LocalFunctionProj 的文件夹中创建使用指定运行时和指定编程模型版本的函数项目。
func init LocalFunctionProj --python -m V2
转到项目文件夹。
cd LocalFunctionProj
此文件夹包含项目的各个文件，其中包括名为 local.settings.json 和 host.json 的配置文件。 由于 local.settings.json 可以包含从 Azure 下载的机密，因此，默认情况下，该文件会从 .gitignore 文件的源代码管理中排除。
function_app.py 文件可以包含项目中的所有函数。 首先，文件中已存储一个 HTTP 函数。
import azure.functions as func
app = func.FunctionApp()
@app.function_name(name="HttpTrigger1")
@app.route(route="hello")
def test_function(req: func.HttpRequest) -> func.HttpResponse:
    return func.HttpResponse("HttpTrigger1 function processed a request!")
（可选）检查文件内容
如果需要，可以跳到在本地运行函数并稍后再检查文件内容。
__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:
            req_body = req.get_json()
        except ValueError:
        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 中的请求数据。 req 是 azure.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 的输出绑定。
function_app.py 是函数的入口点，用于存储和/或引用函数。 此文件将包含通过修饰器和函数内容本身配置触发器和绑定的内容。
有关详细信息，请参阅 Azure Functions HTTP 触发器和绑定。
启动存储模拟器
默认情况下，本地开发使用 Azurite 存储模拟器。 当 local.settings.json 项目文件中的 AzureWebJobsStorage 设置设为 UseDevelopmentStorage=true 时，将使用此模拟器。 使用模拟器时，必须在运行函数之前启动本地 Azurite 存储模拟器。
如果 local.settings.json 中的 AzureWebJobsStorage 设置已设为 Azure 存储帐户的连接字符串，而不是 UseDevelopmentStorage=true，则可以跳过此步骤。
使用以下命令启动 Azurite 存储模拟器：
azurite
有关详细信息，请参阅运行 Azurite
在本地运行函数
通过从 LocalFunctionProj 文件夹启动本地 Azure Functions 运行时主机来运行函数。
func start
在输出的末尾，必须要显示以下行：
如果 HttpExample 未按如上所示出现，则可能是在项目的根文件夹外启动了主机。 在这种情况下，请按 Ctrl+C 停止主机，转至项目的根文件夹，然后重新运行上一命令。
将此输出中的 HTTP 函数的 URL 复制到浏览器，并追加查询字符串 ?name=<YOUR_NAME>，使完整 URL 类似于 http://localhost:7071/api/HttpExample?name=Functions。 浏览器应显示回显查询字符串值的响应消息。 当你发出请求时，启动项目时所在的终端还会显示日志输出。
完成后，按 Ctrl + C 并键入 y 以停止函数主机。
创建函数的支持性 Azure 资源
在将函数代码部署到 Azure 之前，需要创建三个资源：
一个资源组：相关资源的逻辑容器。
一个存储帐户：维护有关项目的状态和其他信息。
一个函数应用：提供用于执行函数代码的环境。 函数应用映射到本地函数项目，可让你将函数分组为一个逻辑单元，以便更轻松地管理、部署和共享资源。
使用以下命令创建这些项。 支持 Azure CLI 和 PowerShell。
请登录到 Azure（如果尚未这样做）。
Azure CLI
Azure PowerShell
不能在同一资源组中托管 Linux 和 Windows 应用。 如果名为 AzureFunctionsQuickstart-rg 的现有资源组有 Windows 函数应用或 Web 应用，必须使用其他资源组。
在资源组和区域中创建常规用途存储帐户。
Azure CLI
Azure PowerShell
New-AzStorageAccount -ResourceGroupName AzureFunctionsQuickstart-rg -Name <STORAGE_NAME> -SkuName Standard_LRS -Location <REGION>
New-AzStorageAccount cmdlet 可创建存储帐户。
在上一个示例中，将 <STORAGE_NAME> 替换为适合你且在 Azure 存储中唯一的名称。 名称只能包含 3 到 24 个数字和小写字母字符。 Standard_LRS 指定 Functions 支持的常规用途帐户。
在本快速入门中使用的存储帐户只会产生几美分的费用。
在 Azure 中创建函数应用。
Azure CLI
Azure PowerShell
az functionapp create --consumption-plan-location westeurope --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 上运行，这是默认设置。
New-AzFunctionApp -Name <APP_NAME> -ResourceGroupName AzureFunctionsQuickstart-rg -StorageAccountName <STORAGE_NAME> -FunctionsVersion 4 -RuntimeVersion 3.9 -Runtime python -Location '<REGION>'
New-AzFunctionApp cmdlet 可在 Azure 中创建函数应用。 如果使用的是 Python 3.9、3.8 或 3.7，请将 -RuntimeVersion 分别更改为 3.9、3.8 或 3.7。
在上一个示例中，将 <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.azurewebsites.net/api/httpexample
更新应用设置
若要在函数应用中使用 Python v2 模型，需要在 Azure 中添加一个名为 AzureWebJobsFeatureFlags 且值为 EnableWorkerIndexing 的新应用程序设置。 此设置已在 local.settings.json 文件中。
运行以下命令，将此设置添加到 Azure 中的新函数应用。
Azure CLI
Azure PowerShell
请将上一示例中的 <FUNCTION_APP_NAME> 和 <RESOURCE_GROUP_NAME> 分别替换为函数应用名称和资源组名称。 此设置已在 local.settings.json 文件中。
在 Azure 中验证
运行以下命令以在 Azure 门户中查看 Application Insights 中的准实时流式处理日志。
func azure functionapp logstream <APP_NAME> --browser
在单独的终端窗口或浏览器中，再次调用远程函数。 终端中显示了 Azure 中函数执行的详细日志。
若要继续执行下一步并添加 Azure 存储队列输出绑定，请保留所有资源，以备将来使用。
否则，请使用以下命令删除资源组及其包含的所有资源，以免产生额外的费用。
Azure CLI
Azure PowerShell