Azure Functions integrates with Azure Service Bus via triggers and bindings. Integrating with Service Bus allows you to build functions that react to and send queue or topic messages.
Install extensionThe extension NuGet package you install depends on the C# mode you're using in your function app:
The functionality of the extension varies depending on the extension version:
Binding typesThe binding types supported for .NET depend on both the extension version and C# execution mode, which can be one of the following:
An isolated worker process class library compiled C# function runs in a process isolated from the runtime.
An in-process class library is a compiled C# function runs in the same process as the Functions runtime.
Choose a version to see binding type details for the mode and version.
The Service Bus extension supports parameter types according to the table below.
1 Messages containing JSON data can be deserialized into known plain-old CLR object (POCO) types.
2 Advanced scenarios include message settlement, sessions, and transactions. These types are available as separate parameters in addition to the normal trigger parameter.
Earlier versions of the extension exposed types from the now deprecated Microsoft.Azure.ServiceBus namespace. Newer types from Azure.Messaging.ServiceBus are exclusive to Extension 5.x+.
On 30 September 2026, we'll retire the Azure Service Bus SDK libraries WindowsAzure.ServiceBus, Microsoft.Azure.ServiceBus, and com.microsoft.azure.servicebus, which don't conform to Azure SDK guidelines. We'll also end support of the SBMP protocol, so you'll no longer be able to use this protocol after 30 September 2026. Migrate to the latest Azure SDK libraries, which offer critical security updates and improved capabilities, before that date.
Although the older libraries can still be used beyond 30 September 2026, they'll no longer receive official support and updates from Microsoft. For more information, see the support retirement announcement.
This version of the extension supports parameter types according to the table below.
The Service Bus extension supports parameter types according to the table below.
Binding scenario Parameter types Service Bus trigger (single message) [Microsoft.Azure.ServiceBus.Message]string
byte[]
ServiceBusReceivedMessage[]
string[] Service Bus trigger advanced scenarios2 IMessageReceiver
string
byte[]
ICollector<T> or IAsyncCollector<T> where T is one of the single message types
1 Messages containing JSON data can be deserialized into known plain-old CLR object (POCO) types.
2 Advanced scenarios include message settlement, sessions, and transactions. These types are available as separate parameters in addition to the normal trigger parameter.
Functions 1.x exposed types from the deprecated Microsoft.ServiceBus.Messaging namespace. Newer types from Azure.Messaging.ServiceBus are exclusive to Extension 5.x+. To use these, you will need to upgrade your application to Functions 4.x.
On 30 September 2026, we'll retire the Azure Service Bus SDK libraries WindowsAzure.ServiceBus, Microsoft.Azure.ServiceBus, and com.microsoft.azure.servicebus, which don't conform to Azure SDK guidelines. We'll also end support of the SBMP protocol, so you'll no longer be able to use this protocol after 30 September 2026. Migrate to the latest Azure SDK libraries, which offer critical security updates and improved capabilities, before that date.
Although the older libraries can still be used beyond 30 September 2026, they'll no longer receive official support and updates from Microsoft. For more information, see the support retirement announcement.
The isolated worker process supports parameter types according to the tables below.
Service Bus trigger
When you want the function to process a single message, the Service Bus trigger can bind to the following types:
Type Descriptionstring The message as a string. Use when the message is simple text. byte[] The bytes of the message. JSON serializable types When an event contains JSON data, Functions tries to deserialize the JSON data into a plain-old CLR object (POCO) type. ServiceBusReceivedMessage1 The message object.
When binding to ServiceBusReceivedMessage, you can optionally also include a parameter of type ServiceBusMessageActions1,2 to perform message settlement actions.
When you want the function to process a batch of messages, the Service Bus trigger can bind to the following types:
Type DescriptionT[] where T is one of the single message types An array of events from the batch. Each entry represents one event.
When binding to ServiceBusReceivedMessage[], you can optionally also include a parameter of type ServiceBusMessageActions1,2 to perform message settlement actions.
1 To use these types, you need to reference Microsoft.Azure.Functions.Worker.Extensions.ServiceBus 5.14.1 or later and the common dependencies for SDK type bindings.
2 When using ServiceBusMessageActions, set the AutoCompleteMessages property of the trigger attribute to false. This prevents the runtime from attempting to complete messages after a successful function invocation.
Service Bus output binding
When you want the function to write a single message, the Service Bus output binding can bind to the following types:
Type Descriptionstring The message as a string. Use when the message is simple text. byte[] The bytes of the message. JSON serializable types An object representing the message. Functions attempts to serialize a plain-old CLR object (POCO) type into JSON data.
When you want the function to write multiple messages, the Service Bus output binding can bind to the following types:
Type DescriptionT[] where T is one of the single message types An array containing multiple message. Each entry represents one message.
For other output scenarios, create and use a ServiceBusClient with other types from Azure.Messaging.ServiceBus directly. See Register Azure clients for an example of using dependency injection to create a client type from the Azure SDK.
Earlier versions of extensions in the isolated worker process only support binding to string, byte[], and JSON serializable types. Additional options are available to Extension 5.x+.
Functions version 1.x doesn't support isolated worker process. To use the isolated worker model, upgrade your application to Functions 4.x.
This section describes the configuration settings available for this binding, which depends on the runtime and extension version.
{
"version": "2.0",
"extensions": {
"serviceBus": {
"clientRetryOptions":{
"mode": "exponential",
"tryTimeout": "00:01:00",
"delay": "00:00:00.80",
"maxDelay": "00:01:00",
"maxRetries": 3
},
"prefetchCount": 0,
"transportType": "amqpWebSockets",
"webProxy": "https://proxyserver:8080",
"autoCompleteMessages": true,
"maxAutoLockRenewalDuration": "00:05:00",
"maxConcurrentCalls": 16,
"maxConcurrentSessions": 8,
"maxMessageBatchSize": 1000,
"minMessageBatchSize": 1,
"maxBatchWaitTime": "00:00:30",
"sessionIdleTimeout": "00:01:00",
"enableCrossEntityTransactions": false
}
}
}
The clientRetryOptions settings only apply to interactions with the Service Bus service. They don't affect retries of function executions. For more information, see Retries.
Exponential The approach to use for calculating retry delays. The default exponential mode retries attempts with a delay based on a back-off strategy where each attempt increases the wait duration before retrying. The Fixed mode retries attempts at fixed intervals with each delay having a consistent duration. tryTimeout 00:01:00 The maximum duration to wait for an operation per attempt. delay 00:00:00.80 The delay or back-off factor to apply between retry attempts. maxDelay 00:01:00 The maximum delay to allow between retry attempts maxRetries 3 The maximum number of retry attempts before considering the associated operation to have failed. prefetchCount 0 Gets or sets the number of messages that the message receiver can simultaneously request. transportType amqpTcp The protocol and transport that is used for communicating with Service Bus. Available options: amqpTcp, amqpWebSockets webProxy n/a The proxy to use for communicating with Service Bus over web sockets. A proxy cannot be used with the amqpTcp transport. autoCompleteMessages true Determines whether or not to automatically complete messages after successful execution of the function. maxAutoLockRenewalDuration 00:05:00 The maximum duration within which the message lock will be renewed automatically. This setting only applies for functions that receive a single message at a time. maxConcurrentCalls 16 By default, the Functions runtime processes multiple messages concurrently. This setting limits the maximum number of concurrent calls to the callback that can be initiated per-scaled-instance. When your hosting plan has more than one core per instance, the maximum number of calls is effectively multiplied by the number of cores. For example, in a plan that runs on hardware with two cores, the default setting of 16 means that the maximum number of concurrent calls per instance is really 32 (or 2 * 16). This setting is used only when the isSessionsEnabled property or attribute on the trigger is set to false. This setting only applies for functions that receive a single message at a time as opposed to in a batch. maxConcurrentSessions 8 The maximum number of sessions that can be handled concurrently per scaled instance. This setting is used only when the isSessionsEnabled property or attribute on the trigger is set to true. This setting only applies for functions that receive a single message at a time. maxMessageBatchSize 1000 The maximum number of messages that will be passed to each function call. This setting only applies for functions that receive a batch of messages. minMessageBatchSize1 1 The minimum number of messages desired in a batch. The minimum applies only when the function is receiving multiple messages and must be less than maxMessageBatchSize.
maxBatchWaitTime has elapsed. maxBatchWaitTime1 00:00:30 The maximum interval that the trigger should wait to fill a batch before invoking the function. The wait time is only considered when minMessageBatchSize is larger than 1 and is ignored otherwise. If less than minMessageBatchSize messages were available before the wait time elapses, the function is invoked with a partial batch. The longest allowed wait time is 50% of the entity message lock duration, meaning the maximum allowed is 2 minutes and 30 seconds. Otherwise, you may get lock exceptions.
NOTE: This interval is not a strict guarantee for the exact timing on which the function is invoked. There is a small margin of error due to timer precision.
sessionIdleTimeout n/a The maximum amount of time to wait for a message to be received for the currently active session. After this time has elapsed, the session will be closed and the function will attempt to process another session. enableCrossEntityTransactionsfalse Whether or not to enable transactions that span multiple entities on a Service Bus namespace.
1 Using minMessageBatchSize and maxBatchWaitTime requires v5.10.0 of the Microsoft.Azure.WebJobs.Extensions.ServiceBus package, or a later version.
{
"version": "2.0",
"extensions": {
"serviceBus": {
"prefetchCount": 100,
"messageHandlerOptions": {
"autoComplete": true,
"maxConcurrentCalls": 32,
"maxAutoRenewDuration": "00:05:00"
},
"sessionHandlerOptions": {
"autoComplete": false,
"messageWaitTimeout": "00:00:30",
"maxAutoRenewDuration": "00:55:00",
"maxConcurrentSessions": 16
},
"batchOptions": {
"maxMessageCount": 1000,
"operationTimeout": "00:01:00",
"autoComplete": true
}
}
}
}
When you set the isSessionsEnabled property or attribute on the trigger to true, the sessionHandlerOptions is honored. When you set the isSessionsEnabled property or attribute on the trigger to false, the messageHandlerOptions is honored.
0 Gets or sets the number of messages that the message receiver can simultaneously request. maxAutoRenewDuration 00:05:00 The maximum duration within which the message lock will be renewed automatically. autoComplete true Whether the trigger should automatically call complete after processing, or if the function code manually calls complete.
Setting to false is only supported in C#.
When set to true, the trigger completes the message, session, or batch automatically when the function execution completes successfully, and abandons the message otherwise.
When set to false, you are responsible for calling ServiceBusReceiver methods to complete, abandon, or deadletter the message, session, or batch. When an exception is thrown (and none of the ServiceBusReceiver methods are called), then the lock remains. Once the lock expires, the message is re-queued with the DeliveryCount incremented and the lock is automatically renewed.
In non-C# functions, exceptions in the function results in the runtime calls abandonAsync in the background. If no exception occurs, then completeAsync is called in the background.
16 The maximum number of concurrent calls to the callback that the message pump should initiate per scaled instance. By default, the Functions runtime processes multiple messages concurrently. maxConcurrentSessions 2000 The maximum number of sessions that can be handled concurrently per scaled instance. maxMessageCount 1000 The maximum number of messages sent to the function when triggered. operationTimeout 00:01:00 A time span value expressed in hh:mm:ss.
For a reference of host.json in Functions 1.x, see host.json reference for Azure Functions 1.x.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4