Skip to content
DocsTry Aspire
DocsTry

Aspire.Hosting.Azure.ServiceBus

Official
📦 Aspire.Hosting.Azure.ServiceBusv13.4.0
11Functions
9Types

Types

Functions

methodaddAzureServiceBusbuilder
Adds an Azure Service Bus Namespace resource to the application model. This resource can be used to create queue, topic, and subscription resources.
addAzureServiceBus(name: string): AzureServiceBusResource
methodaddServiceBusQueuebuilder
Adds an Azure Service Bus Queue resource to the application model.
addServiceBusQueue(name: string, queueName?: string): AzureServiceBusQueueResource
methodaddServiceBusSubscriptionbuilder
Adds an Azure Service Bus Subscription resource to the application model.
addServiceBusSubscription(name: string, subscriptionName?: string): AzureServiceBusSubscriptionResource
methodaddServiceBusTopicbuilder
Adds an Azure Service Bus Topic resource to the application model.
addServiceBusTopic(name: string, topicName?: string): AzureServiceBusTopicResource
methodrunAsEmulatorbuilder
Configures the Azure Service Bus resource to run with the local emulator
runAsEmulator(configureContainer?: (obj: AzureServiceBusEmulatorResource) => Promise<void>): AzureServiceBusResource
methodwithConfigurationFilebuilder
Copies the configuration file into an Azure Service Bus emulator resource.
withConfigurationFile(path: string): AzureServiceBusEmulatorResource
methodwithHostPortbuilder
Configures the host port for the Azure Service Bus emulator is exposed on instead of using randomly assigned port.
withHostPort(port: number): AzureServiceBusEmulatorResource
methodwithPropertiesbuilder
Allows setting the properties of an Azure Service Bus Queue resource.
withProperties(configure: (obj: AzureServiceBusQueueResource) => Promise<void>): AzureServiceBusQueueResource
methodwithPropertiesbuilder
Allows setting the properties of an Azure Service Bus Topic resource.
withProperties(configure: (obj: AzureServiceBusTopicResource) => Promise<void>): AzureServiceBusTopicResource
methodwithPropertiesbuilder
Allows setting the properties of an Azure Service Bus Subscription resource.
withProperties(configure: (obj: AzureServiceBusSubscriptionResource) => Promise<void>): AzureServiceBusSubscriptionResource
methodwithServiceBusRoleAssignmentsbuilder
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.
withServiceBusRoleAssignments(target: AzureServiceBusResource, roles: AzureServiceBusRole[]): IResource

Enums