使用 Core Tools 在本地开发 Azure Functions

使用 Azure Functions Core Tools，可以在本地计算机上开发和测试函数。 准备就绪后，你还可以使用 Core Tools 将代码项目部署到 Azure 并使用应用程序设置。

安装 Azure Functions Core Tools

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

有关版本相关问题的帮助，请参阅 Core Tools 版本。

创建本地项目

在终端窗口中或通过命令提示符，运行以下命令在 MyProjFolder 文件夹中创建项目：

func init MyProjFolder --worker-runtime dotnet-isolated 

func init MyProjFolder --worker-runtime dotnet 

func init MyProjFolder --worker-runtime javascript --model V4

func init MyProjFolder --worker-runtime javascript --model V3

func init MyProjFolder --worker-runtime typescript --model V4

func init MyProjFolder --worker-runtime typescript --model V3

func init MyProjFolder --worker-runtime powershell

func init MyProjFolder --worker-runtime python --model V2

func init MyProjFolder --worker-runtime python

在没有 --worker-runtime 选项的情况下运行 func init 时，系统会提示你选择项目语言。 若要详细了解 func init 命令的可用选项，请参阅参考 func init。

创建函数

要将函数添加到你的项目，请使用 --template 选项运行 func new 命令来选择你的触发器模板。 以下示例创建了一个名为 MyHttpTrigger 的 HTTP 触发器：

func new --template "Http Trigger" --name MyHttpTrigger

此示例创建名为 MyQueueTrigger 的队列存储触发器：

func new --template "Azure Queue Storage Trigger" --name MyQueueTrigger

在添加函数时需要考虑下列注意事项：

• 在没有 --template 选项的情况下运行 func new 时，系统会提示你选择模板。

• 使用 func templates list 命令查看你的语言的可用模板的完整列表。

• 添加连接服务的触发器时，还需要将引用连接字符串或托管标识的应用程序设置添加到 local.settings.json 文件。 以这种方式使用应用设置可避免在代码中嵌入凭据的必要。 有关详细信息，请参阅在本地使用应用设置。

若要详细了解 func new 命令的可用选项，请参阅参考 func new。

向函数添加绑定

Functions 提供了一组特定于服务的输入和输出绑定，使函数能够更轻松地连接到其他 Azure 服务，而无需使用特定于服务的客户端 SDK。 有关详细信息，请参阅 Azure Functions 触发器和绑定概念。

要向现有函数添加输入或输出绑定，必须手动更新函数定义。

以下示例展示了将队列存储输出绑定添加到 HTTP 触发的函数之后的函数定义：

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req, 
    [Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg, 
    ILogger log)

