Azure Service Bus SDK retirement and Message Bus transport options for XP 10.4 and earlier


Description

Microsoft has announced the retirement of the following legacy Azure Service Bus SDK libraries, effective 30 September 2026:

After this date, these libraries are no longer supported or updated by Microsoft. Migration to the current Azure SDK libraries, such as Azure.Messaging.ServiceBus for .NET applications, is recommended by Microsoft. Support for the Service Bus Messaging Protocol (SBMP) was also ended by Microsoft on the same date.

Impact on Sitecore XP

In Sitecore XP 10.4 and earlier, the legacy Microsoft.Azure.ServiceBus library is used when Azure Service Bus is configured as the Message Bus transport. In Sitecore XP 10.5, the newer Azure SDK is used.

Based on the assessment, the end of SBMP support has no known impact on Sitecore XP messaging. However, because Microsoft no longer supports the legacy library, future fixes or updates are not expected. The options in the Solution section below can be used to move to a supported configuration.

Note: This article applies to Sitecore Experience Platform 10.4 and earlier when Azure Service Bus is configured as the Message Bus transport.

Solution

To address the retirement of the legacy Azure Service Bus SDK libraries, the following options can be used to move to a supported configuration:

  1. Upgrade to Sitecore XP 10.5

    Upgrading to Sitecore XP 10.5 is the recommended option when Azure Service Bus must remain the Message Bus transport. The XP 10.5 upgrade must be planned according to the relevant topology and upgrade documentation. The Sitecore XP 10.5 download page provides the release-specific upgrade resources and configuration files.

    Sitecore XP 10.5 uses the supported Azure.Messaging.ServiceBus client and removes the dependency on the retired Azure Service Bus SDK libraries.

    Before performing the upgrade, review the Sitecore XP 10.5 release notes and upgrade documentation for applicable infrastructure, compatibility, and topology requirements.

    For additional information, refer to:

  2. Change the Message Bus transport to SQL

    If Azure Service Bus is not specifically required, change the Message Bus transport to SQL.

    Note: The transport change is deployment-wide. Apply the SQL messaging configuration consistently to every Sitecore XP role and continuous job that uses messaging. Azure Service Bus and SQL transport configurations must not be enabled together for the same role.

    Before changing the transport:

    1. Provision or identify the Sitecore Messaging SQL database for the installed Sitecore XP version.
    2. Obtain the Messaging database DACPAC that matches the installed Sitecore XP version from the official Sitecore download page for the installed version or from Sitecore Support. After that, deploy the matching Messaging database schema and configure the required credentials.
    3. Plan a maintenance window.
    4. Process or drain existing Azure Service Bus queues where possible. Messages remaining in Azure Service Bus are not migrated to the SQL transport.
    5. Back up the existing configuration to provide a rollback option.

    To change the transport:

    1. Set the messagingTransport:define value to SQL on every applicable IIS role, such as the Content Management, Content Delivery, and Processing roles.
    2. Configure the messaging connection string to reference the same Messaging SQL database on every role that uses messaging.
    3. Disable the Azure Service Bus messaging configuration files and enable the corresponding SQL messaging configuration files on applicable xConnect, Marketing Automation, Cortex, EXM, and continuous-job roles.

      For standard xConnect and EXM configurations:

      • Rename sc.XConnect.Messaging.Azure.xml to sc.XConnect.Messaging.Azure.xml.disabled
      • Rename sc.EmailCampaign.Messaging.Azure.xml to sc.EmailCampaign.Messaging.Azure.xml.disabled
      • Enable sc.XConnect.Messaging.SqlServer.xml, when present, by removing the .disabled extension.
      • Enable sc.EmailCampaign.Messaging.SqlServer.xml, when present, by removing the .disabled extension.
      • Apply the equivalent changes in every affected continuous-job configuration directory.
    4. Remove or disable obsolete Microsoft.Azure.ServiceBus assemblies only after all affected roles and jobs have been switched to the SQL transport.
    5. Restart the affected Sitecore applications and continuous jobs.

    Use only configuration files and database schemas that correspond to the installed Sitecore XP version. File names and deployment locations can vary according to the Sitecore XP version, topology, and hosting model. Configuration files from another Sitecore XP version or deployment must not be copied without validation.

After restarting the affected applications and jobs, verify the following: