# Aspire.Hosting.Azure.ServiceBus

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

## Types

- [AzureBicepResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azurebicepresource.md) -- `handle` - 9 members
- [AzureEnvironmentResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureenvironmentresource.md) -- `handle` - 2 members
- [AzureProvisioningResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureprovisioningresource.md) -- `handle` - 1 members
- [AzureResourceInfrastructure](/reference/api/typescript/aspire.hosting.azure.servicebus/azureresourceinfrastructure.md) -- `handle` - 3 members
- [AzureServiceBusCorrelationFilter](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebuscorrelationfilter.md) -- `type` - 10 fields
- [AzureServiceBusEmulatorResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusemulatorresource.md) -- `handle` - 2 members
- [AzureServiceBusQueueResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource.md) -- `handle` - 22 members
- [AzureServiceBusResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusresource.md) -- `handle` - 3 members
- [AzureServiceBusRule](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusrule.md) -- `type` - 3 fields
- [AzureServiceBusSubscriptionResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource.md) -- `handle` - 19 members
- [AzureServiceBusTopicResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource.md) -- `handle` - 11 members
- [AzureUserAssignedIdentityResource](/reference/api/typescript/aspire.hosting.azure.servicebus/azureuserassignedidentityresource.md) -- `handle` - 0 members
- [BicepOutputReference](/reference/api/typescript/aspire.hosting.azure.servicebus/bicepoutputreference.md) -- `handle` - 3 members
- [IAzureKeyVaultResource](/reference/api/typescript/aspire.hosting.azure.servicebus/iazurekeyvaultresource.md) -- `interface` - 0 members
- [IAzureKeyVaultSecretReference](/reference/api/typescript/aspire.hosting.azure.servicebus/iazurekeyvaultsecretreference.md) -- `interface` - 0 members
- [IAzureResource](/reference/api/typescript/aspire.hosting.azure.servicebus/iazureresource.md) -- `interface` - 9 members

## Functions

