From eb10524a9cc28af4ca5da399beb0b3cdca364c1e Mon Sep 17 00:00:00 2001 From: Ryan Thomas Date: Thu, 18 Sep 2025 15:07:20 -0500 Subject: [PATCH 1/2] Add Azure Service Bus upgrade guide for v5 to v6 --- menu/menu.yaml | 2 ++ transports/upgrades/asbs-5to6.md | 16 ++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 transports/upgrades/asbs-5to6.md diff --git a/menu/menu.yaml b/menu/menu.yaml index d80892a50cc..2622ca71def 100644 --- a/menu/menu.yaml +++ b/menu/menu.yaml @@ -832,6 +832,8 @@ Title: Version 6 to 7 - Title: Azure Service Bus Articles: + - Url: transports/upgrades/asbs-5to6 + Title: Version 5 to 6 - Url: transports/upgrades/asbs-4to5 Title: Version 4 to 5 - Url: transports/upgrades/asbs-3to4 diff --git a/transports/upgrades/asbs-5to6.md b/transports/upgrades/asbs-5to6.md new file mode 100644 index 00000000000..ef51d0d6a12 --- /dev/null +++ b/transports/upgrades/asbs-5to6.md @@ -0,0 +1,16 @@ +--- +title: Azure Service Bus Transport Upgrade Version 5 to 6 +summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 5 to 6 +reviewed: 2025-09-18 +component: ASBS +related: + - transports/azure-service-bus +isUpgradeGuide: true +upgradeGuideCoreVersions: + - 9 + - 10 +--- + +## Transport Encoding Header + +The `AzureServiceBusTransport.SendTransportEncodingHeader` API has been deprecated. The transport now relies on the [ContentType property](https://learn.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads#payload-serialization) of Azure Service Bus messages instead of a custom header. Remove any usage of this API. \ No newline at end of file From 6dca00c6cb9397757cd31e20ab1583506e2405ec Mon Sep 17 00:00:00 2001 From: Brandon Ording Date: Fri, 17 Oct 2025 16:55:03 -0400 Subject: [PATCH 2/2] Tweaks --- transports/upgrades/asbs-1.7to1.8.md | 2 +- transports/upgrades/asbs-1to2.md | 2 +- transports/upgrades/asbs-2to3.md | 2 +- transports/upgrades/asbs-3to4.md | 2 +- transports/upgrades/asbs-4to5.md | 6 ++++-- transports/upgrades/asbs-5to6.md | 5 +++-- 6 files changed, 11 insertions(+), 8 deletions(-) diff --git a/transports/upgrades/asbs-1.7to1.8.md b/transports/upgrades/asbs-1.7to1.8.md index de34741cf47..ab85c922e23 100644 --- a/transports/upgrades/asbs-1.7to1.8.md +++ b/transports/upgrades/asbs-1.7to1.8.md @@ -11,7 +11,7 @@ upgradeGuideCoreVersions: ## Replacing shorteners with naming conventions -For existing shoteners, the logic has to be moved into appropriate naming conventions. +For existing shorteners, the logic has to be moved into appropriate naming conventions. To retain the same behavior, a length check needs to be added to the naming conventions logic. ### RuleNameShortener diff --git a/transports/upgrades/asbs-1to2.md b/transports/upgrades/asbs-1to2.md index deb14adecb5..c805339fd84 100644 --- a/transports/upgrades/asbs-1to2.md +++ b/transports/upgrades/asbs-1to2.md @@ -1,6 +1,6 @@ --- title: Azure Service Bus Transport Upgrade Version 1 to 2 -summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 1 to 2. +summary: Instructions on how to upgrade Azure Service Bus transport from version 1 to 2. reviewed: 2022-03-25 component: ASBS related: diff --git a/transports/upgrades/asbs-2to3.md b/transports/upgrades/asbs-2to3.md index 8b795ae1857..d6831f5642f 100644 --- a/transports/upgrades/asbs-2to3.md +++ b/transports/upgrades/asbs-2to3.md @@ -1,6 +1,6 @@ --- title: Azure Service Bus Transport Upgrade Version 2 to 3 -summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 2 to 3 +summary: Instructions on how to upgrade Azure Service Bus transport from version 2 to 3 reviewed: 2021-11-07 component: ASBS related: diff --git a/transports/upgrades/asbs-3to4.md b/transports/upgrades/asbs-3to4.md index 2adb35bf55e..b0156ad6297 100644 --- a/transports/upgrades/asbs-3to4.md +++ b/transports/upgrades/asbs-3to4.md @@ -1,6 +1,6 @@ --- title: Azure Service Bus Transport Upgrade Version 3 to 4 -summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 3 to 4 +summary: Instructions on how to upgrade Azure Service Bus transport from version 3 to 4 reviewed: 2023-12-12 component: ASBS related: diff --git a/transports/upgrades/asbs-4to5.md b/transports/upgrades/asbs-4to5.md index 154b95d853c..9037875ac27 100644 --- a/transports/upgrades/asbs-4to5.md +++ b/transports/upgrades/asbs-4to5.md @@ -1,12 +1,14 @@ --- title: Azure Service Bus Transport Upgrade Version 4 to 5 -summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 4 to 5 +summary: Instructions on how to upgrade Azure Service Bus transport from version 4 to 5 reviewed: 2025-02-07 component: ASBS related: - transports/azure-service-bus - samples/azure-service-bus-netstandard/topology-migration isUpgradeGuide: true +upgradeGuideCoreVersions: + - 9 --- Upgrading Azure Service Bus transport from version 4 to version 5 is a major upgrade and requires careful planning. Read the entire upgrade guide before beginning the upgrade process. @@ -226,7 +228,7 @@ static string HashName(string input) ### Migrating rule name customizations -Previously, rule names could be [assigned using function delegates](/transports/azure-service-bus/configuration.md?version=asbs_4#entity-creation-settings) +Previously, rule names could be [assigned using function delegates](/transports/azure-service-bus/configuration.md?version=asbs_4#entity-creation-settings) ```csharp transport.SubscriptionRuleNamingConvention(x => "MyPrefix-"+x); diff --git a/transports/upgrades/asbs-5to6.md b/transports/upgrades/asbs-5to6.md index ef51d0d6a12..86dcf05a81b 100644 --- a/transports/upgrades/asbs-5to6.md +++ b/transports/upgrades/asbs-5to6.md @@ -1,6 +1,6 @@ --- title: Azure Service Bus Transport Upgrade Version 5 to 6 -summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 5 to 6 +summary: Instructions on how to upgrade Azure Service Bus transport from version 5 to 6 reviewed: 2025-09-18 component: ASBS related: @@ -13,4 +13,5 @@ upgradeGuideCoreVersions: ## Transport Encoding Header -The `AzureServiceBusTransport.SendTransportEncodingHeader` API has been deprecated. The transport now relies on the [ContentType property](https://learn.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads#payload-serialization) of Azure Service Bus messages instead of a custom header. Remove any usage of this API. \ No newline at end of file +The `NServiceBus.Transport.Encoding` header is longer used, but the transport could still send it for compatibility with the legacy Azure Service Bus transport. The ability to send this header has been removed and the `SendTransportEncodingHeader` APIs to opt in to sending it have been deprecated. +Remove all references to these APIs. \ No newline at end of file