Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

AzureServiceBusQueueResource

Handle
📦 Aspire.Hosting.Azure.ServiceBus v17.0.0

Represents a Service Bus Queue. Initializes a new instance of the AzureServiceBusQueueResource class.

type AzureServiceBusQueueResource interface {
ExpressionValue
Resource
ResourceWithConnectionString
ResourceWithParent
}

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string expression for the Azure Service Bus Queue.
ConnectionStringExpression() *ReferenceExpression
propertyDeadLetteringOnMessageExpiration*boolget · set
A value that indicates whether this queue has dead letter support when a message expires.
DeadLetteringOnMessageExpiration() (*bool, error)
SetDeadLetteringOnMessageExpiration(value *bool) AzureServiceBusQueueResource
propertyDefaultMessageTimeToLive*float64get · set
ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
DefaultMessageTimeToLive() (*float64, error)
SetDefaultMessageTimeToLive(value *float64) AzureServiceBusQueueResource
propertyDuplicateDetectionHistoryTimeWindow*float64get · set
ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
DuplicateDetectionHistoryTimeWindow() (*float64, error)
SetDuplicateDetectionHistoryTimeWindow(value *float64) AzureServiceBusQueueResource
propertyForwardDeadLetteredMessagesTo*stringget · set
Queue/Topic name to forward the Dead Letter message.
ForwardDeadLetteredMessagesTo() (*string, error)
SetForwardDeadLetteredMessagesTo(value *string) AzureServiceBusQueueResource
propertyForwardTo*stringget · set
Queue/Topic name to forward the messages.
ForwardTo() (*string, error)
SetForwardTo(value *string) AzureServiceBusQueueResource
propertyLockDuration*float64get · set
ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
LockDuration() (*float64, error)
SetLockDuration(value *float64) AzureServiceBusQueueResource
propertyMaxDeliveryCount*float64get · set
The maximum delivery count. A message is automatically dead-lettered after this number of deliveries.
MaxDeliveryCount() (*float64, error)
SetMaxDeliveryCount(value *float64) AzureServiceBusQueueResource
propertyParentAzureServiceBusResourceget
Gets the parent Azure Service Bus resource.
Parent() AzureServiceBusResource
propertyQueueNamestringget · set
The queue name.
QueueName() (string, error)
SetQueueName(value string) AzureServiceBusQueueResource
propertyRequiresDuplicateDetection*boolget · set
A value indicating if this queue requires duplicate detection.
RequiresDuplicateDetection() (*bool, error)
SetRequiresDuplicateDetection(value *bool) AzureServiceBusQueueResource
propertyRequiresSession*boolget · set
A value that indicates whether the queue supports the concept of sessions.
RequiresSession() (*bool, error)
SetRequiresSession(value *bool) AzureServiceBusQueueResource
propertyResourceTypeDisplayNamestringget
Gets the ResourceTypeDisplayName property
ResourceTypeDisplayName() (string, error)

Methods

methodWithPropertiesbuilder
Allows setting the properties of an Azure Service Bus Queue resource.
WithProperties(configure func(obj AzureServiceBusQueueResource)) AzureServiceBusQueueResource
configurefunc(obj AzureServiceBusQueueResource)callbackA method that can be used for customizing the AzureServiceBusQueueResource.
AzureServiceBusQueueResource

The resource builder.

Returns a handle; failures surface later via Err().