# Aspire.Hosting.Azure.ServiceBus

- Module: `Aspire.Hosting.Azure.ServiceBus`
- Version: `13.4.0`
- Source: [GitHub](https://github.com/microsoft/aspire)
- Functions: `11`
- Types: `9`

## Types

- [AzureServiceBusCorrelationFilter](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebuscorrelationfilter.md) -- `type` - 10 fields -- Represents the correlation filter expression.
- [AzureServiceBusEmulatorResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusemulatorresource.md) -- `handle` - 2 members
- [AzureServiceBusQueueResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource.md) -- `handle` - 23 members -- Represents a Service Bus Queue. Initializes a new instance of the {@ats-ref type:AzureServiceBusQueueResource} class.
- [AzureServiceBusResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusresource.md) -- `handle` - 3 members -- Represents an Azure Service Bus resource.
- [AzureServiceBusRule](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusrule.md) -- `type` - 3 fields -- Represents a Service Bus Rule. Initializes a new instance of the `AzureServiceBusRule` class.
- [AzureServiceBusSubscriptionResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource.md) -- `handle` - 20 members -- Represents a Service Bus Subscription. Initializes a new instance of the {@ats-ref type:AzureServiceBusSubscriptionResource} class.
- [AzureServiceBusTopicResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource.md) -- `handle` - 12 members -- Represents a Service Bus Topic. Initializes a new instance of the {@ats-ref type:AzureServiceBusTopicResource} class.

## Functions

- [addAzureServiceBus](/reference/api/typescript/aspire.hosting.azure.servicebus/addazureservicebus.md) -- `method` -- Adds an Azure Service Bus Namespace resource to the application model. This resource can be used to create queue, topic, and subscription resources.
- [addServiceBusQueue](/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebusqueue.md) -- `method` -- Adds an Azure Service Bus Queue resource to the application model.
- [addServiceBusSubscription](/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebussubscription.md) -- `method` -- Adds an Azure Service Bus Subscription resource to the application model.
- [addServiceBusTopic](/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebustopic.md) -- `method` -- Adds an Azure Service Bus Topic resource to the application model.
- [runAsEmulator](/reference/api/typescript/aspire.hosting.azure.servicebus/runasemulator.md) -- `method` -- Configures the Azure Service Bus resource to run with the local emulator
- [withConfigurationFile](/reference/api/typescript/aspire.hosting.azure.servicebus/withconfigurationfile.md) -- `method` -- Copies the configuration file into an Azure Service Bus emulator resource.
- [withHostPort](/reference/api/typescript/aspire.hosting.azure.servicebus/withhostport.md) -- `method` -- Configures the host port for the Azure Service Bus emulator is exposed on instead of using randomly assigned port.
- [withProperties](/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties.md) -- `method` -- Allows setting the properties of an Azure Service Bus Queue resource.
- [withProperties](/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties.md) -- `method` -- Allows setting the properties of an Azure Service Bus Topic resource.
- [withProperties](/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties.md) -- `method` -- Allows setting the properties of an Azure Service Bus Subscription resource.
- [withServiceBusRoleAssignments](/reference/api/typescript/aspire.hosting.azure.servicebus/withservicebusroleassignments.md) -- `method` -- 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.

## Enums

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