快速入门:在 Azure 中通过命令行创建 Python 函数
在本文中,你将使用命令行工具创建响应 HTTP 请求的 Python 函数。 在本地测试代码后,将代码部署到 Azure Functions 的无服务器环境。
本文使用适用于 Azure Functions 的 Python v2 编程模型,该编程模型提供基于修饰器的方法来创建函数。 若要详细了解 Python v2 编程模型,请参阅开发人员参考指南
完成本快速入门会从你的 Azure 帐户中扣取最多几美分的费用。
本文还提供了基于 Visual Studio 代码的版本。
在开始之前,必须满足以下要求:
具有活动订阅的 Azure 帐户。 创建帐户。
以下用于创建 Azure 资源的工具之一:
Azure CLI 版本 2.4 或更高版本。
Azure Az PowerShell 模块 5.9.0 或更高版本。
Azurite 存储模拟器。 虽然也可以使用实际的 Azure 存储帐户,但本文假定你使用的是此模拟器。
建议的 Core Tools 安装方法取决于本地开发计算机的操作系统。
以下步骤使用 APT 在 Ubuntu/Debian Linux 发行版上安装 Core Tools。 有关其他 Linux 发行版,请参阅 Core Tools 自述文件。
安装 Microsoft 包存储库 GPG 密钥,以验证包完整性:
curl https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.gpg sudo mv microsoft.gpg /etc/apt/trusted.gpg.d/microsoft.gpg
在进行 APT 更新之前,设置 APT 源列表。
Ubuntu
sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/repos/microsoft-ubuntu-$(lsb_release -cs)-prod $(lsb_release -cs) main" > /etc/apt/sources.list.d/dotnetdev.list'
Debian
sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/debian/$(lsb_release -rs | cut -d'.' -f 1)/prod $(lsb_release -cs) main" > /etc/apt/sources.list.d/dotnetdev.list'
检查
/etc/apt/sources.list.d/dotnetdev.list
文件以获取下表中相应 Linux 版本字符串之一:Linux 分发版 版本 Debian 11 bullseye
Debian 10 buster
Debian 9 stretch
Ubuntu 22.04 jammy
Ubuntu 20.04 focal
Ubuntu 19.04 disco
Ubuntu 18.10 cosmic
Ubuntu 18.04 bionic
Ubuntu 17.04 zesty
Ubuntu 16.04/Linux Mint 18 xenial
启动 APT 源更新:
sudo apt-get update
安装 Core Tools 包:
sudo apt-get install azure-functions-core-tools-4
使用 func --version
命令来确保 Core Tools 的版本至少为 4.0.5530
。
在适当的文件夹中,运行以下命令以创建并激活一个名为 .venv
的虚拟环境。 请务必使用 Azure Functions 支持的 Python 版本。
python -m venv .venv
source .venv/bin/activate
如果 Python 未在 Linux 分发版中安装 venv 包,请运行以下命令:
sudo apt-get install python3-venv
所有后续命令将在这个已激活的虚拟环境中运行。
在 Azure Functions 中,有一个函数项目是一个或多个单独函数(每个函数响应特定的触发器)的容器。 项目中的所有函数共享相同的本地和宿主配置。
在本部分中,将创建一个函数项目并添加 HTTP 触发的函数。
按如下所示运行
func init
命令,在虚拟环境中创建 Python v2 函数项目。func init --python
此环境现在包含项目的各个文件,其中包括名为 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_app.py
文件添加名为HttpExample
的 HTTP 触发器终结点,无需身份验证即可访问该文件。
通过从 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 CLI 和 PowerShell。
如果需要,请登录到 Azure。
az login
使用
az login
命令登录到 Azure 帐户。在所选区域中创建名为
AzureFunctionsQuickstart-rg
的资源组。az group create --name AzureFunctionsQuickstart-rg --location <REGION>
az group create 命令可创建资源组。 在上述命令中,使用从
<REGION>
命令返回的可用区域代码,将<REGION>
替换为附近的区域。备注
不能在同一资源组中托管 Linux 和 Windows 应用。 如果名为
AzureFunctionsQuickstart-rg
的现有资源组有 Windows 函数应用或 Web 应用,必须使用其他资源组。在资源组和区域中创建常规用途存储帐户。
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 支持的常规用途帐户。在本快速入门中使用的存储帐户只会产生几美分的费用。
在 Azure 中创建函数应用。
az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location chinanorth2 --runtime python --runtime-version <PYTHON_VERSION> --functions-version 4 --name <APP_NAME> --os-type linux --storage-account <STORAGE_NAME>
az functionapp create 命令可在 Azure 创建函数应用。 必须提供
--os-type linux
,因为 Python 函数仅在 Linux 上运行。在上一个示例中,将
<APP_NAME>
替换为适合自己的全局唯一名称。<APP_NAME>
也是函数应用的默认子域。 请确保为<PYTHON_VERSION>
设置的值是 Functions 支持的版本,并且与本地开发过程中使用的版本相同。此命令将创建一个函数应用,该应用在 Azure Functions 消耗计划下指定的语言运行时中运行,根据本教程产生的用量,此操作是免费的。 该命令还会在同一资源组中创建关联的 Azure Application Insights 实例,可以使用它来监视函数应用和查看日志。 有关详细信息,请参阅监视 Azure Functions。 该实例在激活之前不会产生费用。
在 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
由于函数使用 HTTP 触发器,因此,可以通过在浏览器中或使用 curl 等工具,向此函数的 URL 发出 HTTP 请求来调用它。
若要继续执行下一步并添加 Azure 存储队列输出绑定,请保留所有资源,以备将来使用。
否则,请使用以下命令删除资源组及其包含的所有资源,以免产生额外的费用。
az group delete --name AzureFunctionsQuickstart-rg
对本文有疑问?