[Function("HttpExample")]
public static MultiResponse Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequestData req,
    FunctionContext executionContext)
{

public class MultiResponse
{
    [QueueOutput("outqueue",Connection = "AzureWebJobsStorage")]
    public string[] Messages { get; set; }
    public HttpResponseData HttpResponse { get; set; }
}

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

$outputMsg = $name
Push-OutputBinding -name msg -Value $outputMsg

@app.route(route="HttpExample")
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
def HttpExample(req: func.HttpRequest, msg: func.Out [func.QueueMessage]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

向函数添加绑定时需要考虑下列注意事项：

• 添加连接服务的绑定时，还必须将引用连接字符串或托管标识的应用程序设置添加到 local.settings.json 文件。 有关详细信息，请参阅在本地使用应用设置。

启动 Functions 运行时

在运行或调试项目中的函数之前，需要从项目的根目录启动 Functions 主机。 主机会为项目中的所有函数启用触发器。 使用以下命令启动本地运行时：

mvn clean package 
mvn azure-functions:run

func start

npm install
npm start     

当 Functions 主机启动时，它会输出项目中的函数列表，包括任何 HTTP 触发的函数的 URL，如以下示例所示：

Found the following functions:
Host.Functions.MyHttpTrigger

Job host started
Http Function MyHttpTrigger: http://localhost:7071/api/MyHttpTrigger

在本地运行函数时，请记住以下注意事项：

• 默认情况下，不会在本地对 HTTP 终结点强制授权。 这意味着所有本地 HTTP 请求都将作为 authLevel = "anonymous" 处理。 有关详细信息，请参阅授权级别。 在本地运行时，可以使用 --enableAuth 选项要求授权。 有关详细信息，请参阅 func start

• 在本地运行需要访问 Azure 存储服务（队列存储、Blob 存储和表存储）的功能时，你可以使用本地 Azurite 仿真器，不需要连接到 Azure 中的这些服务。 使用本地仿真时，请确保先启动 Azurite，然后再启动本地主机 (func.exe)。 有关详细信息，请参阅本地存储仿真。

• 可以在本地触发非 HTTP 函数，而无需连接到实时服务。 有关详细信息，请参阅运行本地函数。

• 在 local.settings.json 文件中包含 Application Insights 连接信息时，本地日志数据会写入特定的 Application Insights 实例。 若要将本地遥测数据与生产数据分开，请考虑使用单独的 Application Insights 实例进行开发和测试。

运行本地函数

你的本地 Functions 主机 (func.exe) 在运行了，现在可以触发单个函数来运行和调试函数代码。 执行单个函数的方式取决于其触发器类型。

http://localhost:<PORT>/api/<FUNCTION_NAME>

curl --get http://localhost:7071/api/MyHttpTrigger?name=Azure%20Rocks

curl --request POST http://localhost:7071/api/MyHttpTrigger --data '{"name":"Azure Rocks"}'

curl --request POST http://localhost:7071/api/MyHttpTrigger --data "{'name':'Azure Rocks'}"

http://localhost:<PORT>/admin/functions/<FUNCTION_NAME>

{
    "input": "<TRIGGER_INPUT>"
}

curl --request POST -H "Content-Type:application/json" --data '{"input":"sample queue data"}' http://localhost:7071/admin/functions/QueueTrigger

curl --request POST -H "Content-Type:application/json" --data "{'input':'sample queue data'}" http://localhost:7071/admin/functions/QueueTrigger

发布到 Azure

Azure Functions Core Tools 支持三种类型的部署：

必须在本地安装 Azure CLI 或 Azure PowerShell，才能通过 Core Tools 发布到 Azure。 默认情况下，Core Tools 使用这些工具通过 Azure 帐户进行身份验证。

如果未安装这些工具，则需要改为获取有效访问令牌以在部署期间使用。 可以使用部署命令中的 --access-token 选项出示访问令牌。

部署项目文件

func azure functionapp publish <FunctionAppName>

mvn azure-functions:deploy

部署容器

Core Tools 允许将容器化函数应用部署到托管的 Azure 容器应用环境和你管理的 Kubernetes 群集。

func azurecontainerapps deploy --name <APP_NAME> --environment <ENVIRONMENT_NAME> --storage-account <STORAGE_CONNECTION> --resource-group <RESOURCE_GROUP> --image-name <IMAGE_NAME> [--registry-password] [--registry-server] [--registry-username]

func kubernetes deploy --name <DEPLOYMENT_NAME> --registry <REGISTRY_USERNAME> 

本地设置

在 Azure 中的函数应用中运行时，函数所需的设置安全地存储在应用设置中。 在本地开发期间，这些设置则改为添加到 local.settings.json 文件中的 Values 对象。 local.settings.json 文件还会存储本地开发工具使用的设置。

因为 local.settings.json 可能包含机密（如连接字符串），因此你绝不应将其存储在远程存储库中。 若要了解有关本地设置的详细信息，请参阅本地设置文件。

使用本地设置文件时，需要考虑以下注意事项：

• 因为 local.settings.json 可能包含机密（如连接字符串），因此你绝不应将其存储在远程存储库中。 Core Tools 可帮助你加密此本地设置文件以提高安全性。 有关详细信息，请参阅本地设置文件。 也可以加密 local.settings.json 文件以增强安全性。

• 默认情况下，将项目发布到 Azure 时，本地设置不会自动迁移。 发布项目文件时使用 --publish-local-settings 选项，以确保将这些设置添加到 Azure 中的函数应用。 永远不会发布 ConnectionStrings 节中的值。 还可以随时从 local.settings.json 文件上传设置。

• 可以使用 Azure 中的函数应用中的设置下载并覆盖 local.settings.json 文件中的设置。 有关详细信息，请参阅下载应用程序设置。

• 如果没有为 AzureWebJobsStorage 设置有效的存储连接字符串，并且未使用本地存储仿真器，则会显示错误。 可以使用 Core Tools 从你的任何 Azure 存储帐户下载特定的连接字符串。

下载应用程序设置

从项目根目录中，使用以下命令从 Azure 中的 myfunctionapp12345 应用下载所有应用程序设置：

func azure functionapp fetch-app-settings myfunctionapp12345

此命令会使用 Azure 中的值覆盖 local.settings.json 文件中的任何现有设置。 如果尚不存在，新项会添加到集合中。 有关详细信息，请参阅 func azure functionapp fetch-app-settings 命令。

下载存储连接字符串

Core Tools 还让你可以轻松获取你有权访问的任何存储帐户的连接字符串。 在项目根目录中，使用以下命令从名为 mystorage12345 的存储账户下载连接字符串。

func azure storage fetch-connection-string mystorage12345

此命令将名为 mystorage12345_STORAGE 的设置添加到 local.settings.json 文件，其中包含 mystorage12345 帐户的连接字符串。 有关详细信息，请参阅 func azure storage fetch-connection-string 命令。

为了在开发过程中提高安全性，请考虑加密 local.settings.json 文件。

将本地设置上传到 Azure

在不使用 --publish-local-settings 选项的情况下将项目文件发布到 Azure 时，不会在函数应用中设置 local.settings.json 文件中的设置。 你始终可以使用 --publish-settings-only 选项重新运行 func azure functionapp publish，从而仅上传设置，而不重新发布项目文件。

以下示例仅将 local.settings.json 文件中 Values 集合内的设置上传到 Azure 中名为 myfunctionapp12345 的函数应用：

func azure functionapp publish myfunctionapp12345 --publish-settings-only

加密本地设置文件

为了提高本地设置中连接字符串和其他重要数据的安全性，Core Tools 允许加密 local.settings.json 文件。 加密此文件时，运行时会在需要时自动解密设置，就像处理 Azure 中的应用程序设置一样。 还可以解密本地加密的文件以使用设置。

使用以下命令加密项目的本地设置文件：

func settings encrypt

使用以下命令解密加密的本地设置，以便可以使用它：

func settings decrypt

加密和解密设置文件时，文件的 IsEncrypted 设置也会更新。

配置绑定扩展

Functions 触发器和绑定可实现为 .NET 扩展 (NuGet) 包。 为了能够使用特定的绑定扩展，必须在项目中安装该扩展。

Core Tools 版本

Azure Functions Core Tools 的主要版本链接到 Azure Functions 运行时的特定主版本。 例如，Core Tools 版本 4.x 支持 Functions 运行时版本 4.x。 此版本是 Functions 运行时和 Core Tools 的建议主版本。 可以在 Azure Functions Core Tools 存储库中确定 Core Tools 的最新发布版本。

清运行以下命令以确定当前 Core Tools 安装的版本：

func --version

除非另有说明，否则本文中的示例适用于版本 4.x。

以下注意事项适用于 Core Tools 安装：

• 你只能在给定计算机上安装一个版本的核心工具。

• 升级到最新版本的 Core Tools 时，应使用与原始安装相同的方法来执行升级。 例如，如果在 Windows 上使用 MSI，请卸载当前 MSI 并安装最新的 MSI。 或者，如果使用了 npm，请重新运行 npm install command。

• 之前 Core Tools 版本 2.x 和 3.x 与 Functions 运行时版本 2.x 和 3.x（对这些版本的支持已结束）配合使用。 有关详细信息，请参阅 Azure Functions 运行时版本概述。

后续步骤

了解如何使用 Azure Functions 核心工具开发、测试和发布 Azure Functions。 Azure Functions Core Tools 是开源工具且托管在 GitHub 上。 若要提交 bug 或功能请求，请打开 GitHub 问题。