通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

快速入门：在 Azure 中从命令行创建 C# 函数

  • 项目

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

本文会创建 HTTP 触发的函数，该函数在独立工作进程中的 .NET 8 上运行。 有关 C# 函数支持的 .NET 版本的信息，请参阅支持的版本。 本文还提供了基于 Visual Studio 代码的版本。

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

配置本地环境

在开始之前，必须满足以下条件：

还需要一个具有活动订阅的 Azure 帐户。 免费创建帐户。

安装 Azure Functions Core Tools

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

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

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

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

创建本地函数项目

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

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

    func init LocalFunctionProj --worker-runtime dotnet-isolated --target-framework net8.0

  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 创建 HttpExample.cs 代码文件。

（可选）检查文件内容

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

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 触发器和绑定。

在本地运行函数

  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 从此输出复制到浏览器，并浏览到函数 URL，然后应该会收到“欢迎使用 Azure 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> 替换为附近的区域。

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

    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 支持的常规用途帐户。

重要

存储帐户用于存储重要的应用数据，有时包括应用程序代码本身。 应限制其他应用和用户对存储帐户的访问。

  1. 在 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

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

在根项目文件夹中，运行此 func azure functionapp publish 命令：

func azure functionapp publish <APP_NAME>

在此示例中，使用应用名称替代 <APP_NAME>。 成功的部署显示类似于以下输出的结果（为简洁起见，示例中的结果已截断）：

...

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

在 Azure 上调用函数

由于函数使用 HTTP 触发器并且支持 GET 请求，因此可以通过向此函数的 URL 发出 HTTP 请求来调用它。 最简单的方法是在浏览器中执行此操作。

将发布命令的输出中显示的完整调用 URL 复制到浏览器的地址栏。 导航到此 URL 时，浏览器显示的输出应与本地运行函数时显示的输出类似。

运行以下命令以查看准实时流式处理日志：

func azure functionapp logstream <APP_NAME>

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

清理资源

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

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

az group delete --name AzureFunctionsQuickstart-rg

后续步骤

连接到 Azure Cosmos DB

连接到 Azure 队列存储