Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. eventhub
  5. Topic

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.eventhub.Topic

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure
Deprecated: azure.eventhub.Topic has been deprecated in favor of azure.servicebus.Topic

Manages a ServiceBus Topic.

Note Topics can only be created in Namespaces with an SKU of standard or higher.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "tfex-servicebus-topic",
    location: "West Europe",
});
const exampleNamespace = new azure.servicebus.Namespace("example", {
    name: "tfex-servicebus-namespace",
    location: example.location,
    resourceGroupName: example.name,
    sku: "Standard",
    tags: {
        source: "example",
    },
});
const exampleTopic = new azure.servicebus.Topic("example", {
    name: "tfex_servicebus_topic",
    namespaceId: exampleNamespace.id,
    partitioningEnabled: true,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="tfex-servicebus-topic",
    location="West Europe")
example_namespace = azure.servicebus.Namespace("example",
    name="tfex-servicebus-namespace",
    location=example.location,
    resource_group_name=example.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("example",
    name="tfex_servicebus_topic",
    namespace_id=example_namespace.id,
    partitioning_enabled=True)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/servicebus"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("tfex-servicebus-topic"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := servicebus.NewNamespace(ctx, "example", &servicebus.NamespaceArgs{
			Name:              pulumi.String("tfex-servicebus-namespace"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku:               pulumi.String("Standard"),
			Tags: pulumi.StringMap{
				"source": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		_, err = servicebus.NewTopic(ctx, "example", &servicebus.TopicArgs{
			Name:                pulumi.String("tfex_servicebus_topic"),
			NamespaceId:         exampleNamespace.ID(),
			PartitioningEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "tfex-servicebus-topic",
        Location = "West Europe",
    });

    var exampleNamespace = new Azure.ServiceBus.Namespace("example", new()
    {
        Name = "tfex-servicebus-namespace",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "Standard",
        Tags = 
        {
            { "source", "example" },
        },
    });

    var exampleTopic = new Azure.ServiceBus.Topic("example", new()
    {
        Name = "tfex_servicebus_topic",
        NamespaceId = exampleNamespace.Id,
        PartitioningEnabled = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.servicebus.Namespace;
import com.pulumi.azure.servicebus.NamespaceArgs;
import com.pulumi.azure.servicebus.Topic;
import com.pulumi.azure.servicebus.TopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("tfex-servicebus-topic")
            .location("West Europe")
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
            .name("tfex-servicebus-namespace")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("Standard")
            .tags(Map.of("source", "example"))
            .build());

        var exampleTopic = new Topic("exampleTopic", TopicArgs.builder()
            .name("tfex_servicebus_topic")
            .namespaceId(exampleNamespace.id())
            .partitioningEnabled(true)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: tfex-servicebus-topic
      location: West Europe
  exampleNamespace:
    type: azure:servicebus:Namespace
    name: example
    properties:
      name: tfex-servicebus-namespace
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: Standard
      tags:
        source: example
  exampleTopic:
    type: azure:servicebus:Topic
    name: example
    properties:
      name: tfex_servicebus_topic
      namespaceId: ${exampleNamespace.id}
      partitioningEnabled: true
Copy

Create Topic Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Topic(name: string, args: TopicArgs, opts?: CustomResourceOptions);
@overload
def Topic(resource_name: str,
          args: TopicArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          auto_delete_on_idle: Optional[str] = None,
          batched_operations_enabled: Optional[bool] = None,
          default_message_ttl: Optional[str] = None,
          duplicate_detection_history_time_window: Optional[str] = None,
          express_enabled: Optional[bool] = None,
          max_message_size_in_kilobytes: Optional[int] = None,
          max_size_in_megabytes: Optional[int] = None,
          name: Optional[str] = None,
          namespace_id: Optional[str] = None,
          partitioning_enabled: Optional[bool] = None,
          requires_duplicate_detection: Optional[bool] = None,
          status: Optional[str] = None,
          support_ordering: Optional[bool] = None)
func NewTopic(ctx *Context, name string, args TopicArgs, opts ...ResourceOption) (*Topic, error)
public Topic(string name, TopicArgs args, CustomResourceOptions? opts = null)
public Topic(String name, TopicArgs args)
public Topic(String name, TopicArgs args, CustomResourceOptions options)

type: azure:eventhub:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TopicArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Topic Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Topic resource accepts the following input properties:

NamespaceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
AutoDeleteOnIdle string
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
BatchedOperationsEnabled bool
Boolean flag which controls if server-side batched operations are enabled.
DefaultMessageTtl string
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
DuplicateDetectionHistoryTimeWindow string
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
ExpressEnabled bool
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
MaxMessageSizeInKilobytes int
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
MaxSizeInMegabytes int
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
Name Changes to this property will trigger replacement. string
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
PartitioningEnabled Changes to this property will trigger replacement. bool

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

RequiresDuplicateDetection Changes to this property will trigger replacement. bool
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
Status string
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
SupportOrdering bool
Boolean flag which controls whether the Topic supports ordering.
NamespaceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
AutoDeleteOnIdle string
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
BatchedOperationsEnabled bool
Boolean flag which controls if server-side batched operations are enabled.
DefaultMessageTtl string
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
DuplicateDetectionHistoryTimeWindow string
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
ExpressEnabled bool
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
MaxMessageSizeInKilobytes int
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
MaxSizeInMegabytes int
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
Name Changes to this property will trigger replacement. string
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
PartitioningEnabled Changes to this property will trigger replacement. bool

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

RequiresDuplicateDetection Changes to this property will trigger replacement. bool
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
Status string
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
SupportOrdering bool
Boolean flag which controls whether the Topic supports ordering.
namespaceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
autoDeleteOnIdle String
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
batchedOperationsEnabled Boolean
Boolean flag which controls if server-side batched operations are enabled.
defaultMessageTtl String
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
duplicateDetectionHistoryTimeWindow String
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
expressEnabled Boolean
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
maxMessageSizeInKilobytes Integer
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
maxSizeInMegabytes Integer
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
name Changes to this property will trigger replacement. String
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
partitioningEnabled Changes to this property will trigger replacement. Boolean

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

requiresDuplicateDetection Changes to this property will trigger replacement. Boolean
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
status String
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
supportOrdering Boolean
Boolean flag which controls whether the Topic supports ordering.
namespaceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
autoDeleteOnIdle string
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
batchedOperationsEnabled boolean
Boolean flag which controls if server-side batched operations are enabled.
defaultMessageTtl string
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
duplicateDetectionHistoryTimeWindow string
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
expressEnabled boolean
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
maxMessageSizeInKilobytes number
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
maxSizeInMegabytes number
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
name Changes to this property will trigger replacement. string
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
partitioningEnabled Changes to this property will trigger replacement. boolean

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

requiresDuplicateDetection Changes to this property will trigger replacement. boolean
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
status string
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
supportOrdering boolean
Boolean flag which controls whether the Topic supports ordering.
namespace_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
auto_delete_on_idle str
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
batched_operations_enabled bool
Boolean flag which controls if server-side batched operations are enabled.
default_message_ttl str
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
duplicate_detection_history_time_window str
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
express_enabled bool
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
max_message_size_in_kilobytes int
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
max_size_in_megabytes int
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
name Changes to this property will trigger replacement. str
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
partitioning_enabled Changes to this property will trigger replacement. bool

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

requires_duplicate_detection Changes to this property will trigger replacement. bool
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
status str
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
support_ordering bool
Boolean flag which controls whether the Topic supports ordering.
namespaceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
autoDeleteOnIdle String
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
batchedOperationsEnabled Boolean
Boolean flag which controls if server-side batched operations are enabled.
defaultMessageTtl String
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
duplicateDetectionHistoryTimeWindow String
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
expressEnabled Boolean
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
maxMessageSizeInKilobytes Number
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
maxSizeInMegabytes Number
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
name Changes to this property will trigger replacement. String
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
partitioningEnabled Changes to this property will trigger replacement. Boolean

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

requiresDuplicateDetection Changes to this property will trigger replacement. Boolean
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
status String
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
supportOrdering Boolean
Boolean flag which controls whether the Topic supports ordering.

Outputs

All input properties are implicitly available as output properties. Additionally, the Topic resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
NamespaceName string
ResourceGroupName string
Id string
The provider-assigned unique ID for this managed resource.
NamespaceName string
ResourceGroupName string
id String
The provider-assigned unique ID for this managed resource.
namespaceName String
resourceGroupName String
id string
The provider-assigned unique ID for this managed resource.
namespaceName string
resourceGroupName string
id str
The provider-assigned unique ID for this managed resource.
namespace_name str
resource_group_name str
id String
The provider-assigned unique ID for this managed resource.
namespaceName String
resourceGroupName String

Look up Existing Topic Resource

Get an existing Topic resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TopicState, opts?: CustomResourceOptions): Topic
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_delete_on_idle: Optional[str] = None,
        batched_operations_enabled: Optional[bool] = None,
        default_message_ttl: Optional[str] = None,
        duplicate_detection_history_time_window: Optional[str] = None,
        express_enabled: Optional[bool] = None,
        max_message_size_in_kilobytes: Optional[int] = None,
        max_size_in_megabytes: Optional[int] = None,
        name: Optional[str] = None,
        namespace_id: Optional[str] = None,
        namespace_name: Optional[str] = None,
        partitioning_enabled: Optional[bool] = None,
        requires_duplicate_detection: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        status: Optional[str] = None,
        support_ordering: Optional[bool] = None) -> Topic
func GetTopic(ctx *Context, name string, id IDInput, state *TopicState, opts ...ResourceOption) (*Topic, error)
public static Topic Get(string name, Input<string> id, TopicState? state, CustomResourceOptions? opts = null)
public static Topic get(String name, Output<String> id, TopicState state, CustomResourceOptions options)
resources:  _:    type: azure:eventhub:Topic    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AutoDeleteOnIdle string
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
BatchedOperationsEnabled bool
Boolean flag which controls if server-side batched operations are enabled.
DefaultMessageTtl string
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
DuplicateDetectionHistoryTimeWindow string
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
ExpressEnabled bool
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
MaxMessageSizeInKilobytes int
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
MaxSizeInMegabytes int
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
Name Changes to this property will trigger replacement. string
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
NamespaceId Changes to this property will trigger replacement. string
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
NamespaceName string
PartitioningEnabled Changes to this property will trigger replacement. bool

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

RequiresDuplicateDetection Changes to this property will trigger replacement. bool
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
ResourceGroupName string
Status string
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
SupportOrdering bool
Boolean flag which controls whether the Topic supports ordering.
AutoDeleteOnIdle string
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
BatchedOperationsEnabled bool
Boolean flag which controls if server-side batched operations are enabled.
DefaultMessageTtl string
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
DuplicateDetectionHistoryTimeWindow string
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
ExpressEnabled bool
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
MaxMessageSizeInKilobytes int
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
MaxSizeInMegabytes int
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
Name Changes to this property will trigger replacement. string
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
NamespaceId Changes to this property will trigger replacement. string
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
NamespaceName string
PartitioningEnabled Changes to this property will trigger replacement. bool

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

RequiresDuplicateDetection Changes to this property will trigger replacement. bool
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
ResourceGroupName string
Status string
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
SupportOrdering bool
Boolean flag which controls whether the Topic supports ordering.
autoDeleteOnIdle String
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
batchedOperationsEnabled Boolean
Boolean flag which controls if server-side batched operations are enabled.
defaultMessageTtl String
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
duplicateDetectionHistoryTimeWindow String
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
expressEnabled Boolean
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
maxMessageSizeInKilobytes Integer
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
maxSizeInMegabytes Integer
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
name Changes to this property will trigger replacement. String
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
namespaceId Changes to this property will trigger replacement. String
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
namespaceName String
partitioningEnabled Changes to this property will trigger replacement. Boolean

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

requiresDuplicateDetection Changes to this property will trigger replacement. Boolean
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
resourceGroupName String
status String
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
supportOrdering Boolean
Boolean flag which controls whether the Topic supports ordering.
autoDeleteOnIdle string
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
batchedOperationsEnabled boolean
Boolean flag which controls if server-side batched operations are enabled.
defaultMessageTtl string
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
duplicateDetectionHistoryTimeWindow string
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
expressEnabled boolean
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
maxMessageSizeInKilobytes number
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
maxSizeInMegabytes number
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
name Changes to this property will trigger replacement. string
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
namespaceId Changes to this property will trigger replacement. string
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
namespaceName string
partitioningEnabled Changes to this property will trigger replacement. boolean

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

requiresDuplicateDetection Changes to this property will trigger replacement. boolean
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
resourceGroupName string
status string
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
supportOrdering boolean
Boolean flag which controls whether the Topic supports ordering.
auto_delete_on_idle str
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
batched_operations_enabled bool
Boolean flag which controls if server-side batched operations are enabled.
default_message_ttl str
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
duplicate_detection_history_time_window str
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
express_enabled bool
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
max_message_size_in_kilobytes int
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
max_size_in_megabytes int
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
name Changes to this property will trigger replacement. str
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
namespace_id Changes to this property will trigger replacement. str
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
namespace_name str
partitioning_enabled Changes to this property will trigger replacement. bool

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

requires_duplicate_detection Changes to this property will trigger replacement. bool
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
resource_group_name str
status str
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
support_ordering bool
Boolean flag which controls whether the Topic supports ordering.
autoDeleteOnIdle String
The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes. Defaults to P10675199DT2H48M5.4775807S.
batchedOperationsEnabled Boolean
Boolean flag which controls if server-side batched operations are enabled.
defaultMessageTtl String
The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself. Defaults to P10675199DT2H48M5.4775807S.
duplicateDetectionHistoryTimeWindow String
The ISO 8601 timespan duration during which duplicates can be detected. Defaults to PT10M (10 Minutes).
expressEnabled Boolean
Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
maxMessageSizeInKilobytes Number
Integer value which controls the maximum size of a message allowed on the topic for Premium SKU. For supported values see the "Large messages support" section of this document. Defaults to 256.
maxSizeInMegabytes Number
Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document. Defaults to 5120.
name Changes to this property will trigger replacement. String
Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.
namespaceId Changes to this property will trigger replacement. String
The ID of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.
namespaceName String
partitioningEnabled Changes to this property will trigger replacement. Boolean

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Changing this forces a new resource to be created.

NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. For premium namespaces, partitioning is available at namespace creation and all queues and topics in the partitioned namespace will be partitioned. Premium namespaces that have premium_messaging_partitions set to 1 are not partitioned. Please see the documentation for more information.

requiresDuplicateDetection Changes to this property will trigger replacement. Boolean
Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.
resourceGroupName String
status String
The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.
supportOrdering Boolean
Boolean flag which controls whether the Topic supports ordering.

Import

Service Bus Topics can be imported using the resource id, e.g.

$ pulumi import azure:eventhub/topic:Topic example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ServiceBus/namespaces/sbns1/topics/sntopic1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure