[Breaking change]: Document Azure.Hosting.ServiceBus obsolete methods

[sebastienros]

Description

AddQueue, AddTopic and AddSubscription are being obsoleted in 9.1 with this PR

Version

Other (please put exact version in description textbox)

Previous behavior

n/a

New behavior

n/a

Type of breaking change

• Binary incompatible: Existing binaries might encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation.
• Source incompatible: When recompiled using the new SDK or component or to target the new runtime, existing source code might require source changes to compile successfully.
• Behavioral change: Existing binaries might behave differently at run time.

Reason for change

A better API is provided, the names With reflect that no specific resource is created. Add should be used when it returns a actual resource (not a resource builder).

Recommended action

Update your methods to use the new ones.

Affected APIs

static Aspire.Hosting.AzureServiceBusExtensions.AddQueue(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>! builder, string! name) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!
static Aspire.Hosting.AzureServiceBusExtensions.AddQueue(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>! builder, string! name, System.Action<Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!, Aspire.Hosting.ResourceModuleConstruct!, Azure.Provisioning.ServiceBus.ServiceBusQueue!>? configureQueue) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!
static Aspire.Hosting.AzureServiceBusExtensions.AddSubscription(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>! builder, string! topicName, string! subscriptionName) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!
static Aspire.Hosting.AzureServiceBusExtensions.AddSubscription(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>! builder, string! topicName, string! subscriptionName, System.Action<Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!, Aspire.Hosting.ResourceModuleConstruct!, Azure.Provisioning.ServiceBus.ServiceBusSubscription!>? configureSubscription) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!
static Aspire.Hosting.AzureServiceBusExtensions.AddTopic(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>! builder, string! name) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!
static Aspire.Hosting.AzureServiceBusExtensions.AddTopic(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>! builder, string! name, string![]! subscriptions) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!
static Aspire.Hosting.AzureServiceBusExtensions.AddTopic(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>! builder, string! name, System.Action<Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!, Aspire.Hosting.ResourceModuleConstruct!, Azure.Provisioning.ServiceBus.ServiceBusTopic!>? configureTopic) -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Azure.AzureServiceBusResource!>!

---

Associated WorkItem - 373404

[eerhardt]

@IEvangelist - I missed logging this. We removed the With* APIs at the end of 9.1. See

The easiest way of seeing the final results is to look at these 3 files:

• https://github.com/dotnet/aspire/pull/7374/files#diff-f5cfdaa7faa2ebff4690dc52530a770807878ff698b4198b4ca29dca2c817f32R37
• https://github.com/dotnet/aspire/pull/7374/files#diff-129ce7d9330ff507a112ca29058459c1cb5fb838fcb03bb4e168940711997af7R17
• https://github.com/dotnet/aspire/pull/7374/files#diff-c20ccea55d9e04dffb5b5a104474833d73a42e550dbbc681da81787b7fa011d5R15

This isn't just for ServiceBus, but also EventHubs and CosmosDB as well.

ServiceBus

• AddQueue => AddServiceBusQueue
• AddTopic => AddServiceBusTopic
• AddSubscription => AddServiceBusTopic("").AddServiceBusSubscription("")

Event Hubs

• AddEventHub => AddHub

CosmosDB

• AddDatabase => AddCosmosDatabase