AzureServiceBusExtensions Methods

AddAzureServiceBus(IDistributedApplicationBuilder, string)extensionIResourceBuilder<AzureServiceBusResource>

Adds an Azure Service Bus Namespace resource to the application model. This resource can be used to create queue, topic, and subscription resources.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusResource> AddAzureServiceBus(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L46-L143

Parameters

builderIDistributedApplicationBuilderThe builder for the distributed application.

namestringThe name of the resource.

Returns

IResourceBuilder<AzureServiceBusResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

By default references to the Azure Service Bus resource will be assigned the following roles: - ServiceBusBuiltInRole.AzureServiceBusDataOwner These can be replaced by calling AzureServiceBusExtensions.WithRoleAssignments.

AddQueue(IResourceBuilder<AzureServiceBusResource>, string)extensionIResourceBuilder<AzureServiceBusResource>

Adds an Azure Service Bus Queue resource to the application model.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusResource> AddQueue(
        this IResourceBuilder<AzureServiceBusResource> builder,
        string name)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L157-L162

Parameters

builderIResourceBuilder<AzureServiceBusResource>The Azure Service Bus resource builder.

namestringThe name of the queue resource.

Returns

IResourceBuilder<AzureServiceBusResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This method is not available in polyglot app hosts. Use AzureServiceBusExtensions.AddServiceBusQueue instead.

AddServiceBusQueue(IResourceBuilder<AzureServiceBusResource>, string, string?)extensionIResourceBuilder<AzureServiceBusQueueResource>

Adds an Azure Service Bus Queue resource to the application model.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusQueueResource> AddServiceBusQueue(
        this IResourceBuilder<AzureServiceBusResource> builder,
        string name,
        string? queueName = null)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L176-L185

Parameters

builderIResourceBuilder<AzureServiceBusResource>The Azure Service Bus resource builder.

namestringThe name of the queue resource.

queueNamestring?optionalThe name of the Service Bus Queue. If not provided, this defaults to the same value as name.

Returns

IResourceBuilder<AzureServiceBusQueueResource>A reference to the ApplicationModel.IResourceBuilder`1.

AddServiceBusSubscription(IResourceBuilder<AzureServiceBusTopicResource>, string, string?)extensionIResourceBuilder<AzureServiceBusSubscriptionResource>

Adds an Azure Service Bus Subscription resource to the application model.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusSubscriptionResource> AddServiceBusSubscription(
        this IResourceBuilder<AzureServiceBusTopicResource> builder,
        string name,
        string? subscriptionName = null)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L333-L342

Parameters

builderIResourceBuilder<AzureServiceBusTopicResource>The Azure Service Bus Topic resource builder.

namestringThe name of the subscription resource.

subscriptionNamestring?optionalThe name of the Service Bus Subscription. If not provided, this defaults to the same value as name.

Returns

IResourceBuilder<AzureServiceBusSubscriptionResource>A reference to the ApplicationModel.IResourceBuilder`1.

AddServiceBusTopic(IResourceBuilder<AzureServiceBusResource>, string, string?)extensionIResourceBuilder<AzureServiceBusTopicResource>

Adds an Azure Service Bus Topic resource to the application model.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusTopicResource> AddServiceBusTopic(
        this IResourceBuilder<AzureServiceBusResource> builder,
        string name,
        string? topicName = null)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L261-L270

Parameters

builderIResourceBuilder<AzureServiceBusResource>The Azure Service Bus resource builder.

namestringThe name of the topic resource.

topicNamestring?optionalThe name of the Service Bus Topic. If not provided, this defaults to the same value as name.

Returns

IResourceBuilder<AzureServiceBusTopicResource>A reference to the ApplicationModel.IResourceBuilder`1.

AddSubscription(IResourceBuilder<AzureServiceBusResource>, string, string)extensionIResourceBuilder<AzureServiceBusResource>

Adds an Azure Service Bus Subscription resource to the application model.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusResource> AddSubscription(
        this IResourceBuilder<AzureServiceBusResource> builder,
        string topicName,
        string subscriptionName)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L303-L319

Parameters

builderIResourceBuilder<AzureServiceBusResource>The Azure Service Bus resource builder.

topicNamestringThe name of the topic resource.

subscriptionNamestringThe name of the subscription.

Returns

IResourceBuilder<AzureServiceBusResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This method is not available in polyglot app hosts. Use AzureServiceBusExtensions.AddServiceBusSubscription instead.

AddTopic(IResourceBuilder<AzureServiceBusResource>, string)extensionIResourceBuilder<AzureServiceBusResource>

Adds an Azure Service Bus Topic resource to the application model.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusResource> AddTopic(
        this IResourceBuilder<AzureServiceBusResource> builder,
        string name)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L216-L221

Parameters

builderIResourceBuilder<AzureServiceBusResource>The Azure Service Bus resource builder.

namestringThe name of the topic resource.

Remarks

This method is not available in polyglot app hosts. Use AzureServiceBusExtensions.AddServiceBusTopic instead.

AddTopic(IResourceBuilder<AzureServiceBusResource>, string, string[])extensionIResourceBuilder<AzureServiceBusResource>

Adds an Azure Service Bus Topic resource to the application model.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusResource> AddTopic(
        this IResourceBuilder<AzureServiceBusResource> builder,
        string name,
        string[] subscriptions)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L235-L247

Parameters

builderIResourceBuilder<AzureServiceBusResource>The Azure Service Bus resource builder.

namestringThe name of the topic resource.

subscriptionsstring[]The name of the subscriptions.

Remarks

This method is not available in polyglot app hosts. Use AzureServiceBusExtensions.AddServiceBusTopic and AzureServiceBusExtensions.AddServiceBusSubscription instead.

RunAsEmulator(IResourceBuilder<AzureServiceBusResource>, Action<IResourceBuilder<AzureServiceBusEmulatorResource>>)extensionIResourceBuilder<AzureServiceBusResource>

Configures an Azure Service Bus resource to be emulated. This resource requires an AzureServiceBusResource to be added to the application model.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusResource> RunAsEmulator(
        this IResourceBuilder<AzureServiceBusResource> builder,
        Action<IResourceBuilder<AzureServiceBusEmulatorResource>>? configureContainer = null)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L394-L512

Parameters

builderIResourceBuilder<AzureServiceBusResource>

configureContainerAction<IResourceBuilder<AzureServiceBusEmulatorResource>>optional

Remarks

This version of the package defaults to the tag of the / container image. The Azure Service Bus resource builder. Callback that exposes underlying container used for emulation to allow for customization. A reference to the ApplicationModel.IResourceBuilder`1. The resource builder. The following example creates an Azure Service Bus resource that runs locally is an emulator and referencing that resource in a .NET project.

var builder = DistributedApplication.CreateBuilder(args);

var serviceBus = builder.AddAzureServiceBus("myservicebus")
   .RunAsEmulator()
   .AddQueue("queue");

builder.AddProject<Projects.InventoryService>()
       .WithReference(serviceBus);

builder.Build().Run();

WithConfiguration(IResourceBuilder<AzureServiceBusEmulatorResource>, Action<JsonNode>)extensionIResourceBuilder<AzureServiceBusEmulatorResource>

Alters the JSON configuration document used by the emulator.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusEmulatorResource> WithConfiguration(
        this IResourceBuilder<AzureServiceBusEmulatorResource> builder,
        Action<JsonNode> configJson)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L557-L562

Parameters

builderIResourceBuilder<AzureServiceBusEmulatorResource>The builder for the AzureServiceBusEmulatorResource.

configJsonAction<JsonNode>A callback to update the JSON object representation of the configuration.

Returns

IResourceBuilder<AzureServiceBusEmulatorResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This method is not available in polyglot app hosts. Use AzureServiceBusExtensions.WithConfigurationFile instead to provide a configuration file. Here is an example of how to configure the emulator to use a different logging mechanism:

var builder = DistributedApplication.CreateBuilder(args);

builder.AddAzureServiceBus("servicebusns")
       .RunAsEmulator(configure => configure
           .WithConfiguration(document =>
           {
               document["UserConfig"]!["Logging"] = new JsonObject { ["Type"] = "Console" };
           });
       );

WithConfigurationFile(IResourceBuilder<AzureServiceBusEmulatorResource>, string)extensionIResourceBuilder<AzureServiceBusEmulatorResource>

Copies the configuration file into an Azure Service Bus emulator resource.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusEmulatorResource> WithConfigurationFile(
        this IResourceBuilder<AzureServiceBusEmulatorResource> builder,
        string path)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L525-L528

Parameters

builderIResourceBuilder<AzureServiceBusEmulatorResource>The builder for the AzureServiceBusEmulatorResource.

pathstringPath to the file on the AppHost where the emulator configuration is located.

Returns

IResourceBuilder<AzureServiceBusEmulatorResource>A reference to the ApplicationModel.IResourceBuilder`1.

WithHostPort(IResourceBuilder<AzureServiceBusEmulatorResource>, int?)extensionIResourceBuilder<AzureServiceBusEmulatorResource>

Configures the host port for the Azure Service Bus emulator is exposed on instead of using randomly assigned port.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusEmulatorResource> WithHostPort(
        this IResourceBuilder<AzureServiceBusEmulatorResource> builder,
        int? port)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs#L575-L580

Parameters

builderIResourceBuilder<AzureServiceBusEmulatorResource>Builder for the Azure Service Bus emulator container

portint?The port to bind on the host. If null is used, a random port will be assigned.

Returns

IResourceBuilder<AzureServiceBusEmulatorResource>A reference to the ApplicationModel.IResourceBuilder`1.

WithProperties(IResourceBuilder<AzureServiceBusQueueResource>, Action<AzureServiceBusQueueResource>)extensionIResourceBuilder<AzureServiceBusQueueResource>

Allows setting the properties of an Azure Service Bus Queue resource.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusQueueResource> WithProperties(
        this IResourceBuilder<AzureServiceBusQueueResource> builder,
        Action<AzureServiceBusQueueResource> configure)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs

Parameters

builderIResourceBuilder<AzureServiceBusQueueResource>The Azure Service Bus Queue resource builder.

configureAction<AzureServiceBusQueueResource>A method that can be used for customizing the AzureServiceBusQueueResource.

Returns

IResourceBuilder<AzureServiceBusQueueResource>A reference to the ApplicationModel.IResourceBuilder`1.

WithProperties(IResourceBuilder<AzureServiceBusTopicResource>, Action<AzureServiceBusTopicResource>)extensionIResourceBuilder<AzureServiceBusTopicResource>

Allows setting the properties of an Azure Service Bus Topic resource.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusTopicResource> WithProperties(
        this IResourceBuilder<AzureServiceBusTopicResource> builder,
        Action<AzureServiceBusTopicResource> configure)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs

Parameters

builderIResourceBuilder<AzureServiceBusTopicResource>The Azure Service Bus Topic resource builder.

configureAction<AzureServiceBusTopicResource>A method that can be used for customizing the AzureServiceBusTopicResource.

Returns

IResourceBuilder<AzureServiceBusTopicResource>A reference to the ApplicationModel.IResourceBuilder`1.

WithProperties(IResourceBuilder<AzureServiceBusSubscriptionResource>, Action<AzureServiceBusSubscriptionResource>)extensionIResourceBuilder<AzureServiceBusSubscriptionResource>

Allows setting the properties of an Azure Service Bus Subscription resource.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<AzureServiceBusSubscriptionResource> WithProperties(
        this IResourceBuilder<AzureServiceBusSubscriptionResource> builder,
        Action<AzureServiceBusSubscriptionResource> configure)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs

Parameters

builderIResourceBuilder<AzureServiceBusSubscriptionResource>The Azure Service Bus Subscription resource builder.

configureAction<AzureServiceBusSubscriptionResource>A method that can be used for customizing the AzureServiceBusSubscriptionResource.

Returns

IResourceBuilder<AzureServiceBusSubscriptionResource>A reference to the ApplicationModel.IResourceBuilder`1.

WithRoleAssignments(IResourceBuilder<T>, IResourceBuilder<AzureServiceBusResource>, ServiceBusBuiltInRole[])extensionIResourceBuilder<T>

Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Service Bus namespace. This replaces the default role assignments for the resource.

public static class AzureServiceBusExtensions
{
    public static IResourceBuilder<T> WithRoleAssignments<T>(
        this IResourceBuilder<T> builder,
        IResourceBuilder<AzureServiceBusResource> target,
        params ServiceBusBuiltInRole[] roles)
    {
        // ...
    }
}

AzureServiceBusExtensions.cs

Parameters

builderIResourceBuilder<T>The resource to which the specified roles will be assigned.

targetIResourceBuilder<AzureServiceBusResource>The target Azure Service Bus namespace.

rolesServiceBusBuiltInRole[]The built-in Service Bus roles to be assigned.

Returns

IResourceBuilder<T>The updated ApplicationModel.IResourceBuilder`1 with the applied role assignments.

Remarks

This overload is not available in polyglot app hosts. Use AzureServiceBusExtensions.WithRoleAssignments instead.

var builder = DistributedApplication.CreateBuilder(args);

var sb = builder.AddAzureServiceBus("bus");

var api = builder.AddProject<Projects.Api>("api")
  .WithRoleAssignments(sb, ServiceBusBuiltInRole.AzureServiceBusDataSender)
  .WithReference(sb);