Skip to content

Data Source: azurermServicebusSubscription

Use this data source to access information about an existing ServiceBus Subscription.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new cdktf.TerraformOutput(this, "servicebus_subscription", {
  value: "${data.azurerm_servicebus_namespace.example}",
});
new azurerm.dataAzurermServicebusSubscription.DataAzurermServicebusSubscription(
  this,
  "example",
  {
    name: "examplesubscription",
    namespace_name: "examplenamespace",
    resource_group_name: "exampleresources",
    topic_name: "exampletopic",
  }
);

Argument Reference

  • name - (Required) Specifies the name of the ServiceBus Subscription.

  • resourceGroupName - (Required) Specifies the name of the Resource Group where the ServiceBus Namespace exists.

  • namespaceName - (Required) The name of the ServiceBus Namespace.

  • topicName - (Required) The name of the ServiceBus Topic.

Attributes Reference

  • maxDeliveryCount - The maximum number of deliveries.

  • autoDeleteOnIdle - The idle interval after which the topic is automatically deleted.

  • defaultMessageTtl - The Default message timespan to live. 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.

  • lockDuration - The lock duration for the subscription.

  • deadLetteringOnMessageExpiration - Does the Service Bus Subscription have dead letter support when a message expires?

  • deadLetteringOnFilterEvaluationError - Does the ServiceBus Subscription have dead letter support on filter evaluation exceptions?

  • enableBatchedOperations - Are batched operations enabled on this ServiceBus Subscription?

  • requiresSession - Whether or not this ServiceBus Subscription supports session.

  • forwardTo - The name of a ServiceBus Queue or ServiceBus Topic where messages are automatically forwarded.

  • forwardDeadLetteredMessagesTo - The name of a Queue or Topic to automatically forward Dead Letter messages to.

  • clientScopedSubscriptionEnabled - Does the subscription scoped to a client id or not.

  • clientScopedSubscription - (Optional) A clientScopedSubscription block as defined below.

  • clientId - The Client ID of the application that created the client-scoped subscription.

  • isClientScopedSubscriptionShareable - The client scoped subscription is shareable or not.

  • isClientScopedSubscriptionDurable - The client scoped subscription is durable or not.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the ServiceBus Subscription.