快速入门:在 Azure 中从命令行创建 C# 函数
本文介绍如何使用命令行工具创建响应 HTTP 请求的 C# 函数。 在本地测试代码后,将代码部署到 Azure Functions 的无服务器环境。
本文会创建 HTTP 触发的函数,该函数在独立工作进程中的 .NET 8 上运行。 有关 C# 函数支持的 .NET 版本的信息,请参阅支持的版本。 本文还提供了基于 Visual Studio 代码的版本。
完成本快速入门会从你的 Azure 帐户中扣取最多几美分的费用。
在开始之前,必须满足以下条件:
以下用于创建 Azure 资源的工具之一:
Azure Az PowerShell 模块 5.9.0 或更高版本。
还需要一个具有活动订阅的 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
在 Azure Functions 中,有一个函数项目是一个或多个单独函数(每个函数响应特定的触发器)的容器。 项目中的所有函数共享相同的本地和宿主配置。 在本部分,你将创建包含单个函数的函数项目。
按如下所示运行
func init
命令,在名为 LocalFunctionProj 的文件夹中创建使用指定运行时的函数项目:func init LocalFunctionProj --worker-runtime dotnet-isolated --target-framework net8.0
导航到项目文件夹:
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
创建 HttpExample.cs 代码文件。
如果需要,可以跳到在本地运行函数并稍后再检查文件内容。
HttpExample.cs 包含一个 Run
方法,该方法接收 req
变量中作为 HttpRequest 对象的请求数据。 该参数使用 HttpTriggerAttribute 进行修饰,以定义触发器行为。
using System.Net;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Logging;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace Company.Function
{
public class HttpExample
{
private readonly ILogger<HttpExample> _logger;
public HttpExample(ILogger<HttpExample> logger)
{
_logger = logger;
}
[Function("HttpExample")]
public IActionResult Run([HttpTrigger(AuthorizationLevel.AuthLevelValue, "get", "post")] HttpRequest req)
{
_logger.LogInformation("C# HTTP trigger function processed a request.");
return new OkObjectResult("Welcome to Azure Functions!");
}
}
}
返回对象是一个 IActionResult 对象,其中包含返回到 HTTP 响应的数据。
要了解详细信息,请参阅 Azure Functions HTTP 触发器和绑定。
通过从 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 停止主机,导航到项目的根文件夹,然后重新运行上一命令。
将
HttpExample
函数的 URL 从此输出复制到浏览器,并浏览到函数 URL,然后应该会收到“欢迎使用 Azure 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>
替换为附近的区域。在资源组和区域中创建常规用途存储帐户:
az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS --allow-blob-public-access false
az storage account create 命令可创建存储帐户。
在上一个示例中,将
<STORAGE_NAME>
替换为适合你且在 Azure 存储中唯一的名称。 名称只能包含 3 到 24 个数字和小写字母字符。Standard_LRS
指定 Functions 支持的常规用途帐户。
重要
存储帐户用于存储重要的应用数据,有时包括应用程序代码本身。 应限制其他应用和用户对存储帐户的访问。
在 Azure 中创建函数应用:
az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location <REGION> --runtime dotnet-isolated --functions-version 4 --name <APP_NAME> --storage-account <STORAGE_NAME>
az functionapp create 命令可在 Azure 中创建函数应用。
在上一个示例中,请将
<STORAGE_NAME>
替换为在上一步骤中使用的帐户的名称,并将<APP_NAME>
替换为适合自己的全局唯一名称。<APP_NAME>
也是函数应用的默认 DNS 域。此命令将创建一个函数应用,该应用在 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 触发器并且支持 GET 请求,因此可以通过向此函数的 URL 发出 HTTP 请求来调用它。 最简单的方法是在浏览器中执行此操作。
将发布命令的输出中显示的完整调用 URL 复制到浏览器的地址栏。 导航到此 URL 时,浏览器显示的输出应与本地运行函数时显示的输出类似。
运行以下命令以查看准实时流式处理日志:
func azure functionapp logstream <APP_NAME>
在单独的终端窗口或浏览器中,再次调用远程函数。 终端中显示了 Azure 中函数执行的详细日志。
若要继续执行下一步并添加 Azure 存储队列输出绑定,请保留所有资源,以备将来使用。
否则,请使用以下命令删除资源组及其包含的所有资源,以免产生额外的费用。
az group delete --name AzureFunctionsQuickstart-rg