ServiceBusTrigger批量接收消息时如何添加messageId等参数？

问题背景 #

现有Azure Functions批量接收Service Bus队列消息的代码可正常运行：

[FunctionName("TelemetryListenerCalculateAlgoPostNewState")]
public static async Task TelemetryListenerCalculateAlgoPostNewState(
    [ServiceBusTrigger(busTelemetryQueueName,Connection = "ServiceBusConnection")]
    string [] receivedTelemetryMessages,
    ILogger log)
{
    // 现有业务逻辑
}

需要获取每条消息的enqueuedTimeUtc或messageId用于计算延迟、监控消息顺序，但参考单条消息接收的写法添加独立参数后，触发绑定错误：

参考的单条消息写法：

[FunctionName("ServiceBusQueueTriggerCSharp")]                    
public static void Run(
    [ServiceBusTrigger("myqueue", Connection = "ServiceBusConnection")] 
    string myQueueItem,
    Int32 deliveryCount,
    DateTime enqueuedTimeUtc,
    string messageId,
    ILogger log)
{
    log.LogInformation($"C# ServiceBus queue trigger function processed message: {myQueueItem}");
    log.LogInformation($"EnqueuedTimeUtc={enqueuedTimeUtc}");
    log.LogInformation($"DeliveryCount={deliveryCount}");
    log.LogInformation($"MessageId={messageId}");
}

错误信息：

[2022-11-23T18:11:02.038Z] Microsoft.Azure.WebJobs.Host: Error indexing method 'TelemetryListenerCalculateAlgoPostNewState'. Microsoft.Azure.WebJobs.Host: Cannot bind parameter 'enqueuedTimeUtc' to type DateTime. Make sure the parameter Type is supported by the binding. If you're using binding extensions (e.g. Azure Storage, ServiceBus, Timers, etc.) make sure you've called the registration method for the extension(s) in your startup code (e.g. builder.AddAzureStorage(), builder.AddServiceBus(), builder.AddTimers(), etc.).

当前仅使用单个消费者，未使用主题，需实现批量接收时获取消息属性。

解决方案 #

批量接收场景下，无法通过独立参数绑定消息属性，需将接收参数的类型从string[]替换为ServiceBusReceivedMessage[]（适用于Azure Functions Service Bus扩展v5+的进程内模型），该类型包含Service Bus消息的全部原生属性。

修改后的代码示例 #

[FunctionName("TelemetryListenerCalculateAlgoPostNewState")]
public static async Task TelemetryListenerCalculateAlgoPostNewState(
    [ServiceBusTrigger(busTelemetryQueueName, Connection = "ServiceBusConnection", IsBatchTrigger = true)]
    ServiceBusReceivedMessage[] receivedTelemetryMessages,
    ILogger log)
{
    foreach (var message in receivedTelemetryMessages)
    {
        // 提取消息核心属性
        string messageId = message.MessageId;
        DateTime enqueuedTimeUtc = message.EnqueuedTimeUtc;
        int deliveryCount = message.DeliveryCount;
        
        // 读取消息内容
        string messageBody = await message.Body.ToStringAsync();

        // 日志输出或业务处理
        log.LogInformation($"处理消息ID: {messageId}, 入队时间(UTC): {enqueuedTimeUtc}, 投递次数: {deliveryCount}");
        log.LogInformation($"消息内容: {messageBody}");
    }
}

关键注意事项 #

• 类型替换：ServiceBusReceivedMessage是Service Bus扩展提供的原生消息类型，包含所有消息元数据与内容
• 扩展包依赖：确保已正确安装对应版本的Service Bus扩展包（进程内模型使用Microsoft.Azure.WebJobs.Extensions.ServiceBus，隔离进程模型使用Microsoft.Azure.Functions.Worker.Extensions.ServiceBus）
• 显式声明批量触发器：在ServiceBusTrigger属性中设置IsBatchTrigger = true，部分版本可自动识别数组类型，但显式设置可避免绑定异常

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