Azure Native v1.103.0, Jun 2 23

azure-native.servicebus.Topic

Explore with Pulumi AI

Description of topic resource. API Version: 2017-04-01.

Example Usage

TopicCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var topic = new AzureNative.ServiceBus.Topic("topic", new()
    {
        EnableExpress = true,
        NamespaceName = "sdk-Namespace-1617",
        ResourceGroupName = "ArunMonocle",
        TopicName = "sdk-Topics-5488",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicebus.NewTopic(ctx, "topic", &servicebus.TopicArgs{
			EnableExpress:     pulumi.Bool(true),
			NamespaceName:     pulumi.String("sdk-Namespace-1617"),
			ResourceGroupName: pulumi.String("ArunMonocle"),
			TopicName:         pulumi.String("sdk-Topics-5488"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.servicebus.Topic;
import com.pulumi.azurenative.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 topic = new Topic("topic", TopicArgs.builder()        
            .enableExpress(true)
            .namespaceName("sdk-Namespace-1617")
            .resourceGroupName("ArunMonocle")
            .topicName("sdk-Topics-5488")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

topic = azure_native.servicebus.Topic("topic",
    enable_express=True,
    namespace_name="sdk-Namespace-1617",
    resource_group_name="ArunMonocle",
    topic_name="sdk-Topics-5488")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const topic = new azure_native.servicebus.Topic("topic", {
    enableExpress: true,
    namespaceName: "sdk-Namespace-1617",
    resourceGroupName: "ArunMonocle",
    topicName: "sdk-Topics-5488",
});

resources:
  topic:
    type: azure-native:servicebus:Topic
    properties:
      enableExpress: true
      namespaceName: sdk-Namespace-1617
      resourceGroupName: ArunMonocle
      topicName: sdk-Topics-5488

Create Topic Resource

new Topic(name: string, args: TopicArgs, opts?: CustomResourceOptions);

@overload
def Topic(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          auto_delete_on_idle: Optional[str] = None,
          default_message_time_to_live: Optional[str] = None,
          duplicate_detection_history_time_window: Optional[str] = None,
          enable_batched_operations: Optional[bool] = None,
          enable_express: Optional[bool] = None,
          enable_partitioning: Optional[bool] = None,
          max_size_in_megabytes: Optional[int] = None,
          namespace_name: Optional[str] = None,
          requires_duplicate_detection: Optional[bool] = None,
          resource_group_name: Optional[str] = None,
          status: Optional[EntityStatus] = None,
          support_ordering: Optional[bool] = None,
          topic_name: Optional[str] = None)
@overload
def Topic(resource_name: str,
          args: TopicArgs,
          opts: Optional[ResourceOptions] = 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-native:servicebus:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args 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 string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TopicArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args 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

The Topic resource accepts the following input properties:

NamespaceName string: The namespace name
ResourceGroupName string: Name of the Resource group within the Azure subscription.
AutoDeleteOnIdle string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
DefaultMessageTimeToLive string: 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.
DuplicateDetectionHistoryTimeWindow string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
EnableBatchedOperations bool: Value that indicates whether server-side batched operations are enabled.
EnableExpress bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
EnablePartitioning bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
MaxSizeInMegabytes int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
RequiresDuplicateDetection bool: Value indicating if this topic requires duplicate detection.
Status Pulumi.AzureNative.ServiceBus.EntityStatus: Enumerates the possible values for the status of a messaging entity.
SupportOrdering bool: Value that indicates whether the topic supports ordering.
TopicName string: The topic name.

NamespaceName string: The namespace name
ResourceGroupName string: Name of the Resource group within the Azure subscription.
AutoDeleteOnIdle string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
DefaultMessageTimeToLive string: 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.
DuplicateDetectionHistoryTimeWindow string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
EnableBatchedOperations bool: Value that indicates whether server-side batched operations are enabled.
EnableExpress bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
EnablePartitioning bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
MaxSizeInMegabytes int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
RequiresDuplicateDetection bool: Value indicating if this topic requires duplicate detection.
Status EntityStatus: Enumerates the possible values for the status of a messaging entity.
SupportOrdering bool: Value that indicates whether the topic supports ordering.
TopicName string: The topic name.

namespaceName String: The namespace name
resourceGroupName String: Name of the Resource group within the Azure subscription.
autoDeleteOnIdle String: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
defaultMessageTimeToLive String: 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.
duplicateDetectionHistoryTimeWindow String: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enableBatchedOperations Boolean: Value that indicates whether server-side batched operations are enabled.
enableExpress Boolean: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
enablePartitioning Boolean: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
maxSizeInMegabytes Integer: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
requiresDuplicateDetection Boolean: Value indicating if this topic requires duplicate detection.
status EntityStatus: Enumerates the possible values for the status of a messaging entity.
supportOrdering Boolean: Value that indicates whether the topic supports ordering.
topicName String: The topic name.

namespaceName string: The namespace name
resourceGroupName string: Name of the Resource group within the Azure subscription.
autoDeleteOnIdle string: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
defaultMessageTimeToLive string: 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.
duplicateDetectionHistoryTimeWindow string: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enableBatchedOperations boolean: Value that indicates whether server-side batched operations are enabled.
enableExpress boolean: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
enablePartitioning boolean: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
maxSizeInMegabytes number: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
requiresDuplicateDetection boolean: Value indicating if this topic requires duplicate detection.
status EntityStatus: Enumerates the possible values for the status of a messaging entity.
supportOrdering boolean: Value that indicates whether the topic supports ordering.
topicName string: The topic name.

namespace_name str: The namespace name
resource_group_name str: Name of the Resource group within the Azure subscription.
auto_delete_on_idle str: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
default_message_time_to_live str: 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.
duplicate_detection_history_time_window str: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enable_batched_operations bool: Value that indicates whether server-side batched operations are enabled.
enable_express bool: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
enable_partitioning bool: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
max_size_in_megabytes int: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
requires_duplicate_detection bool: Value indicating if this topic requires duplicate detection.
status EntityStatus: Enumerates the possible values for the status of a messaging entity.
support_ordering bool: Value that indicates whether the topic supports ordering.
topic_name str: The topic name.

namespaceName String: The namespace name
resourceGroupName String: Name of the Resource group within the Azure subscription.
autoDeleteOnIdle String: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
defaultMessageTimeToLive String: 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.
duplicateDetectionHistoryTimeWindow String: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enableBatchedOperations Boolean: Value that indicates whether server-side batched operations are enabled.
enableExpress Boolean: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
enablePartitioning Boolean: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
maxSizeInMegabytes Number: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
requiresDuplicateDetection Boolean: Value indicating if this topic requires duplicate detection.
status "Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown": Enumerates the possible values for the status of a messaging entity.
supportOrdering Boolean: Value that indicates whether the topic supports ordering.
topicName String: The topic name.

Outputs

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

AccessedAt string: Last time the message was sent, or a request was received, for this topic.
CountDetails Pulumi.AzureNative.ServiceBus.Outputs.MessageCountDetailsResponse: Message count details
CreatedAt string: Exact time the message was created.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name
SizeInBytes double: Size of the topic, in bytes.
SubscriptionCount int: Number of subscriptions.
Type string: Resource type
UpdatedAt string: The exact time the message was updated.

AccessedAt string: Last time the message was sent, or a request was received, for this topic.
CountDetails MessageCountDetailsResponse: Message count details
CreatedAt string: Exact time the message was created.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name
SizeInBytes float64: Size of the topic, in bytes.
SubscriptionCount int: Number of subscriptions.
Type string: Resource type
UpdatedAt string: The exact time the message was updated.

accessedAt String: Last time the message was sent, or a request was received, for this topic.
countDetails MessageCountDetailsResponse: Message count details
createdAt String: Exact time the message was created.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name
sizeInBytes Double: Size of the topic, in bytes.
subscriptionCount Integer: Number of subscriptions.
type String: Resource type
updatedAt String: The exact time the message was updated.

accessedAt string: Last time the message was sent, or a request was received, for this topic.
countDetails MessageCountDetailsResponse: Message count details
createdAt string: Exact time the message was created.
id string: The provider-assigned unique ID for this managed resource.
name string: Resource name
sizeInBytes number: Size of the topic, in bytes.
subscriptionCount number: Number of subscriptions.
type string: Resource type
updatedAt string: The exact time the message was updated.

accessed_at str: Last time the message was sent, or a request was received, for this topic.
count_details MessageCountDetailsResponse: Message count details
created_at str: Exact time the message was created.
id str: The provider-assigned unique ID for this managed resource.
name str: Resource name
size_in_bytes float: Size of the topic, in bytes.
subscription_count int: Number of subscriptions.
type str: Resource type
updated_at str: The exact time the message was updated.

accessedAt String: Last time the message was sent, or a request was received, for this topic.
countDetails Property Map: Message count details
createdAt String: Exact time the message was created.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name
sizeInBytes Number: Size of the topic, in bytes.
subscriptionCount Number: Number of subscriptions.
type String: Resource type
updatedAt String: The exact time the message was updated.

Supporting Types

EntityStatus

Active: Active
Disabled: Disabled
Restoring: Restoring
SendDisabled: SendDisabled
ReceiveDisabled: ReceiveDisabled
Creating: Creating
Deleting: Deleting
Renaming: Renaming
Unknown: Unknown

EntityStatusActive: Active
EntityStatusDisabled: Disabled
EntityStatusRestoring: Restoring
EntityStatusSendDisabled: SendDisabled
EntityStatusReceiveDisabled: ReceiveDisabled
EntityStatusCreating: Creating
EntityStatusDeleting: Deleting
EntityStatusRenaming: Renaming
EntityStatusUnknown: Unknown

Active: Active
Disabled: Disabled
Restoring: Restoring
SendDisabled: SendDisabled
ReceiveDisabled: ReceiveDisabled
Creating: Creating
Deleting: Deleting
Renaming: Renaming
Unknown: Unknown

Active: Active
Disabled: Disabled
Restoring: Restoring
SendDisabled: SendDisabled
ReceiveDisabled: ReceiveDisabled
Creating: Creating
Deleting: Deleting
Renaming: Renaming
Unknown: Unknown

ACTIVE: Active
DISABLED: Disabled
RESTORING: Restoring
SEND_DISABLED: SendDisabled
RECEIVE_DISABLED: ReceiveDisabled
CREATING: Creating
DELETING: Deleting
RENAMING: Renaming
UNKNOWN: Unknown

"Active": Active
"Disabled": Disabled
"Restoring": Restoring
"SendDisabled": SendDisabled
"ReceiveDisabled": ReceiveDisabled
"Creating": Creating
"Deleting": Deleting
"Renaming": Renaming
"Unknown": Unknown

MessageCountDetailsResponse

ActiveMessageCount double: Number of active messages in the queue, topic, or subscription.
DeadLetterMessageCount double: Number of messages that are dead lettered.
ScheduledMessageCount double: Number of scheduled messages.
TransferDeadLetterMessageCount double: Number of messages transferred into dead letters.
TransferMessageCount double: Number of messages transferred to another queue, topic, or subscription.

ActiveMessageCount float64: Number of active messages in the queue, topic, or subscription.
DeadLetterMessageCount float64: Number of messages that are dead lettered.
ScheduledMessageCount float64: Number of scheduled messages.
TransferDeadLetterMessageCount float64: Number of messages transferred into dead letters.
TransferMessageCount float64: Number of messages transferred to another queue, topic, or subscription.

activeMessageCount Double: Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount Double: Number of messages that are dead lettered.
scheduledMessageCount Double: Number of scheduled messages.
transferDeadLetterMessageCount Double: Number of messages transferred into dead letters.
transferMessageCount Double: Number of messages transferred to another queue, topic, or subscription.

activeMessageCount number: Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount number: Number of messages that are dead lettered.
scheduledMessageCount number: Number of scheduled messages.
transferDeadLetterMessageCount number: Number of messages transferred into dead letters.
transferMessageCount number: Number of messages transferred to another queue, topic, or subscription.

active_message_count float: Number of active messages in the queue, topic, or subscription.
dead_letter_message_count float: Number of messages that are dead lettered.
scheduled_message_count float: Number of scheduled messages.
transfer_dead_letter_message_count float: Number of messages transferred into dead letters.
transfer_message_count float: Number of messages transferred to another queue, topic, or subscription.

activeMessageCount Number: Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount Number: Number of messages that are dead lettered.
scheduledMessageCount Number: Number of scheduled messages.
transferDeadLetterMessageCount Number: Number of messages transferred into dead letters.
transferMessageCount Number: Number of messages transferred to another queue, topic, or subscription.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:servicebus:Topic sdk-Topics-5488 /subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1617/topics/sdk-Topics-5488

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0