如何在TypeScript Azure Function中为Service Bus Topic输出消息设置自定义属性

我刚碰到过类似的坑，你的核心问题在于Azure Functions的Service Bus输出绑定并不直接兼容Service Bus SDK的ServiceBusMessage结构，而是有自己的字段映射规则，同时你的function.json里还有个小配置错误。下面给你两种可行的解决方案：

方案一：修正输出绑定的消息结构（推荐，保持绑定的简洁性） #

首先先修正function.json的配置错误：你要发送到Topic，所以应该用topicName而非queueName——这个错误不影响消息发送，但属于语义错误，修正后如下：

{
  "name": "myTopic",
  "type": "serviceBus",
  "topicName": "myTopic", // 替换原来的queueName
  "connection": "SERVICE_BUS_CONNECTION_STRING",
  "direction": "out"
}

然后调整消息构造逻辑：Azure Functions的Service Bus输出绑定期望用properties字段传递自定义元数据，而不是SDK里的applicationProperties。修改后的代码：

import { AzureFunction, Context, HttpRequest } from "@azure/functions";
const httpTrigger: AzureFunction = async function ( context: Context, req: HttpRequest ): Promise<void> {
  const message = {
    body: "my message content",
    properties: { key: "value" }, // 用properties替代applicationProperties
  };
  context.bindings.myTopic = message;
  // 别忘了返回响应
  context.res = { status: 200, body: "消息已发送并附带自定义属性" };
};
export default httpTrigger;

这样修改后，绑定会自动把properties里的键值对映射到Service Bus消息的applicationProperties中，你就能在Service Bus Explorer里看到这些属性了。

方案二：直接使用Service Bus SDK发送（更灵活，适合复杂场景） #

如果需要完全控制消息的所有属性（比如会话ID、过期时间等），可以放弃输出绑定，直接用@azure/service-bus SDK发送，这样完全遵循SDK的ServiceBusMessage结构：

1. 先安装依赖：

npm install @azure/service-bus

2. 修改函数代码：

import { AzureFunction, Context, HttpRequest } from "@azure/functions";
import { ServiceBusClient } from "@azure/service-bus";

const httpTrigger: AzureFunction = async function (context: Context, req: HttpRequest): Promise<void> {
  // 从环境变量获取连接字符串和Topic名称
  const connectionString = process.env.SERVICE_BUS_CONNECTION_STRING;
  const topicName = "myTopic";

  let serviceBusClient: ServiceBusClient | undefined;
  try {
    // 创建客户端和发送者
    serviceBusClient = new ServiceBusClient(connectionString);
    const sender = serviceBusClient.createSender(topicName);

    // 使用SDK的ServiceBusMessage结构
    const message = {
      body: "my message content",
      applicationProperties: { key: "value" }, // 这里可以直接用applicationProperties
      // 还可以添加其他属性，比如messageId、correlationId等
    };

    await sender.sendMessages(message);
    context.res = { status: 200, body: "消息已通过SDK发送并附带自定义属性" };
  } catch (err) {
    context.log.error("发送消息失败:", err);
    context.res = { status: 500, body: "发送消息失败" };
  } finally {
    // 确保关闭客户端和发送者
    if (serviceBusClient) {
      await serviceBusClient.close();
    }
  }
};

export default httpTrigger;

这种方式不受绑定限制，能完全利用SDK的所有功能，适合需要精细控制消息的场景。

为什么原来的代码不生效？ #

你之前直接用SDK的ServiceBusMessage结构（带applicationProperties），但Azure Functions的输出绑定并没有把这个对象当成消息结构解析，而是直接将整个对象序列化为JSON作为消息体——这就是你在Service Bus Explorer里看到消息内容是整个对象JSON的原因。绑定有自己的字段映射规则，必须用它期望的字段名才能正确识别属性。

内容的提问来源于stack exchange，提问作者Léo D.