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

Azure Functions的Azure 服务总线触发器

使用服务总线触发器响应来自服务总线队列或主题的消息。从扩展版本 3.1.0 开始，可以在启用会话的队列或主题上触发。

有关设置和配置详细信息，请参阅概述。

服务总线根据基于目标的缩放对消耗和高级计划做出缩放决策。有关详细信息，请参阅基于目标的缩放。

重要

本文使用选项卡来支持多个版本的 Node.js 编程模型。 v4 模型已正式发布，旨在为 JavaScript 和 TypeScript 开发人员提供更为灵活和直观的体验。有关 v4 模型工作原理的更多详细信息，请参阅 Azure Functions Node.js 开发人员指南。要详细了解 v3 和 v4 之间的差异，请参阅迁移指南。

Azure Functions支持两个用于Python的编程模型。定义绑定的方式取决于选择的编程模型。

Python v2 编程模型允许直接在Python函数代码中使用修饰器定义绑定。有关详细信息，请参阅 Python 开发人员指南。

本文同时支持两个编程模型。

示例

可使用以下 C# 模式之一来创建 C# 函数：

独立辅助角色模型：编译的 C# 函数，该函数在独立于运行时的工作进程中运行。独立工作进程需要支持在 LTS 和非 LTS 版本上运行的 C# 函数，.NET和.NET框架。独立工作进程函数的扩展使用 Microsoft.Azure.Functions.Worker.Extensions.* 命名空间。
进程内模型：编译的 C# 函数，该函数在与 Functions 运行时相同的进程中运行。在此模型的变体中，可以使用 C# 脚本运行 Functions，该脚本主要用于 C# 门户编辑。进程内函数的扩展使用 Microsoft.Azure.WebJobs.Extensions.* 命名空间。

重要

对进程内模型的支持将于 2026 年 11 月 10 日结束。为获得完全支持，强烈建议将应用迁移到独立工作模型。

独立工作模型
进程模型

此代码定义并初始化 ILogger：

private readonly ILogger<ServiceBusReceivedMessageFunctions> _logger;

public ServiceBusReceivedMessageFunctions(ILogger<ServiceBusReceivedMessageFunctions> logger)
{
    _logger = logger;
}

此示例演示接收单个服务总线队列消息并将其写入日志的 C# 函数：

[Function(nameof(ServiceBusReceivedMessageFunction))]
[ServiceBusOutput("outputQueue", Connection = "ServiceBusConnection")]
public string ServiceBusReceivedMessageFunction(
    [ServiceBusTrigger("queue", Connection = "ServiceBusConnection")] ServiceBusReceivedMessage message)
{
    _logger.LogInformation("Message ID: {id}", message.MessageId);
    _logger.LogInformation("Message Body: {body}", message.Body);
    _logger.LogInformation("Message Content-Type: {contentType}", message.ContentType);

    var outputMessage = $"Output message created at {DateTime.Now}";
    return outputMessage;
}

此示例演示一个 C# 函数，该函数在单个批处理中接收多个服务总线队列消息，并将每个消息写入日志：

[Function(nameof(ServiceBusReceivedMessageBatchFunction))]
public void ServiceBusReceivedMessageBatchFunction(
    [ServiceBusTrigger("queue", Connection = "ServiceBusConnection", IsBatched = true)] ServiceBusReceivedMessage[] messages)
{
    foreach (ServiceBusReceivedMessage message in messages)
    {
        _logger.LogInformation("Message ID: {id}", message.MessageId);
        _logger.LogInformation("Message Body: {body}", message.Body);
        _logger.LogInformation("Message Content-Type: {contentType}", message.ContentType);
    }
}

此示例演示一个 C# 函数，该函数接收多个服务总线队列消息，将其写入日志，然后将消息确定为已完成：

[Function(nameof(ServiceBusMessageActionsFunction))]
public async Task ServiceBusMessageActionsFunction(
    [ServiceBusTrigger("queue", Connection = "ServiceBusConnection", AutoCompleteMessages = false)]
    ServiceBusReceivedMessage message,
    ServiceBusMessageActions messageActions)
{
    _logger.LogInformation("Message ID: {id}", message.MessageId);
    _logger.LogInformation("Message Body: {body}", message.Body);
    _logger.LogInformation("Message Content-Type: {contentType}", message.ContentType);

    // Complete the message
    await messageActions.CompleteMessageAsync(message);
}

以下示例演示一个 C# 函数，用于读取 message 元数据并记录服务总线队列消息：

[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}");
}

以下Java函数使用 Java 函数运行时库1 中的注释来描述服务总线队列触发器的配置。此函数获取放置在队列上的消息，然后将其添加到日志。

@FunctionName("sbprocessor")
 public void serviceBusProcess(
    @ServiceBusQueueTrigger(name = "msg",
                             queueName = "myqueuename",
                             connection = "myconnvarname") String message,
   final ExecutionContext context
 ) {
     context.getLogger().info(message);
 }

将消息添加到服务总线主题时，也可以触发Java函数。以下示例使用 @ServiceBusTopicTrigger 注释来说明触发器配置。

@FunctionName("sbtopicprocessor")
    public void run(
        @ServiceBusTopicTrigger(
            name = "message",
            topicName = "mytopicname",
            subscriptionName = "mysubscription",
            connection = "ServiceBusConnection"
        ) String message,
        final ExecutionContext context
    ) {
        context.getLogger().info(message);
    }

模型 v4
模型 v3

此示例使用从服务总线触发器提供的 ServiceBusMessageContext 获取的 SDK 类型 ServiceBusReceivedMessage：

import '@azure/functions-extensions-servicebus'; // Ensure the Service Bus extension is imported
import { app, type InvocationContext } from '@azure/functions';
import { type ServiceBusMessageContext, messageBodyAsJson } from '@azure/functions-extensions-servicebus';

// This sample uses sdkBinding = true with manual message completion.
// With v0.4.0, message.body is returned as a raw Buffer instead of auto-parsed object.
export async function serviceBusQueueTrigger(
    serviceBusMessageContext: ServiceBusMessageContext,
    context: InvocationContext
): Promise<void> {
    const message = serviceBusMessageContext.messages[0];

    // v0.4.0: message.body is a Buffer — use messageBodyAsJson<T>() from the extension for one-line parsing
    const bodyData = messageBodyAsJson(message);
    context.log('Parsed message body:', bodyData);

    // Get current retry count from custom properties, default to 0
    const currentRetryCount = message.applicationProperties?.retryCnt
        ? parseInt(message.applicationProperties.retryCnt as string)
        : 0;
    context.log(`Current retry count: ${currentRetryCount}`);

    if (currentRetryCount >= 3) {
        // After 3 retries, complete the message to remove it from the queue
        context.log(`Maximum retry count (3) reached. Completing message to prevent infinite loop.`);
        await serviceBusMessageContext.actions.complete(message);
        context.log('Message completed after maximum retries');
    } else {
        // Abandon with updated retry count
        const newRetryCount = currentRetryCount + 1;
        const propertiesToModify = {
            retryCnt: newRetryCount.toString(),
            lastRetryTime: new Date().toISOString(),
            errorMessage: 'Processing failed',
        };

        context.log(`Abandoning message with retry count: ${newRetryCount}`);
        await serviceBusMessageContext.actions.abandon(message, propertiesToModify);
    }

    context.log('triggerMetadata: ', context.triggerMetadata);
}

app.serviceBusQueue('serviceBusQueueTrigger1', {
    connection: 'ServiceBusConnection',
    queueName: 'testqueue',
    sdkBinding: true,

有关使用 SDK 类型的另一个示例，请参阅 exponential backoff 策略示例。

有关详细信息，请参阅 Node.js 参考文章中的 SDK 类型。

以下示例演示TypeScript 函数服务总线触发器。该函数读取 message 元数据并记录服务总线队列消息。

import { app, InvocationContext } from '@azure/functions';

export async function serviceBusQueueTrigger1(message: unknown, context: InvocationContext): Promise<void> {
    context.log('Service bus queue function processed message:', message);
    context.log('EnqueuedTimeUtc =', context.triggerMetadata.enqueuedTimeUtc);
    context.log('DeliveryCount =', context.triggerMetadata.deliveryCount);
    context.log('MessageId =', context.triggerMetadata.messageId);
}

app.serviceBusQueue('serviceBusQueueTrigger1', {
    connection: 'MyServiceBusConnection',
    queueName: 'testqueue',
    handler: serviceBusQueueTrigger1,
});

模型 v4
模型 v3

以下示例演示服务总线触发器JavaScript 函数。该函数读取 message 元数据并记录服务总线队列消息。

const { app } = require('@azure/functions');

app.serviceBusQueue('serviceBusQueueTrigger1', {
    connection: 'MyServiceBusConnection',
    queueName: 'testqueue',
    handler: (message, context) => {
        context.log('Service bus queue function processed message:', message);
        context.log('EnqueuedTimeUtc =', context.triggerMetadata.enqueuedTimeUtc);
        context.log('DeliveryCount =', context.triggerMetadata.deliveryCount);
        context.log('MessageId =', context.triggerMetadata.messageId);
    },
});

以下示例演示 function.json 文件中的服务总线触发器绑定以及使用该绑定的 JavaScript 函数。该函数读取 message 元数据并记录服务总线队列消息。

下面是 function.json 文件中的绑定数据：

{
"bindings": [
    {
    "queueName": "testqueue",
    "connection": "MyServiceBusConnection",
    "name": "myQueueItem",
    "type": "serviceBusTrigger",
    "direction": "in"
    }
],
"disabled": false
}

JavaScript 脚本代码如下所示：

module.exports = async function(context, myQueueItem) {
    context.log('Node.js ServiceBus queue trigger function processed message', myQueueItem);
    context.log('EnqueuedTimeUtc =', context.bindingData.enqueuedTimeUtc);
    context.log('DeliveryCount =', context.bindingData.deliveryCount);
    context.log('MessageId =', context.bindingData.messageId);
};

以下示例演示 function.json 文件中的服务总线触发器绑定以及使用该绑定的 PowerShell 函数。

下面是 function.json 文件中的绑定数据：

{
  "bindings": [
    {
      "name": "mySbMsg",
      "type": "serviceBusTrigger",
      "direction": "in",
      "topicName": "mytopic",
      "subscriptionName": "mysubscription",
      "connection": "AzureServiceBusConnectionString"
    }
  ]
}

下面是发送服务总线消息时运行的函数。

param([string] $mySbMsg, $TriggerMetadata)

Write-Host "PowerShell ServiceBus queue trigger function processed message: $mySbMsg"

此示例使用 SDK 类型直接访问由服务总线触发器提供的基础 ServiceBusReceivedMessage 对象：

队列
Topic

import logging

import azure.functions as func
import azurefunctions.extensions.bindings.servicebus as servicebus

app = func.FunctionApp(http_auth_level=func.AuthLevel.FUNCTION)

@app.service_bus_queue_trigger(arg_name="receivedmessage",
                               queue_name="QUEUE_NAME",
                               connection="SERVICEBUS_CONNECTION")
def servicebus_queue_trigger(receivedmessage: servicebus.ServiceBusReceivedMessage):
    logging.info("Python ServiceBus queue trigger processed message.")
    logging.info("Receiving: %s\n"
                 "Body: %s\n"
                 "Enqueued time: %s\n"
                 "Lock Token: %s\n"
                 "Message ID: %s\n"
                 "Sequence number: %s\n",
                 receivedmessage,
                 receivedmessage.body,
                 receivedmessage.enqueued_time_utc,
                 receivedmessage.lock_token,
                 receivedmessage.message_id,
                 receivedmessage.sequence_number)

import logging

import azure.functions as func
import azurefunctions.extensions.bindings.servicebus as servicebus

app = func.FunctionApp(http_auth_level=func.AuthLevel.FUNCTION)

@app.service_bus_topic_trigger(arg_name="receivedmessage",
                               topic_name="TOPIC_NAME",
                               connection="SERVICEBUS_CONNECTION",
                               subscription_name="SUBSCRIPTION_NAME")
def servicebus_topic_trigger(receivedmessage: servicebus.ServiceBusReceivedMessage):
    logging.info("Python ServiceBus topic trigger processed message.")
    logging.info("Receiving: %s\n"
                 "Body: %s\n"
                 "Enqueued time: %s\n"
                 "Lock Token: %s\n"
                 "Message ID: %s\n"
                 "Sequence number: %s\n",
                 receivedmessage,
                 receivedmessage.body,
                 receivedmessage.enqueued_time_utc,
                 receivedmessage.lock_token,
                 receivedmessage.message_id,
                 receivedmessage.sequence_number)

该函数读取类型的各种属性 ServiceBusReceivedMessage 并记录它们。

有关使用服务总线 SDK 类型的更多示例，请参阅 ServiceBusReceivedMessage 示例。有关如何在函数应用中包括 SDK 类型绑定的分步教程，请遵循适用于服务总线 Sample0>Python SDK 绑定。

注意

已知限制包括：

不支持该 message 属性。
批处理消息支持需要 4.1039 或更高版本的 Functions 运行时。

若要了解详细信息，包括支持其他 SDK 类型绑定的内容，请参阅 SDK 类型绑定。

此示例演示如何通过触发器读取服务总线队列消息。该示例取决于是使用 v1 还是 v2 Python编程模型。

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="ServiceBusQueueTrigger1")
@app.service_bus_queue_trigger(arg_name="msg", 
                               queue_name="<QUEUE_NAME>", 
                               connection="<CONNECTION_SETTING>")
def test_function(msg: func.ServiceBusMessage):
    logging.info('Python ServiceBus queue trigger processed message: %s',
                 msg.get_body().decode('utf-8'))

服务总线绑定在 function.json 中定义，其中 type设置为 serviceBusTrigger，队列由 queueName 设置。

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "msg",
      "type": "serviceBusTrigger",
      "direction": "in",
      "queueName": "inputqueue",
      "connection": "AzureServiceBusConnectionString"
    }
  ]
}

