AzureServiceBusSubscriptionResource

Handle

📦 Aspire.Hosting.Azure.ServiceBus v13.4.0

interface AzureServiceBusSubscriptionResource
  extends IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParent,
    AzureServiceBusTopicResource]],
    IValueProvider,
    IValueWithReferences,
    IResourceWithAzureFunctionsConfig {
  readonly connectionStringExpression: ReferenceExpression;
  deadLetteringOnMessageExpiration: boolean;
  defaultMessageTimeToLive: timespan;
  forwardDeadLetteredMessagesTo: string;
  forwardTo: string;
  lockDuration: timespan;
  maxDeliveryCount: number;
  readonly parent: AzureServiceBusTopicResource;
  requiresSession: boolean;
  readonly rules: List<Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusRule>;
  subscriptionName: string;
  withProperties(configure: (obj: AzureServiceBusSubscriptionResource) => Promise<void>): AzureServiceBusSubscriptionResource;
}

20 members

Properties

property connectionStringExpression ReferenceExpression get

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

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 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 deadlettered after this number of deliveries. default value is 10.

property parent AzureServiceBusTopicResource get

Gets the parent Azure Service Bus Topic resource.

property requiresSession boolean get · set

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

property rules List<Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusRule> get

The rules for this subscription.

property subscriptionName string get · set

The subscription name.

Methods

method withProperties builder

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

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

Parameters

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

Returns

AzureServiceBusSubscriptionResource