This document describes how to consume messages from and send messages to non-NServiceBus endpoints via Azure Storage Queues in integration scenarios.
Sending native messages
Sending native messages can be accomplished by sending a message with a JSON-serialized payload using the QueueClient. Refer to the sample for more information.
Custom envelope unwrapper
Azure Storage Queues lacks native header support. NServiceBus solves this by wrapping headers and message body in a custom envelope structure. This envelope is serialized using the configured serializer for the endpoint before being sent.
Creating this envelope can cause unnecessary complexity if headers are not needed, as is the case in native integration scenarios. For this reason, NServiceBus.Transport.AzureStorageQueues 9.0 and above support configuring a custom envelope unwrapper.
In this scenario, NServiceBus may place messages in your queue in addition to the native messages that are expected, for example if a message results in a delayed retry. Any custom envelope unwrapper must verify if the incoming message is capable of being deserialized as a native message, and the resulting body must be serialized according to the configured endpoint serializer. If either of these conditions cannot be met then MessageUnwrapper should return null to allow the default unwrapper to handle the message.
The snippet below shows custom unwrapping logic that enables both NServiceBus formatted and plain serialized messages to be consumed.
var transport = new AzureStorageQueueTransport("connection string")
{
MessageUnwrapper = queueMessage =>
{
//Determine whether the message is one expected by the standard program flow.
// All other messages should be forwarded to the framework by returning null.
//NOTE: More complex methods may be needed in some scenarios to determine
// whether the message is of an expected type, but this check
// should be kept as lightweight as possible. Deserialization of the message
// body happens later in the pipeline.
return queueMessage.MessageText.Contains("MyMessageIdFieldName") &&
queueMessage.MessageText.Contains("MyMessageCustomPropertyFieldName")
//this was a native message just return the body as is with no headers
? new MessageWrapper
{
Id = queueMessage.MessageId,
Headers = [],
Body = queueMessage.Body.ToArray()
}
: null;
}
};
endpointConfiguration.UseTransport(transport);
This feature is currently NOT compatible with ServiceControl. A ServiceControl transport adapter is required to leverage both.