_init_.py 中的代码将参数声明为，让你可以在函数中读取队列消息。

import azure.functions as func

import logging
import json

def main(msg: func.ServiceBusMessage):
    logging.info('Python ServiceBus queue trigger processed message.')

    result = json.dumps({
        'message_id': msg.message_id,
        'body': msg.get_body().decode('utf-8'),
        'content_type': msg.content_type,
        'expiration_time': msg.expiration_time,
        'label': msg.label,
        'partition_key': msg.partition_key,
        'reply_to': msg.reply_to,
        'reply_to_session_id': msg.reply_to_session_id,
        'scheduled_enqueue_time': msg.scheduled_enqueue_time,
        'session_id': msg.session_id,
        'time_to_live': msg.time_to_live,
        'to': msg.to,
        'user_properties': msg.user_properties,
        'metadata' : msg.metadata
    }, default=str)

    logging.info(result)

以下示例演示如何通过触发器读取服务总线队列主题。

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="ServiceBusTopicTrigger1")
@app.service_bus_topic_trigger(arg_name="message", 
                               topic_name="TOPIC_NAME", 
                               connection="CONNECTION_SETTING", 
                               subscription_name="SUBSCRIPTION_NAME")
def test_function(message: func.ServiceBusMessage):
    message_body = message.get_body().decode("utf-8")
    logging.info("Python ServiceBus topic trigger processed message.")
    logging.info("Message Body: " + message_body)

服务总线绑定在 function.json 中定义，其中 type设置为 serviceBusTrigger，主题由 topicName 设置，订阅由 subscriptionName 设置。

{
  "scriptFile": "__init__.py",
  "bindings": [
   {
     "type": "serviceBusTrigger",
     "direction": "in",
     "name": "msg",
     "topicName": "inputtopic",
     "subscriptionName": "inputsubscription",
     "connection": "AzureServiceBusConnectionString"
   }
  ]
}

_init_.py 中的代码将参数声明为 func.ServiceBusMessage，这可支持你在函数中读取主题。

import json

import azure.functions as azf


def main(msg: azf.ServiceBusMessage) -> str:
    result = json.dumps({
        'message_id': msg.message_id,
        'body': msg.get_body().decode('utf-8'),
        'content_type': msg.content_type,
        'delivery_count': msg.delivery_count,
        'expiration_time': (msg.expiration_time.isoformat() if
                            msg.expiration_time else None),
        'label': msg.label,
        'partition_key': msg.partition_key,
        'reply_to': msg.reply_to,
        'reply_to_session_id': msg.reply_to_session_id,
        'scheduled_enqueue_time': (msg.scheduled_enqueue_time.isoformat() if
                                   msg.scheduled_enqueue_time else None),
        'session_id': msg.session_id,
        'time_to_live': msg.time_to_live,
        'to': msg.to,
        'user_properties': msg.user_properties,
    })

    logging.info(result)

