AzureServiceBusTopicResource

Handle

📦 Aspire.Hosting.Azure.ServiceBus v13.4.0

interface AzureServiceBusTopicResource
  extends IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParent,
    AzureServiceBusResource]],
    IValueProvider,
    IValueWithReferences,
    IResourceWithAzureFunctionsConfig {
  readonly connectionStringExpression: ReferenceExpression;
  defaultMessageTimeToLive: timespan;
  duplicateDetectionHistoryTimeWindow: timespan;
  readonly parent: AzureServiceBusResource;
  requiresDuplicateDetection: boolean;
  topicName: string;
  addServiceBusSubscription(
      name: string,
      subscriptionName?: string): AzureServiceBusSubscriptionResource;
  withProperties(configure: (obj: AzureServiceBusTopicResource) => Promise<void>): AzureServiceBusTopicResource;
}

12 members

Properties

property connectionStringExpression ReferenceExpression get

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

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 parent AzureServiceBusResource get

Gets the parent Azure Service Bus resource.

property requiresDuplicateDetection boolean get · set

A value indicating if this topic requires duplicate detection.

property topicName string get · set

The topic name.

Methods

method addServiceBusSubscription builder

Adds an Azure Service Bus Subscription resource to the application model.

addServiceBusSubscription(
    name: string,
    subscriptionName?: string): AzureServiceBusSubscriptionResource

Parameters

name string

subscriptionName string optional

Returns

AzureServiceBusSubscriptionResource

method withProperties builder

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

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

Parameters

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

Returns

AzureServiceBusTopicResource