Table of Contents

Configuring your API


📦 Step 1: Install the NuGet Package

Start by installing the AzureServiceBusFlow package from NuGet:

dotnet add package AzureServiceBusFlow

You can also find it on NuGet.org.

This package contains all the necessary components to configure Producers / Consumers, register Queues / Topics and publish Messages (Commands/ Events) to AzureServiceBus.


⚙️ Step 2: Configure the appsettings.json

After installing the package, it's time to configure your appsettings.json file.
You need to define the basic configuration for Azure Service Bus to work.

Here’s a configuration example:

"AzureServiceBusConfigurationSettings": {
    "ConnectionString": "",
    "ServiceBusReceiveMode": "ReceiveAndDelete",
    "MaxAutoLockRenewalDurationInSeconds": "1800",
    "MaxConcurrentCalls": "10",
    "MaxRetryAttempts": "3"
}
  • ConnectionString: The full connection string to your Azure Service Bus instance, typically in the format: Endpoint=sb://<your-servicebus-namespace-name>.servicebus.windows.net/;SharedAccessKeyName=<your-access-key-name>;SharedAccessKey=<your-access-key-value>.
  • ServiceBusReceiveMode: Defines how messages are handled after being received.
    • "PeekLock": The message is locked for processing and remains in the queue until it is explicitly completed or abandoned. If the receiver fails to complete the message within the lock duration, the message becomes available again for other receivers.
    • "ReceiveAndDelete": The message is automatically removed from the queue as soon as it is received.
  • MaxAutoLockRenewalDurationInSeconds: The maximum duration, in seconds, that the message lock will be automatically renewed while the message is being processed.
  • MaxConcurrentCalls: Specifies the maximum number of messages that can be processed concurrently.
  • MaxRetryAttempts: Defines the maximum number of retry attempts the message handler will perform to reprocess a message if an exception occurs.

💡 The MaxRetryAttempts property only makes sense when using ReceiveAndDelete mode. In PeekLock mode, Azure Service Bus retries message processing 10 times by default, so explicit retry configuration is unnecessary.


🧩 Step 3: Register AzureServiceBus in Program.cs

Now that your appsettings.json is configured, it's time to enable AzureServiceBus in your application.

Inside your Program.cs, register the AzureServiceBus in DI container with the AddAzureServiceBus extension method and set the configure method.

var azureServiceBusConfig = new AzureServiceBusConfiguration
{
    ConnectionString = "",
    ServiceBusReceiveMode = Azure.Messaging.ServiceBus.ServiceBusReceiveMode.ReceiveAndDelete,
    MaxConcurrentCalls = 10,
    MaxAutoLockRenewalDurationInSeconds = 1800,
    MaxRetryAttempts = 2
};

builder.Services.AddAzureServiceBus(cfg => cfg
    .ConfigureAzureServiceBus(azureServiceBusConfig));

This method need a AzureServiceBusConfiguration instance to configure all the necessary properties to work with the Azure Service Bus.

At this time, no queues, topics, producers or consumers are configured and registered. This will be done in the next steps.

💡 I recommend you create a class called Settings and map the appsettings.json on this class, you can merge your personal appsettings config and also add the AzureServiceBusFlow properties that are required. For example:

{
  "Settings": {
    "AzureServiceBusConfigurationSettings": {
        "ConnectionString": "",
        "ServiceBusReceiveMode": "ReceiveAndDelete",
        "MaxAutoLockRenewalDurationInSeconds": "1800",
        "MaxConcurrentCalls": "10",
        "MaxRetryAttempts": "3"
    }
  }
}


public class Settings
{
    public AzureServiceBusConfiguration AzureServiceBusConfigurationSettings { get; }
}

var applicationSettings = builder.Configuration.GetSection("Settings").Get<Settings>();



🔒 Next Steps: Create Messages, Producers, Consumers, Queues and Topics.

In the next step, we`ll explain how to create Messages and Producers that will publish to a specific queue or topic in Azure Service Bus.

Edit this page