Skip to content

Commit 67bbb3a

Browse files
Add Azure Service Bus upgrade guide for v5 to v6 (#7831)
* Add Azure Service Bus upgrade guide for v5 to v6 * Tweaks --------- Co-authored-by: Brandon Ording <[email protected]>
1 parent 126aa5a commit 67bbb3a

File tree

7 files changed

+27
-6
lines changed

7 files changed

+27
-6
lines changed

menu/menu.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -832,6 +832,8 @@
832832
Title: Version 6 to 7
833833
- Title: Azure Service Bus
834834
Articles:
835+
- Url: transports/upgrades/asbs-5to6
836+
Title: Version 5 to 6
835837
- Url: transports/upgrades/asbs-4to5
836838
Title: Version 4 to 5
837839
- Url: transports/upgrades/asbs-3to4

transports/upgrades/asbs-1.7to1.8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ upgradeGuideCoreVersions:
1111

1212
## Replacing shorteners with naming conventions
1313

14-
For existing shoteners, the logic has to be moved into appropriate naming conventions.
14+
For existing shorteners, the logic has to be moved into appropriate naming conventions.
1515
To retain the same behavior, a length check needs to be added to the naming conventions logic.
1616

1717
### RuleNameShortener

transports/upgrades/asbs-1to2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Azure Service Bus Transport Upgrade Version 1 to 2
3-
summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 1 to 2.
3+
summary: Instructions on how to upgrade Azure Service Bus transport from version 1 to 2.
44
reviewed: 2022-03-25
55
component: ASBS
66
related:

transports/upgrades/asbs-2to3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Azure Service Bus Transport Upgrade Version 2 to 3
3-
summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 2 to 3
3+
summary: Instructions on how to upgrade Azure Service Bus transport from version 2 to 3
44
reviewed: 2021-11-07
55
component: ASBS
66
related:

transports/upgrades/asbs-3to4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Azure Service Bus Transport Upgrade Version 3 to 4
3-
summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 3 to 4
3+
summary: Instructions on how to upgrade Azure Service Bus transport from version 3 to 4
44
reviewed: 2023-12-12
55
component: ASBS
66
related:

transports/upgrades/asbs-4to5.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
22
title: Azure Service Bus Transport Upgrade Version 4 to 5
3-
summary: Migration instructions on how to upgrade the Azure Service Bus transport from version 4 to 5
3+
summary: Instructions on how to upgrade Azure Service Bus transport from version 4 to 5
44
reviewed: 2025-02-07
55
component: ASBS
66
related:
77
- transports/azure-service-bus
88
- samples/azure-service-bus-netstandard/topology-migration
99
isUpgradeGuide: true
10+
upgradeGuideCoreVersions:
11+
- 9
1012
---
1113

1214
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)
226228

227229
### Migrating rule name customizations
228230

229-
Previously, rule names could be [assigned using function delegates](/transports/azure-service-bus/configuration.md?version=asbs_4#entity-creation-settings)
231+
Previously, rule names could be [assigned using function delegates](/transports/azure-service-bus/configuration.md?version=asbs_4#entity-creation-settings)
230232

231233
```csharp
232234
transport.SubscriptionRuleNamingConvention(x => "MyPrefix-"+x);

transports/upgrades/asbs-5to6.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Azure Service Bus Transport Upgrade Version 5 to 6
3+
summary: Instructions on how to upgrade Azure Service Bus transport from version 5 to 6
4+
reviewed: 2025-09-18
5+
component: ASBS
6+
related:
7+
- transports/azure-service-bus
8+
isUpgradeGuide: true
9+
upgradeGuideCoreVersions:
10+
- 9
11+
- 10
12+
---
13+
14+
## Transport Encoding Header
15+
16+
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.
17+
Remove all references to these APIs.

0 commit comments

Comments
 (0)