Getting Started
NServiceBus
Persistence
ServiceInsight
ServicePulse
ServiceControl
Monitoring
Previews
Samples

Azure Service Bus Transport Upgrade Version 2 to 3

Configuring the Azure Service Bus transport

To use the Azure Service Bus transport for NServiceBus, create a new instance of AzureServiceBusTransport and pass it to EndpointConfiguration.UseTransport.

Instead of:

var transport = endpointConfiguration.UseTransport<AzureServiceBusTransport>();
transport.ConnectionString(connectionString);

Use:

var transport = new AzureServiceBusTransport(connectionString);
endpointConfiguration.UseTransport(transport);
The existing API surface with UseTransport<T>() is supported for NServiceBus version 8 via a shim API to ease migration to the new version. However, it is recommended to switch to the new transport configuration API to prepare for future upgrades of NServiceBus.

Configuration options

The Azure Service Bus transport configuration options have been moved to the AzureServiceBusTransport class. See the following table for further information:

Version 2 configuration optionVersion 3 configuration option
TopicNameTopicName
EntityMaximumSizeEntityMaximumSize
EnablePartitioningEnablePartitioning
PrefetchMultiplierPrefetchMultiplier
PrefetchCountPrefetchCount
TimeToWaitBeforeTriggeringCircuitBreakerTimeToWaitBeforeTriggeringCircuitBreaker
SubscriptionNameShortenerSubscriptionNamingConvention
SubscriptionNamingConventionSubscriptionNamingConvention
RuleNameShortenerSubscriptionRuleNamingConvention
SubscriptionRuleNamingConventionSubscriptionRuleNamingConvention
UseWebSocketsUseWebSockets
TokenCredentialOverloaded constructor of the transport
CustomRetryPolicyRetryPolicy

TokenCredential

Previously when using CustomTokenCredential or TokenCredential it was required to pass a fully-qualified namespace (e.g. <asb-namespace-name>.servicebus.windows.net) instead of a connection string (e.g. Endpoint=sb://<asb-namespace-name>.servicebus.windows.net>;[...]). The dual purpose of the connection-string option has been removed. To use TokenCredential pass the credential plus the fully-qualified namespace to the constructor of the transport.

var transportWithTokenCredentials = new AzureServiceBusTransport("[NAMESPACE].servicebus.windows.net", new DefaultAzureCredential());
endpointConfiguration.UseTransport(transportWithTokenCredentials);

Accessing the native incoming message

The Azure.Messaging.ServiceBus client SDK introduces a set of new classes to represent messages. Previously there was only the Message class to represent either an incoming message or an outgoing message. With the new client SDK the incoming message type is ServiceBusReceivedMessage. If access to the native incoming message is required, make sure the correct type is used. See the native message customization documentation for further details.

Native message customization

IMessageHandlerContext and IPipelineContext no longer need to be passed to the CustomizeNativeMessage method. See the native message customization documentation for further details.

Auto-lock renewal

The auto-lock renewal is now supported for an extended period of time and can be customized by specifying MaxAutoLockRenewalDuration.

transport.MaxAutoLockRenewalDuration = TimeSpan.FromMinutes(10);

Transaction timeout

The transport now allows transactions to take longer than the default TransactionManager.MaximumTimeout. It is no longer required to override the maximum timeout.

Advanced/custom lock renewal

Previous versions of the transport required custom lock renewal logic to extend the renewal beyond five minutes, as outlined by the lock renewal sample. While this scenario still works as expected, it is encouraged to leverage the built-in lock renewal mechanism. Existing custom lock renewal implementations are required to change from

context.Extensions<ServiceBusReceiver>();

to

context.Extensions<ProcessMessageEventArgs>();

Related Articles


Last modified