[QUERY] How can we use configuration when registering an Azure client about azure-sdk-for-net

[jsquire]

@cjablonski76:

You're saying there's nothing wrong with the way I'm currently doing it though (i.e. with builder.AddClient<ServiceBusClient, ServiceBusClientOptions>)?

Correct. There's nothing wrong with what you're currently doing, and it seems like the best approach for your specific scenario of not knowing the configuration that you want upfront. What you're doing will register the client and ensure proper cleanup.

[github-actions]

Thank you for your feedback. Tagging and routing to the team member best able to assist.

[jsquire]

Hi @cjablonski76. You are correct in that there is no overload that injects an IServiceProvider and the factory approach that you're using is the recommended way to do so. The resulting factory is invoked on-demand and the resulting client instance is cached and cleaned up.

If your goal is to provide configuration to the client or overload its options, there are other more direct ways to do so.

For example, to create a client based on configuration, the recommended approach is:

var appBuilder = WebApplication.CreateBuilder(args);
var serviceCollection = appBuilder.Services;

serviceCollection.AddAzureClients(builder =>
{
    builder.AddServiceBusClient(appBuilder.Configuration.GetSection("ServiceBus");
}

Overriding client options can be done in the following way, if you'd like to avoid the factory:

var appBuilder = WebApplication.CreateBuilder(args);
var serviceCollection = appBuilder.Services;

serviceCollection.AddAzureClients(builder =>
{
    builder
        .AddServiceBusClientWithNamespace("<your_namespace>.servicebus.windows.net");
        .ConfigureOptions(options =>
        {
            var myOptions = new MyOptions();
            appBuilder.Configuration["MyOptions"].Bind(myOptions);

            options.TransportType = myOptions.ServiceBusTransportType;
        });
}

More discussion and examples can be found in Dependency injection with the Azure SDK for .NET.

[github-actions]

Hi @cjablonski76. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.

[cjablonski76]

@jsquire, the more in depth problem I have is that the configuration I'm trying to load has two possible service bus connections configured. So something like:

{
   "PrimaryConnection" : {
      "Namespace": "testing-primary-centralus.servicebus.windows.net"
   },
   "FailoverConnection": {
      "Namespace": "testing-failover-centralus.servicebus.windows.net"
   }
}

And deciding which service bus connection to use depends on some other DI dependency, so I end up doing something like:

serviceCollection
   .AddOptions<ServiceBusOptions>()
   .Configure<IConnectionPicker>((serviceBusOptions, connPicker) =>
   {
      var connectionToUse = connPicker.GetConnectionNameBasedOnPodLocation(); // return "Primary" or "Secondary"
      configurationSection.GetSection(connectionToUse).Bind(serviceBusOptions);
   });

serviceCollection.AddAzureClients(builder =>
{
    builder.AddClient<ServiceBusClient, ServiceBusClientOptions>((options, provider) =>
    {
        var serviceBusOptions =
                    provider.GetRequiredService<IOptions<ServiceBusOptions>>().Value;
        
        return new ServiceBusClient(serviceBusOptions.Namespace, new DefaultAzureCredential(), options);
    }
}

So it would have been convenient if to have access to the IServiceProvider in some AddServiceBus* methods so that I could stick to those methods without re-designing my above flow.

I think to accomplish what I'm talking about while using the AddServiceBus* methods, I would need to register both ServiceBusClient instances and name them appropriately, then I would push my IConnectionPicker down into the class that depends on ServiceBusClient and grab the correct instance with IAzureClientFactory<ServiceBusClient>.CreateClient(connPicker.GetConnectionNameBasedOnPodLocation());

You're saying there's nothing wrong with the way I'm currently doing it though (i.e. with builder.AddClient<ServiceBusClient, ServiceBusClientOptions>)?

[cjablonski76]

Awesome, thanks for the help!