特性

in-process 和 isolated worker process C# 库都使用 ServiceBusTriggerAttribute 属性来定义函数触发器。 C# 脚本改用 function.json 配置文件，如 C# 脚本指南中所述。

独立工作模型
进程模型

下表说明了可使用此触发器特性设置的属性：

属性	说明
队列名称	要监视的队列的名称。仅在监视队列的情况下设置，不为主题设置。
TopicName	要监视的主题的名称。仅在监视主题的情况下设置，不为队列设置。
SubscriptionName	要监视的订阅的名称。仅在监视主题的情况下设置，不为队列设置。
连接	指定如何连接到服务总线的应用设置或设置集合的名称。请参阅连接。
IsBatched	消息分批传送。需要数组或集合类型。
IsSessionsEnabled	如果连接到`true`队列或订阅，则为。否则为 `false`（默认值）。
AutoCompleteMessages	如果触发器应在成功调用后自动完成消息，则为 `true`。如果不应，例如`false`时，则为。如果未显式设置，则行为基于`autoCompleteMessages`中的`host.json`配置。

下表说明了可使用此触发器特性设置的属性：

属性	说明
队列名称	要监视的队列的名称。仅在监视队列的情况下设置，不为主题设置。
TopicName	要监视的主题的名称。仅在监视主题的情况下设置，不为队列设置。
SubscriptionName	要监视的订阅的名称。仅在监视主题的情况下设置，不为队列设置。
连接	指定如何连接到服务总线的应用设置或设置集合的名称。请参阅连接。
访问	连接字符串的访问权限。可用值为 `manage` 和 `listen`。默认值是 `manage`，其指示 `connection` 具有“管理”权限。如果使用没有 Manage 权限的连接字符串，请将 `accessRights` 设置为“listen”。否则，Functions 运行时可能会在尝试执行需要管理权限的操作时失败。 Azure Functions版本 2.x 及更高版本中，此属性不可用，因为最新版本的服务总线 SDK 不支持管理操作。
IsBatched	消息分批传送。需要数组或集合类型。
IsSessionsEnabled	如果连接到`true`队列或订阅，则为。否则为 `false`（默认值）。
AutoComplete	`true` 是触发器在处理后自动调用 complete，还是函数代码手动调用 complete。如果设置为 `true`，则触发器会在函数执行成功完成时自动完成该消息，否则会放弃该消息。如果设置为 `false`，你负责调用 ServiceBusReceiver 方法来完成、放弃消息、会话或批，或将它们放入死信队列。如果引发了异常（并且未调用任何 `ServiceBusReceiver` 方法），则锁仍然存在。锁过期后，消息将重新排队并 `DeliveryCount` 递增，并自动续订锁。

在本地开发时，需要将应用程序设置添加到集合中的 Values中。

修饰符

仅适用于 Python v2 编程 model.

对于使用修饰器定义的 Python v2 函数，service_bus_queue_trigger上的以下属性：

属性	说明
`arg_name`	变量的名称，表示函数代码中的队列或主题消息。
`queue_name`	要监视的队列的名称。仅在监视队列的情况下设置，不为主题设置。
`connection`	指定如何连接到服务总线的应用设置或设置集合的名称。请参阅连接。

有关使用 function.json 定义的Python函数，请参阅 Configuration 部分。

批注

使用 ServiceBusQueueTrigger 批注可以创建在创建服务总线队列消息时运行的函数。可用的配置选项包括以下属性：

属性	说明
名字	变量的名称，表示函数代码中的队列或主题消息。
队列名称	要监视的队列的名称。仅在监视队列的情况下设置，不为主题设置。
topicName	要监视的主题的名称。仅在监视主题的情况下设置，不为队列设置。
订阅名称	要监视的订阅的名称。仅在监视主题的情况下设置，不为队列设置。
连接	指定如何连接到服务总线的应用设置或设置集合的名称。请参阅连接。

使用 ServiceBusTopicTrigger 注释可以指定主题和订阅，以便以触发函数的数据为目标。

在本地开发时，需要将应用程序设置添加到集合中的 Values中。

有关更多详细信息，请参阅触发器示例。

配置

仅适用于 Python v1 编程模型.

模型 v4
模型 v3

下表说明了可以在传递给方法“options”或“app.serviceBusQueue()”的对象“app.serviceBusTopic()”上设置的属性。

属性	说明
队列名称	要监视的队列的名称。仅在监视队列的情况下设置，不为主题设置。
topicName	要监视的主题的名称。仅在监视主题的情况下设置，不为队列设置。
订阅名称	要监视的订阅的名称。仅在监视主题的情况下设置，不为队列设置。
连接	指定如何连接到服务总线的应用设置或设置集合的名称。请参阅连接。
accessRights	连接字符串的访问权限。可用值为 `manage` 和 `listen`。默认值是 `manage`，其指示 `connection` 具有“管理”权限。如果使用没有 Manage 权限的连接字符串，请将 `accessRights` 设置为“listen”。否则，Functions 运行时可能会在尝试执行需要管理权限的操作时失败。 Azure Functions版本 2.x 及更高版本中，此属性不可用，因为最新版本的服务总线 SDK 不支持管理操作。
isSessionsEnabled	如果连接到`true`队列或订阅，则为。否则为 `false`（默认值）。
autoComplete	对于非 C# 函数，此项必须为 `true`，这意味着触发器应在处理后自动调用 complete，或者你会通过函数代码手动调用 complete。设置为 `true` 时，触发器会在函数执行成功完成的情况下自动完成该消息，否则会放弃该消息。函数中的异常会导致后台的运行时调用 `abandonAsync` 。如果未发生异常，则在后台调用 `completeAsync`。此属性仅在 Azure Functions 2.x 及更高版本中可用。