- [addAzureEnvironment](/reference/api/typescript/aspire.hosting.azure.servicebus/addazureenvironment.md) -- `method` -- Adds the shared Azure environment resource to the application model
- [addAzureInfrastructure](/reference/api/typescript/aspire.hosting.azure.servicebus/addazureinfrastructure.md) -- `method` -- Adds an Azure provisioning resource to the application model
- [addAzureProvisioning](/reference/api/typescript/aspire.hosting.azure.servicebus/addazureprovisioning.md) -- `method` -- Adds Azure provisioning services to the distributed application builder
- [addAzureServiceBus](/reference/api/typescript/aspire.hosting.azure.servicebus/addazureservicebus.md) -- `method` -- Adds an Azure Service Bus namespace resource
- [addAzureUserAssignedIdentity](/reference/api/typescript/aspire.hosting.azure.servicebus/addazureuserassignedidentity.md) -- `method` -- Adds an Azure user-assigned identity resource
- [addBicepTemplate](/reference/api/typescript/aspire.hosting.azure.servicebus/addbiceptemplate.md) -- `method` -- Adds an Azure Bicep template resource from a file
- [addBicepTemplateString](/reference/api/typescript/aspire.hosting.azure.servicebus/addbiceptemplatestring.md) -- `method` -- Adds an Azure Bicep template resource from inline Bicep content
- [addServiceBusQueue](/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebusqueue.md) -- `method` -- Adds an Azure Service Bus queue resource
- [addServiceBusSubscription](/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebussubscription.md) -- `method` -- Adds an Azure Service Bus subscription resource
- [addServiceBusTopic](/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebustopic.md) -- `method` -- Adds an Azure Service Bus topic resource
- [asExisting](/reference/api/typescript/aspire.hosting.azure.servicebus/asexisting.md) -- `method` -- Marks an Azure resource as existing in both run and publish modes by using parameter resources
- [clearDefaultRoleAssignments](/reference/api/typescript/aspire.hosting.azure.servicebus/cleardefaultroleassignments.md) -- `method` -- Clears the default Azure role assignments from a resource
- [configureInfrastructure](/reference/api/typescript/aspire.hosting.azure.servicebus/configureinfrastructure.md) -- `method` -- Configures the Azure provisioning infrastructure callback
- [getBicepIdentifier](/reference/api/typescript/aspire.hosting.azure.servicebus/getbicepidentifier.md) -- `method` -- Gets the normalized Bicep identifier for an Azure resource
- [getOutput](/reference/api/typescript/aspire.hosting.azure.servicebus/getoutput.md) -- `method` -- Gets an output reference from an Azure Bicep template resource
- [isExisting](/reference/api/typescript/aspire.hosting.azure.servicebus/isexisting.md) -- `method` -- Determines whether a resource is marked as existing
- [publishAsConnectionString](/reference/api/typescript/aspire.hosting.azure.servicebus/publishasconnectionstring.md) -- `method` -- Publishes an Azure resource to the manifest as a connection string
- [publishAsExisting](/reference/api/typescript/aspire.hosting.azure.servicebus/publishasexisting.md) -- `method` -- Marks an Azure resource as existing in publish mode
- [publishAsExistingFromParameters](/reference/api/typescript/aspire.hosting.azure.servicebus/publishasexistingfromparameters.md) -- `method` -- Marks an Azure resource as existing in publish mode by using parameter resources
- [runAsEmulator](/reference/api/typescript/aspire.hosting.azure.servicebus/runasemulator.md) -- `method` -- Configures the Azure Service Bus resource to run with the local emulator
- [runAsExisting](/reference/api/typescript/aspire.hosting.azure.servicebus/runasexisting.md) -- `method` -- Marks an Azure resource as existing in run mode
- [runAsExistingFromParameters](/reference/api/typescript/aspire.hosting.azure.servicebus/runasexistingfromparameters.md) -- `method` -- Marks an Azure resource as existing in run mode by using parameter resources
- [withAzureUserAssignedIdentity](/reference/api/typescript/aspire.hosting.azure.servicebus/withazureuserassignedidentity.md) -- `method` -- Associates an Azure user-assigned identity with a compute resource
- [withConfigurationFile](/reference/api/typescript/aspire.hosting.azure.servicebus/withconfigurationfile.md) -- `method` -- Sets the emulator configuration file path
- [withEnvironmentFromKeyVaultSecret](/reference/api/typescript/aspire.hosting.azure.servicebus/withenvironmentfromkeyvaultsecret.md) -- `method` -- Sets an environment variable from an Azure Key Vault secret reference
- [withEnvironmentFromOutput](/reference/api/typescript/aspire.hosting.azure.servicebus/withenvironmentfromoutput.md) -- `method` -- Sets an environment variable from a Bicep output reference
- [withHostPort](/reference/api/typescript/aspire.hosting.azure.servicebus/withhostport.md) -- `method` -- Sets the host port for the Service Bus emulator endpoint
- [withLocation](/reference/api/typescript/aspire.hosting.azure.servicebus/withlocation.md) -- `method` -- Sets the Azure location for the shared Azure environment resource
- [withParameter](/reference/api/typescript/aspire.hosting.azure.servicebus/withparameter.md) -- `method` -- Adds a Bicep parameter without a value
- [withParameterFromConnectionString](/reference/api/typescript/aspire.hosting.azure.servicebus/withparameterfromconnectionstring.md) -- `method` -- Adds a Bicep parameter from a connection string resource builder
- [withParameterFromEndpoint](/reference/api/typescript/aspire.hosting.azure.servicebus/withparameterfromendpoint.md) -- `method` -- Adds a Bicep parameter from an endpoint reference
- [withParameterFromOutput](/reference/api/typescript/aspire.hosting.azure.servicebus/withparameterfromoutput.md) -- `method` -- Adds a Bicep parameter from another Bicep output reference
- [withParameterFromParameter](/reference/api/typescript/aspire.hosting.azure.servicebus/withparameterfromparameter.md) -- `method` -- Adds a Bicep parameter from a parameter resource builder
- [withParameterFromReferenceExpression](/reference/api/typescript/aspire.hosting.azure.servicebus/withparameterfromreferenceexpression.md) -- `method` -- Adds a Bicep parameter from a reference expression
- [withParameterStringValue](/reference/api/typescript/aspire.hosting.azure.servicebus/withparameterstringvalue.md) -- `method` -- Adds a Bicep parameter with a string value
- [withParameterStringValues](/reference/api/typescript/aspire.hosting.azure.servicebus/withparameterstringvalues.md) -- `method` -- Adds a Bicep parameter with a string list value
- [withProperties](/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties.md) -- `method` -- Configures properties of an Azure Service Bus queue
- [withProperties](/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties.md) -- `method` -- Configures properties of an Azure Service Bus topic
- [withProperties](/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties.md) -- `method` -- Configures properties of an Azure Service Bus subscription
- [withResourceGroup](/reference/api/typescript/aspire.hosting.azure.servicebus/withresourcegroup.md) -- `method` -- Sets the Azure resource group for the shared Azure environment resource
- [withServiceBusRoleAssignments](/reference/api/typescript/aspire.hosting.azure.servicebus/withservicebusroleassignments.md) -- `method` -- Assigns Service Bus roles to a resource

## Enums

- [AzureServiceBusFilterType](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusfiltertype.md) -- `enum` - 2 values
- [AzureServiceBusRole](/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusrole.md) -- `enum` - 3 values
- [DeploymentScope](/reference/api/typescript/aspire.hosting.azure.servicebus/deploymentscope.md) -- `enum` - 4 values