Azure队列触发器部署失败：异常连接字符串需求

问题详情 #

部署带有队列触发器的Azure函数应用时触发以下错误：

The 'MyQueueTrigger' function is in error: Microsoft.Azure.WebJobs.Host: Error indexing method 'MyQueueTrigger'. Microsoft.Azure.WebJobs.Extensions.Storage.Queues: Storage account connection string 'AzureWebJobsAzureStorageConnectionString' does not exist. Make sure that it is a defined App Setting.

函数代码中的触发器配置如下：

[FunctionName("MyQueueTrigger")]
public async Task Run(
        [QueueTrigger(
            StorageConstants.MyQueue,
            Connection = StorageConstants.AzureStorageConnectionString
        )]
        string myQueueItem,
        ILogger log)
{
 ...
}

其中StorageConstants.MyQueue值为%MyQueue%，StorageConstants.AzureStorageConnectionString值为AzureStorageConnectionString。

部署后，Azure门户中函数的绑定配置显示为：

{
  "generatedBy": "Microsoft.NET.Sdk.Functions.Generator-4.1.1",
  "configurationSource": "attributes",
  "bindings": [
    {
      "type": "queueTrigger",
      "connection": "AzureStorageConnectionString",
      "queueName": "%MyQueue%",
      "name": "myQueueItem"
    }
  ],
  "disabled": false,
  "scriptFile": "../bin/MyNamespace.Functions.dll",
  "entryPoint": "Redacted"
}

当前函数应用已配置AzureWebJobsStorage和AzureStorageConnectionString两个配置项，但未配置AzureWebJobsAzureStorageConnectionString。添加该配置项可临时解决问题，但需找到根本原因和长期方案。本地运行正常，local.settings.json配置如下：

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "AzureStorageConnectionString": "DefaultEndpointsProtocol=https;AccountName=redacted;AccountKey=redacted==;EndpointSuffix=core.windows.net",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
    "fooBlobContainer": "foo-blob-container",
    "myQueue":  "my-queue"
  },
  "AppSettings": {
    "KeyVaultSecrets": {
      "KeyVaultName": "https://redacted.vault.azure.net",
      "DataWarehouseConnection": "DataWarehouseConnection",
      "LoggingDBConnectionString": "LoggingDBConnectionString",
      "ClientId": "redacted"
    },
    "myServiceAPI": {
      "BaseURL": "redacted.azurewebsites.net/"
    }
  }
}

原因分析 #

Azure Functions的存储类绑定（包括QueueTrigger）存在默认的配置名称拼接逻辑：当你在Connection参数中指定的配置键没有用%包裹，且键名不以AzureWebJobs开头时，运行时会自动在键名前添加AzureWebJobs前缀，再去查找对应的配置项。

所以代码中指定Connection = "AzureStorageConnectionString"时，Azure上的运行实际会查找AzureWebJobsAzureStorageConnectionString，而非你配置的AzureStorageConnectionString。

本地运行正常是因为本地开发工具（Azure Functions Core Tools）对配置加载做了兼容处理，会直接读取local.settings.json中Values下的键，即使没有添加前缀。

解决方案 #

方案1：显式指定完整配置键名（推荐） #

修改代码中Connection参数的值，用%包裹配置键名，让运行时直接读取原配置项，避免自动添加前缀：

[QueueTrigger(
    StorageConstants.MyQueue,
    Connection = "%AzureStorageConnectionString%"
)]

这样运行时会直接查找AzureStorageConnectionString配置，无需额外添加前缀。

方案2：使用默认存储连接 #

如果你不需要单独的存储账户，QueueTrigger默认会使用AzureWebJobsStorage配置项，此时可以直接省略Connection参数：

[QueueTrigger(StorageConstants.MyQueue)]

方案3：重命名配置项（不推荐） #

将现有AzureStorageConnectionString配置项重命名为AzureWebJobsAzureStorageConnectionString，但这需要修改配置和代码中的常量，不符合你的需求，仅作为临时应急方案。

内容的提问来源于stack exchange，提问作者Blue