下表解释了在 function.json 文件中设置的绑定配置属性。

属性	说明
类型	必须设置为 `serviceBusTrigger`。在 Azure 门户中创建触发器时，会自动设置此属性。
方向	必须设置为“in”。在 Azure 门户中创建触发器时，会自动设置此属性。
名字	变量的名称，表示函数代码中的队列或主题消息。
队列名称	要监视的队列的名称。仅在监视队列的情况下设置，不为主题设置。
topicName	要监视的主题的名称。仅在监视主题的情况下设置，不为队列设置。
订阅名称	要监视的订阅的名称。仅在监视主题的情况下设置，不为队列设置。
连接	指定如何连接到服务总线的应用设置或设置集合的名称。请参阅连接。
accessRights	连接字符串的访问权限。可用值为 `manage` 和 `listen`。默认值是 `manage`，其指示 `connection` 具有“管理”权限。如果使用没有 Manage 权限的连接字符串，请将 `accessRights` 设置为“listen”。否则，Functions 运行时可能会在尝试执行需要管理权限的操作时失败。 Azure Functions版本 2.x 及更高版本中，此属性不可用，因为最新版本的服务总线 SDK 不支持管理操作。
isSessionsEnabled	如果连接到`true`队列或订阅，则为。否则为 `false`（默认值）。
autoComplete	对于非 C# 函数，此项必须为 `true`，这意味着触发器应在处理后自动调用 complete，或者你会通过函数代码手动调用 complete。设置为 `true` 时，触发器会在函数执行成功完成的情况下自动完成该消息，否则会放弃该消息。函数中的异常会导致后台的运行时调用 `abandonAsync` 。如果未发生异常，则在后台调用 `completeAsync`。此属性仅在 Azure Functions 2.x 及更高版本中可用。

在本地开发时，需要将应用程序设置添加到集合中的 Values中。

下表解释了在 function.json 文件中设置的绑定配置属性。

“function.json”属性	说明
类型	必须设置为 `serviceBusTrigger`。在 Azure 门户中创建触发器时，会自动设置此属性。
方向	必须设置为“in”。在 Azure 门户中创建触发器时，会自动设置此属性。
名字	变量的名称，表示函数代码中的队列或主题消息。
队列名称	要监视的队列的名称。仅在监视队列的情况下设置，不为主题设置。
topicName	要监视的主题的名称。仅在监视主题的情况下设置，不为队列设置。
订阅名称	要监视的订阅的名称。仅在监视主题的情况下设置，不为队列设置。
连接	指定如何连接到服务总线的应用设置或设置集合的名称。请参阅连接。
accessRights	连接字符串的访问权限。可用值为 `manage` 和 `listen`。默认值是 `manage`，其指示 `connection` 具有“管理”权限。如果使用没有 Manage 权限的连接字符串，请将 `accessRights` 设置为“listen”。否则，Functions 运行时可能会在尝试执行需要管理权限的操作时失败。 Azure Functions版本 2.x 及更高版本中，此属性不可用，因为最新版本的服务总线 SDK 不支持管理操作。
isSessionsEnabled	如果连接到`true`队列或订阅，则为。否则为 `false`（默认值）。
autoComplete	对于非 C# 函数，此项必须为 `true`，这意味着触发器应在处理后自动调用 complete，或者你会通过函数代码手动调用 complete。设置为 `true` 时，触发器会在函数执行成功完成的情况下自动完成该消息，否则会放弃该消息。函数中的异常会导致后台的运行时调用 `abandonAsync` 。如果未发生异常，则在后台调用 `completeAsync`。此属性仅在 Azure Functions 2.x 及更高版本中可用。

在本地开发时，需要将应用程序设置添加到集合中的 Values中。

有关完整示例，请参阅示例部分。

使用情况

所有 C# 形式和扩展版本都支持以下参数类型：

类型	说明
System.String	当消息为简单文本时使用。
byte[]	用于二进制数据消息。
对象	当消息包含 JSON 时，Functions 会尝试将 JSON 数据反序列化为已知的普通旧 CLR 对象类型。

特定于消息的参数类型包含其他消息元数据。服务总线触发器支持的特定类型取决于 Functions 运行时版本、扩展包版本和使用的 C# 形式。

使用 ServiceBusReceivedMessage 类型从服务总线队列和订阅接收消息元数据。若要了解详细信息，请参阅消息、有效负载和序列化。

在 C# 类库中，该特性的构造函数采用队列或者主题和订阅的名称。

也可以使用 ServiceBusAccountAttribute 指定要使用的服务总线帐户。构造函数采用包含服务总线连接字符串的应用设置的名称。可以在参数、方法或类级别应用该特性。以下示例演示类级别和方法级别：

[ServiceBusAccount("ClassLevelServiceBusAppSetting")]
public static class AzureFunctions
{
    [ServiceBusAccount("MethodLevelServiceBusAppSetting")]
    [FunctionName("ServiceBusQueueTriggerCSharp")]
    public static void Run(
        [ServiceBusTrigger("myqueue", AccessRights.Manage)] 
        string myQueueItem, ILogger log)
{
    ...
}

要使用的服务总线帐户按以下顺序确定：

ServiceBusTrigger 特性的 Connection 属性。
作为 ServiceBusAccount 特性应用到同一参数的 ServiceBusTrigger 特性。
应用到函数的 ServiceBusAccount 特性。
应用到类的 ServiceBusAccount 特性。
AzureWebJobsServiceBus 应用设置。

使用 Message 类型接收包含元数据的消息。若要了解详细信息，请参阅消息、有效负载和序列化。

2026 年 9 月 30 日，我们将停用 Azure 服务总线 SDK 库 WindowsAzure.ServiceBus Microsoft.Azure。ServiceBus 和 com.microsoft.azure。servicebus 不符合Azure SDK准则。我们还将结束对 SBMP 协议的支持，因此在 2026 年 9 月 30 日之后，你将无法再使用此协议。迁移到最新的Azure SDK库，该库提供关键安全更新和改进功能，并在该日期之前提供改进功能。

尽管旧库仍可在 2026 年 9 月 30 日以后使用，但它们将不再从Microsoft获得官方支持和更新。有关详细信息，请参阅支持停用公告。

在 C# 类库中，该特性的构造函数采用队列或者主题和订阅的名称。

[ServiceBusAccount("ClassLevelServiceBusAppSetting")]
public static class AzureFunctions
{
    [ServiceBusAccount("MethodLevelServiceBusAppSetting")]
    [FunctionName("ServiceBusQueueTriggerCSharp")]
    public static void Run(
        [ServiceBusTrigger("myqueue", AccessRights.Manage)] 
        string myQueueItem, ILogger log)
{
    ...
}

要使用的服务总线帐户按以下顺序确定：

ServiceBusTrigger 特性的 Connection 属性。
作为 ServiceBusAccount 特性应用到同一参数的 ServiceBusTrigger 特性。
应用到函数的 ServiceBusAccount 特性。
应用到类的 ServiceBusAccount 特性。
AzureWebJobsServiceBus 应用设置。

以下参数类型可用于队列或主题消息：

BrokeredMessage - 使用 BrokeredMessage.GetBody<T>() 方法提供反序列化消息。
MessageReceiver - 用于接收和确认来自消息容器的消息（当 autoComplete 设置为 false 时为必需）。

2026 年 9 月 30 日，我们将停用 Azure 服务总线 SDK 库 WindowsAzure.ServiceBus Microsoft.Azure。ServiceBus 和 com.microsoft.azure。servicebus 不符合Azure SDK准则。我们还将结束对 SBMP 协议的支持，因此在 2026 年 9 月 30 日之后，你将无法再使用此协议。迁移到最新的Azure SDK库，该库提供关键安全更新和改进功能，并在该日期之前提供改进功能。

尽管旧库仍可在 2026 年 9 月 30 日以后使用，但它们将不再从Microsoft获得官方支持和更新。有关详细信息，请参阅支持停用公告。

在 C# 类库中，该特性的构造函数采用队列或者主题和订阅的名称。在 Azure Functions 版本 1.x 中，还可以指定连接的访问权限。如果未指定访问权限，则默认为 Manage。

[ServiceBusAccount("ClassLevelServiceBusAppSetting")]
public static class AzureFunctions
{
    [ServiceBusAccount("MethodLevelServiceBusAppSetting")]
    [FunctionName("ServiceBusQueueTriggerCSharp")]
    public static void Run(
        [ServiceBusTrigger("myqueue", AccessRights.Manage)] 
        string myQueueItem, ILogger log)
{
    ...
}

要使用的服务总线帐户按以下顺序确定：

ServiceBusTrigger 特性的 Connection 属性。
作为 ServiceBusAccount 特性应用到同一参数的 ServiceBusTrigger 特性。
应用到函数的 ServiceBusAccount 特性。
应用到类的 ServiceBusAccount 特性。
AzureWebJobsServiceBus 应用设置。

如果希望函数处理单个消息，服务总线触发器可以绑定到以下类型：

类型	说明
`string`	字符串格式的消息。当消息为简单文本时使用。
`byte[]`	消息的字节数。
JSON 可序列化类型	当事件包含 JSON 数据时，Functions 会尝试将 JSON 数据反序列化为普通的旧 CLR 对象 (POCO) 类型。
ServiceBusReceivedMessage¹	消息对象。绑定到 `ServiceBusReceivedMessage` 时，还可以选择包含类型为 ServiceBusMessageActions^1,2 的参数来执行 message settlement 操作。

如果希望函数处理一批消息，服务总线触发器可以绑定到以下类型：

类型	说明
`T[]`，其中 `T` 是单消息类型之一	批处理中的事件数组。每个条目表示一个事件。绑定到 `ServiceBusReceivedMessage[]` 时，还可以选择包含类型为 ServiceBusMessageActions^1,2 的参数来执行 message settlement 操作。

¹ 若要使用这些类型，需要引用 Microsoft.Azure。Functions.Worker.Extensions.ServiceBus 5.14.1 或更高版本和 SDK 类型绑定的 common 依赖项。

² 使用时，将ServiceBusMessageActions的属性设置为 AutoCompleteMessages。这可以防止运行时在成功调用函数后尝试完成消息。

如果未定义 Connection 属性，Functions 将查找名为 AzureWebJobsServiceBus 的应用设置，这是服务总线连接字符串的默认名称。还可以设置 Connection 属性，以指定包含要使用的服务总线连接字符串的应用程序设置的名称。

传入服务总线消息可通过 ServiceBusQueueMessage 或 ServiceBusTopicMessage 参数获得。

模型 v4
模型 v3

将队列或主题消息作为函数的第一个参数访问。服务总线消息作为字符串或 JSON 对象传递到函数中。

服务总线实例可通过在 function.json 文件的名称属性中配置的参数获得。

队列消息可通过类型为 func.ServiceBusMessage 的参数提供给函数。服务总线消息作为字符串或 JSON 对象传递到函数中。

函数还支持Azure 服务总线的 Python SDK 类型绑定，这使你可以使用这些基础 SDK 类型处理数据：

ServiceBusReceivedMessage

重要

Python中对服务总线 SDK 类型的支持处于预览状态，并且仅支持 Python v2 编程模型。有关详细信息，请参阅 Python 中的 SDK 类型。

有关完整示例，请参阅示例部分。

连接

connection 属性引用环境配置，该配置指定应用如何连接到服务总线。它可以指定：

包含连接字符串的应用程序设置的名称。
多个应用程序设置的共享前缀的名称，这些设置共同定义托管标识连接。

如果配置的值既是单个设置的完全匹配，也是其他设置的前缀匹配，则使用完全匹配。

小窍门

使用托管标识连接而不是连接字符串来提高安全性。连接字符串包括可公开的凭据，而托管标识无需管理机密。

托管标识
连接字符串

如果使用扩展的 version 5.x 或更高版本，而不是将连接字符串与机密一起使用，则可以让应用使用 Microsoft Entra 标识。若要使用托管标识，请在映射到触发器和绑定配置中的属性的通用前缀 connection 下定义设置。

在此模式下，扩展需要以下应用程序设置：

基于模板的设置	说明	标识类型
`<CONNECTION_NAME_PREFIX>__fullyQualifiedNamespace`	完全限定服务总线命名空间。	系统分配或用户分配
`<CONNECTION_NAME_PREFIX>__credential`	必须设置为 `managedidentity`。	由用户指派
`<CONNECTION_NAME_PREFIX>__clientId`	用户分配的托管标识的客户端 ID。	由用户指派

替换为的值 <CONNECTION_NAME_PREFIX> 将绑定扩展视为连接设置的名称。

例如，如果绑定配置使用 connection = "ServiceBusConnection" 用户分配的托管标识指定，则配置以下应用程序设置：

{
    "ServiceBusConnection__fullyQualifiedNamespace": "myservicebus.servicebus.windows.net",
    "ServiceBusConnection__credential": "managedidentity",
    "ServiceBusConnection__clientId": "00000000-0000-0000-0000-000000000000"
}

小窍门

对生产方案使用用户分配的托管标识，需要对跨多个资源的标识权限进行精细控制。

可以使用模板中的其他设置进一步自定义连接。请参阅基于标识的连接的通用属性。

注意

使用 Azure 应用程序配置或密钥保管库提供托管标识连接的设置时，设置名称应使用有效的密钥分隔符（如或 >），< 以确保正确解析名称。

例如：ServiceBusConnection:fullyQualifiedNamespace

在Azure Functions服务中托管时，基于标识的连接使用托管标识。默认情况下使用系统分配的标识，但可以使用 credential 和 clientID 属性来指定用户分配的标识。请注意，不支持为用户分配的标识配置资源 ID。在其他上下文（如本地开发）中运行时，将改用开发人员标识，尽管可以进行自定义。请参阅使用基于标识的连接进行本地开发。

向标识授予权限

无论使用何种标识，都必须具有执行所需操作的权限。对于大多数Azure服务，这意味着需要使用提供这些权限的内置角色或自定义角色在 Azure RBAC 中分配角色。

重要

某些权限可能由并非所有上下文都需要的目标服务公开。尽可能遵循最低权限原则，仅授予标识所需的权限。例如，如果应用只需要从数据源进行读取即可，则使用仅具有读取权限的角色。分配一个也具有该服务写入权限的角色并不恰当，因为对于读取操作来说，写入是多余的权限。同样，你也希望确保角色分配的范围仅限于需要读取的资源。

你将需要创建一个角色分配，以便在运行时提供对主题和队列的访问权限。所有者等管理角色还不够。下表显示了在正常操作中使用服务总线扩展时建议的内置角色。根据所编写的代码，应用程序可能需要具有其他权限。

绑定类型	内置角色示例
触发器¹	Azure 服务总线数据接收器 Azure 服务总线数据所有者
输出绑定	Azure 服务总线数据发送方

¹ 若要从服务总线主题触发，角色分配需要对服务总线订阅资源具有有效的范围。如果仅包含主题，将发生错误。某些客户端（如Azure门户）不会将服务总线订阅资源公开为角色分配的范围。在这种情况下，可以改用Azure CLI。若要了解详细信息，请参阅 Azure Azure 服务总线的内置角色。

按照获取管理凭据。需要服务总线命名空间的连接字符串，而不是仅限于特定队列或主题的命名空间。

将此连接字符串存储在与绑定配置的 connection 属性中指定的值匹配的应用设置中。

如果应用设置名称以开头 AzureWebJobs，则只需指定名称的其余部分。例如，如果设置为connectionMyServiceBus，Functions 运行时将查找名为AzureWebJobsMyServiceBus“的应用”设置。如果将 connection 留空，Functions 运行时将使用名为 AzureWebJobsServiceBus 的应用设置中的默认服务总线连接字符串。

有害消息

无法在Azure Functions中控制或配置病毒消息处理。服务总线处理有害消息本身。

PeekLock 行为

Functions 运行时以 PeekLock 模式接收消息。

默认情况下，如果函数成功完成，则运行时会对此消息调用 Complete；如果函数失败，则调用 Abandon。可以通过 autoCompleteMessages 中的 host.json 属性禁用自动完成。

默认情况下，如果函数成功完成，则运行时会对此消息调用 Complete；如果函数失败，则调用 Abandon。可以通过 autoCompleteMessages 中的 host.json 属性或通过触发器特性上的一个属性来禁用自动完成。如果你的函数代码处理消息结算，则应禁用自动完成。

如果函数的运行时间长于 PeekLock 超时时间，则只要该函数正在运行，就会自动续订锁定。 maxAutoRenewDuration 在 host.json 中可配置，它映射到 serviceBusProcessor.MaxAutoLockRenewalDuration。此设置的默认值为 5 分钟。

消息元数据

使用特定于消息传送的类型，你可以轻松地检索作为对象属性的元数据。这些属性取决于 Functions 运行时版本、扩展包版本和所使用的 C# 形式。

这些属性是 ServiceBusReceivedMessage 类的成员。

属性	类型	说明
`ApplicationProperties`	`ApplicationProperties`	由发送方设置的属性。
`ContentType`	`string`	发送方和接收方用于实现应用程序特定逻辑的内容类型标识符。
`CorrelationId`	`string`	相关 ID。
`DeliveryCount`	`Int32`	传递次数。
`EnqueuedTime`	`DateTime`	排队时间 (UTC)。
`ScheduledEnqueueTimeUtc`	`DateTime`	计划的排队时间 (UTC)。
`ExpiresAt`	`DateTime`	到期时间 (UTC)。
`MessageId`	`string`	用户定义值，服务总线可用于标识重复消息（如果已启用）。
`ReplyTo`	`string`	对队列地址的回复。
`Subject`	`string`	特定于应用程序的标签，可用于替代 `Label` 元数据属性。
`To`	`string`	发送到地址。

以下属性是 Message 类的成员。

2026 年 9 月 30 日，我们将停用 Azure 服务总线 SDK 库 WindowsAzure.ServiceBus Microsoft.Azure。ServiceBus 和 com.microsoft.azure。servicebus 不符合Azure SDK准则。我们还将结束对 SBMP 协议的支持，因此在 2026 年 9 月 30 日之后，你将无法再使用此协议。迁移到最新的Azure SDK库，该库提供关键安全更新和改进功能，并在该日期之前提供改进功能。

尽管旧库仍可在 2026 年 9 月 30 日以后使用，但它们将不再从Microsoft获得官方支持和更新。有关详细信息，请参阅支持停用公告。

属性	类型	说明
`ContentType`	`string`	发送方和接收方用于实现应用程序特定逻辑的内容类型标识符。
`CorrelationId`	`string`	相关 ID。
`DeliveryCount`	`Int32`	传递次数。
`ScheduledEnqueueTimeUtc`	`DateTime`	计划的排队时间 (UTC)。
`ExpiresAtUtc`	`DateTime`	到期时间 (UTC)。
`Label`	`string`	应用程序特定的标签。
`MessageId`	`string`	用户定义值，服务总线可用于标识重复消息（如果已启用）。
`ReplyTo`	`string`	对队列地址的回复。
`To`	`string`	发送到地址。
`UserProperties`	`IDictionary<string, object>`	由发送方设置的属性。

以下属性是 BrokeredMessage 和 MessageReceiver 类的成员。

2026 年 9 月 30 日，我们将停用 Azure 服务总线 SDK 库 WindowsAzure.ServiceBus Microsoft.Azure。ServiceBus 和 com.microsoft.azure。servicebus 不符合Azure SDK准则。我们还将结束对 SBMP 协议的支持，因此在 2026 年 9 月 30 日之后，你将无法再使用此协议。迁移到最新的Azure SDK库，该库提供关键安全更新和改进功能，并在该日期之前提供改进功能。

尽管旧库仍可在 2026 年 9 月 30 日以后使用，但它们将不再从Microsoft获得官方支持和更新。有关详细信息，请参阅支持停用公告。

属性	类型	说明
`ContentType`	`string`	发送方和接收方用于实现应用程序特定逻辑的内容类型标识符。
`CorrelationId`	`string`	相关 ID。
`DeadLetterSource`	`string`	死信源。
`DeliveryCount`	`Int32`	传递次数。
`EnqueuedTimeUtc`	`DateTime`	排队时间 (UTC)。
`ExpiresAtUtc`	`DateTime`	到期时间 (UTC)。
`Label`	`string`	应用程序特定的标签。
`MessageId`	`string`	用户定义值，服务总线可用于标识重复消息（如果已启用）。
`MessageReceiver`	`MessageReceiver`	服务总线消息接收器。可以用于放弃、完成消息或将消息放入死信队列。
`MessageSession`	`MessageSession`	专用于已启用会话的队列和主题的消息接收器。
`ReplyTo`	`string`	对队列地址的回复。
`SequenceNumber`	`long`	由服务总线分配给消息的唯一编号。
`To`	`string`	发送到地址。
`UserProperties`	`IDictionary<string, object>`	由发送方设置的属性。

这些属性是 ServiceBusReceivedMessage 类的成员。

属性	类型	说明
`ApplicationProperties`	`ApplicationProperties`	由发送方设置的属性。
`ContentType`	`string`	发送方和接收方用于实现应用程序特定逻辑的内容类型标识符。
`CorrelationId`	`string`	相关 ID。
`DeliveryCount`	`Int32`	传递次数。
`EnqueuedTime`	`DateTime`	排队时间 (UTC)。
`ScheduledEnqueueTimeUtc`	`DateTime`	计划的排队时间 (UTC)。
`ExpiresAt`	`DateTime`	到期时间 (UTC)。
`MessageId`	`string`	用户定义值，服务总线可用于标识重复消息（如果已启用）。
`ReplyTo`	`string`	对队列地址的回复。
`Subject`	`string`	特定于应用程序的标签，可用于替代 `Label` 元数据属性。
`To`	`string`	发送到地址。

后续步骤

从 Azure Functions（输出绑定）

反馈

此页面是否有帮助？

Last updated on 2026-04-14

通过

Azure Functions的Azure 服务总线触发器

示例

特性

修饰符

批注

配置

使用情况

连接

向标识授予权限

有害消息

PeekLock 行为

消息元数据

后续步骤

反馈

其他资源