Message Headers

This section lists the headers you can map for the Connector for Azure Service Bus.

To map and transform Solace and Azure Service Bus message headers and payloads, see Mapping Message Headers and Payloads.

Headers for Azure Service Bus as a Source

This section lists the headers you can map when Azure Service Bus is configured as a source.

Azure Service Bus Source Headers

Name Type Description
azure_service_bus_correlation_id String The correlation ID of the message.
azure_service_bus_message_id String An application-defined value that uniquely identifies the message and its payload.
azure_service_bus_partition_key String The partition key for sending the message to a partitioned entity.
azure_service_bus_session_id String The session identifier for a session-aware entity.
azure_service_bus_delivery_count Long The number of the times the message has been delivered to clients.
azure_service_bus_enqueued_sequence_number Long The enqueued sequence number assigned to a message by Service Bus.
azure_service_bus_sequence_number Long The unique number assigned to a message by Service Bus.
azure_service_bus_subject String The subject for the message.

Solace Target Headers

Name Type Description
scst_targetDestination String A dynamic destination for the message.
solace_applicationMessageId String The message ID (a string for an application-specific message identifier).
solace_applicationMessageType String The application message type.
solace_correlationId String The correlation ID of the message.
solace_dmqEligible Boolean Indicates whether the message is eligible to be moved to a dead message queue (DMQ).
solace_expiration Long The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
solace_httpContentEncoding String The HTTP content encoding header value from interaction with an HTTP client.
solace_isReply Boolean Indicates whether the message is a reply to another message.
solace_priority Integer The message priority value in the range of 0-255, or -1 if it is not set.
solace_senderId String The sender ID for the message.
solace_senderTimestamp Long The send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
solace_sequenceNumber Long The sequence number.
solace_timeToLive Long The number of milliseconds before the message is discarded or moved to a dead message queue (DMQ).

Headers for Azure Service Bus as a Target

This section lists the headers you can map when Azure Service Bus is configured as a target.

Solace Source Headers

Name Type Description
solace_applicationMessageId String The message ID (a string for an application-specific message identifier).
solace_applicationMessageType String The application message type.
solace_correlationId String The correlation ID of the message.
solace_deliveryCount Integer The number of times the message has been delivered to clients.
solace_discardIndication Boolean Indicates whether one or more messages have been discarded prior to the current message.
solace_dmqEligible Boolean Indicates whether the message is eligible to be moved to a dead message queue (DMQ).
solace_expiration Long The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is set to expire.
solace_httpContentEncoding String The HTTP content encoding header value from interaction with an HTTP client.
solace_isReply Boolean Indicates whether the message is a reply to another message.
solace_priority Integer The message priority value in the range of 0-255, or -1 if it is not set.
solace_receiveTimestamp Long The receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
solace_redelivered Boolean Indicates whether the event broker has delivered the message to the API before.
solace_senderId String The sender ID for the message.
solace_senderTimestamp Long The send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
solace_sequenceNumber Long The sequence number.
solace_timeToLive Long The number of milliseconds before the message is discarded or moved to a dead message queue (DMQ).

Azure Service Bus Target Headers

Name Type Description
scst_targetDestination String A dynamic destination for the message.
solace_connector_scst_targetDestinationType String Specifies the destination type of the dynamic destination. When unspecified, the configured or default destination type is used.
azure_service_bus_correlation_id String The correlation ID of the message.
azure_service_bus_message_id String An application-defined value that uniquely identifies the message and its payload.
azure_service_bus_partition_key String The partition key for sending the message to a partitioned entity.
azure_service_bus_session_id String The session identifier for a session-aware entity.

The session ID has higher priority than the partition key. When both azure_partition_key and azure_session_id headers are set, the value of the session ID overwrites the value of the partition key.

Reserved Message Headers

The following are reserved header spaces:

Any headers with these prefixes (that are not defined by the connector or any technology used by the connector) may not be backwards compatible in future releases of this connector.