AzureServiceBusQueueResource

Handle

📦 Aspire.Hosting.Azure.ServiceBus v13.4.0

interface AzureServiceBusQueueResource
  extends IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParent,
    AzureServiceBusResource]],
    IValueProvider,
    IValueWithReferences,
    IResourceWithAzureFunctionsConfig {
  readonly connectionStringExpression: ReferenceExpression;
  deadLetteringOnMessageExpiration: boolean;
  defaultMessageTimeToLive: timespan;
  duplicateDetectionHistoryTimeWindow: timespan;
  forwardDeadLetteredMessagesTo: string;
  forwardTo: string;
  lockDuration: timespan;
  maxDeliveryCount: number;
  readonly parent: AzureServiceBusResource;
  queueName: string;
  requiresDuplicateDetection: boolean;
  requiresSession: boolean;
  withProperties(configure: (obj: AzureServiceBusQueueResource) => Promise<void>): AzureServiceBusQueueResource;
}

23 members

Properties

property connectionStringExpression ReferenceExpression get

Gets the connection string expression for the Azure Service Bus Queue.

property deadLetteringOnMessageExpiration boolean get · set

A value that indicates whether this queue has dead letter support when a message expires.

property defaultMessageTimeToLive timespan get · 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.

property duplicateDetectionHistoryTimeWindow timespan get · set

ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

property forwardDeadLetteredMessagesTo string get · set

Queue/Topic name to forward the Dead Letter message.

property forwardTo string get · set

Queue/Topic name to forward the messages.

property lockDuration timespan get · 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.

property maxDeliveryCount number get · set

The maximum delivery count. A message is automatically dead-lettered after this number of deliveries.

property parent AzureServiceBusResource get

Gets the parent Azure Service Bus resource.

property queueName string get · set

The queue name.

property requiresDuplicateDetection boolean get · set

A value indicating if this queue requires duplicate detection.

property requiresSession boolean get · set

A value that indicates whether the queue supports the concept of sessions.

Methods

method withProperties builder

Allows setting the properties of an Azure Service Bus Queue resource.

withProperties(configure: (obj: AzureServiceBusQueueResource) => Promise<void>): AzureServiceBusQueueResource

Parameters

configure (obj: AzureServiceBusQueueResource) => Promise<void>

Returns

AzureServiceBusQueueResource