Aspire.Hosting.Azure.ServiceBus
Official
📦 Aspire.Hosting.Azure.ServiceBus v13.2.0 41 Functions
19 Types
19 types and 54 members
Types
handle
AzureBicepResource 9 members handle
AzureEnvironmentResource 2 members handle
AzureProvisioningResource 1 members handle
AzureResourceInfrastructure 3 members type
AzureServiceBusCorrelationFilter 10 fields handle
AzureServiceBusEmulatorResource 2 members handle
AzureServiceBusQueueResource 22 members handle
AzureServiceBusResource 3 members type
AzureServiceBusRule 3 fields handle
AzureServiceBusSubscriptionResource 19 members handle
AzureServiceBusTopicResource 11 members handle
AzureUserAssignedIdentityResource handle
BicepOutputReference 3 members interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzureResource 9 members Functions
method
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource method
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource method
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder method
addAzureServiceBus builder Adds an Azure Service Bus namespace resource
addAzureServiceBus(name: string): AzureServiceBusResource method
addAzureUserAssignedIdentity builder Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource method
addBicepTemplate builder Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource method
addBicepTemplateString builder Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource method
addServiceBusQueue builder Adds an Azure Service Bus queue resource
addServiceBusQueue(name: string, queueName?: string): AzureServiceBusQueueResource method
addServiceBusSubscription builder Adds an Azure Service Bus subscription resource
addServiceBusSubscription(name: string, subscriptionName?: string): AzureServiceBusSubscriptionResource method
addServiceBusTopic builder Adds an Azure Service Bus topic resource
addServiceBusTopic(name: string, topicName?: string): AzureServiceBusTopicResource method
asExisting builder Marks an Azure resource as existing in both run and publish modes by using parameter resources
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
clearDefaultRoleAssignments builder Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource method
configureInfrastructure builder Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => Promise<void>): AzureProvisioningResource method
getBicepIdentifier Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string method
getOutput Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference method
isExisting Determines whether a resource is marked as existing
isExisting(): boolean method
publishAsConnectionString builder Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource method
publishAsExisting builder Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource method
publishAsExistingFromParameters builder Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
runAsEmulator builder Configures the Azure Service Bus resource to run with the local emulator
runAsEmulator(configureContainer?: (obj: AzureServiceBusEmulatorResource) => Promise<void>): AzureServiceBusResource method
runAsExisting builder Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource method
runAsExistingFromParameters builder Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource method
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource method
withConfigurationFile builder Sets the emulator configuration file path
withConfigurationFile(path: string): AzureServiceBusEmulatorResource method
withEnvironmentFromKeyVaultSecret builder Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment method
withEnvironmentFromOutput builder Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment method
withHostPort builder Sets the host port for the Service Bus emulator endpoint
withHostPort(port: number): AzureServiceBusEmulatorResource method
withLocation builder Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource method
withParameter builder Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource method
withParameterFromConnectionString builder Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource method
withParameterFromEndpoint builder Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource method
withParameterFromOutput builder Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource method
withParameterFromParameter builder Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource method
withParameterFromReferenceExpression builder Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource method
withParameterStringValue builder Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource method
withParameterStringValues builder Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource method
withProperties builder Configures properties of an Azure Service Bus queue
withProperties(configure: (obj: AzureServiceBusQueueResource) => Promise<void>): AzureServiceBusQueueResource method
withProperties builder Configures properties of an Azure Service Bus topic
withProperties(configure: (obj: AzureServiceBusTopicResource) => Promise<void>): AzureServiceBusTopicResource method
withProperties builder Configures properties of an Azure Service Bus subscription
withProperties(configure: (obj: AzureServiceBusSubscriptionResource) => Promise<void>): AzureServiceBusSubscriptionResource method
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource method
withServiceBusRoleAssignments builder Assigns Service Bus roles to a resource
withServiceBusRoleAssignments(target: AzureServiceBusResource, roles: AzureServiceBusRole[]): IResource