# Aspire.Hosting.Azure.ServiceBus

- Module: `Aspire.Hosting.Azure.ServiceBus`
- Version: `17.0.0`
- Import path: `apphost/modules/aspire`
- Source: [GitHub](https://github.com/microsoft/aspire/tree/bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f)
- Functions: `12`
- Types: `15`

## Handles

- [AzureBicepResource](/reference/api/go/aspire.hosting.azure.servicebus/azurebicepresource.md) -- `handle` - 0 members
- [AzureEnvironmentResource](/reference/api/go/aspire.hosting.azure.servicebus/azureenvironmentresource.md) -- `handle` - 0 members
- [AzureProvisioningResource](/reference/api/go/aspire.hosting.azure.servicebus/azureprovisioningresource.md) -- `handle` - 0 members
- [AzureServiceBusEmulatorResource](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebusemulatorresource.md) -- `handle` - 3 members
- [AzureServiceBusQueueResource](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebusqueueresource.md) -- `handle` - 14 members -- Represents a Service Bus Queue. Initializes a new instance of the `AzureServiceBusQueueResource` class.
- [AzureServiceBusResource](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebusresource.md) -- `handle` - 3 members -- Represents an Azure Service Bus resource.
- [AzureServiceBusSubscriptionResource](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource.md) -- `handle` - 13 members -- Represents a Service Bus Subscription. Initializes a new instance of the `AzureServiceBusSubscriptionResource` class.
- [AzureServiceBusTopicResource](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebustopicresource.md) -- `handle` - 9 members -- Represents a Service Bus Topic. Initializes a new instance of the `AzureServiceBusTopicResource` class.
- [AzureUserAssignedIdentityResource](/reference/api/go/aspire.hosting.azure.servicebus/azureuserassignedidentityresource.md) -- `handle` - 0 members
- [SqlServerDatabaseResource](/reference/api/go/aspire.hosting.azure.servicebus/sqlserverdatabaseresource.md) -- `handle` - 0 members
- [SqlServerServerResource](/reference/api/go/aspire.hosting.azure.servicebus/sqlserverserverresource.md) -- `handle` - 0 members

## DTOs

- [AzureServiceBusCorrelationFilter](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebuscorrelationfilter.md) -- `struct` - 10 fields -- Represents the correlation filter expression.
- [AzureServiceBusRule](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebusrule.md) -- `struct` - 3 fields -- Represents a Service Bus Rule. Initializes a new instance of the `AzureServiceBusRule` class.

## Enums

- [AzureServiceBusFilterType](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebusfiltertype.md) -- `enum` - 2 values -- Rule filter types.
- [AzureServiceBusRole](/reference/api/go/aspire.hosting.azure.servicebus/azureservicebusrole.md) -- `enum` - 3 values -- Represents ATS-compatible Azure Service Bus roles.

## Functions

- [WithConfigurationFile](/reference/api/go/aspire.hosting.azure.servicebus/withconfigurationfile.md) -- `method` - on `AzureServiceBusEmulatorResource` -- Copies the configuration file into an Azure Service Bus emulator resource.
- [WithHostPort](/reference/api/go/aspire.hosting.azure.servicebus/withhostport.md) -- `method` - on `AzureServiceBusEmulatorResource` -- Configures the host port for the Azure Service Bus emulator is exposed on instead of using randomly assigned port.
- [WithSqlServer](/reference/api/go/aspire.hosting.azure.servicebus/withsqlserver.md) -- `method` - on `AzureServiceBusEmulatorResource` -- Configures the Azure Service Bus emulator to use an existing SQL Server resource instead of creating one for it.
- [WithProperties](/reference/api/go/aspire.hosting.azure.servicebus/withproperties-azureservicebusqueueresource-func-obj-azureservicebusqueueresource.md) -- `method` - on `AzureServiceBusQueueResource` -- Allows setting the properties of an Azure Service Bus Queue resource.
- [AddServiceBusQueue](/reference/api/go/aspire.hosting.azure.servicebus/addservicebusqueue.md) -- `method` - on `AzureServiceBusResource` -- Adds an Azure Service Bus Queue resource to the application model.
- [AddServiceBusTopic](/reference/api/go/aspire.hosting.azure.servicebus/addservicebustopic.md) -- `method` - on `AzureServiceBusResource` -- Adds an Azure Service Bus Topic resource to the application model.
- [RunAsEmulator](/reference/api/go/aspire.hosting.azure.servicebus/runasemulator.md) -- `method` - on `AzureServiceBusResource` -- Configures the Azure Service Bus resource to run with the local emulator
- [WithProperties](/reference/api/go/aspire.hosting.azure.servicebus/withproperties-azureservicebussubscriptionresource-func-obj-azureservicebussubscriptionresource.md) -- `method` - on `AzureServiceBusSubscriptionResource` -- Allows setting the properties of an Azure Service Bus Subscription resource.
- [AddServiceBusSubscription](/reference/api/go/aspire.hosting.azure.servicebus/addservicebussubscription.md) -- `method` - on `AzureServiceBusTopicResource` -- Adds an Azure Service Bus Subscription resource to the application model.
- [WithProperties](/reference/api/go/aspire.hosting.azure.servicebus/withproperties-azureservicebustopicresource-func-obj-azureservicebustopicresource.md) -- `method` - on `AzureServiceBusTopicResource` -- Allows setting the properties of an Azure Service Bus Topic resource.
- [AddAzureServiceBus](/reference/api/go/aspire.hosting.azure.servicebus/addazureservicebus.md) -- `method` - on `DistributedApplicationBuilder` -- Adds an Azure Service Bus Namespace resource to the application model. This resource can be used to create queue, topic, and subscription resources.
- [WithServiceBusRoleAssignments](/reference/api/go/aspire.hosting.azure.servicebus/withservicebusroleassignments.md) -- `method` - on `Resource` -- 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.
