Azure Service Bus Transport Upgrade Version 2 to 3

This is part of the NServiceBus Upgrade Guide from Version 7 to 8, which also includes the following individual upgrade guides for specific components:

Feature Details

Transports

Persistence

Other

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 via a shim API to ease migration. 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 option	Version 3 configuration option
TopicName	TopicName
EntityMaximumSize	EntityMaximumSize
EnablePartitioning	EnablePartitioning
PrefetchMultiplier	PrefetchMultiplier
PrefetchCount	PrefetchCount
TimeToWaitBeforeTriggeringCircuitBreaker	TimeToWaitBeforeTriggeringCircuitBreaker
SubscriptionNameShortener	SubscriptionNamingConvention
SubscriptionNamingConvention	SubscriptionNamingConvention
RuleNameShortener	SubscriptionRuleNamingConvention
SubscriptionRuleNamingConvention	SubscriptionRuleNamingConvention
UseWebSockets	UseWebSockets
TokenCredential	Overloaded constructor of the transport
CustomRetryPolicy	RetryPolicy

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.

Copy code|Copy usings|Edit

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.

Copy code|Copy usings|Edit

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 did not support extending the message lock past five minutes, though custom code may have attempted to implement this functionality. Custom implementations should be removed and the built-in lock renewal feature should be used instead.