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
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,
namespace_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
enable_batched_operations: Optional[bool] = None,
auto_delete_on_idle: Optional[str] = None,
enable_express: Optional[bool] = None,
enable_partitioning: Optional[bool] = None,
max_size_in_megabytes: Optional[int] = None,
duplicate_detection_history_time_window: Optional[str] = None,
requires_duplicate_detection: Optional[bool] = None,
default_message_time_to_live: Optional[str] = None,
status: Optional[EntityStatus] = None,
support_ordering: Optional[bool] = None,
topic_name: Optional[str] = None)
func NewTopic(ctx *Context, name string, args TopicArgs, opts ...ResourceOption) (*Topic, error)
public Topic(string name, TopicArgs args, CustomResourceOptions? opts = null)
type: azure-native:servicebus:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeTopicResource = new AzureNative.Servicebus.Topic("azure-nativeTopicResource", new()
{
NamespaceName = "string",
ResourceGroupName = "string",
EnableBatchedOperations = false,
AutoDeleteOnIdle = "string",
EnableExpress = false,
EnablePartitioning = false,
MaxSizeInMegabytes = 0,
DuplicateDetectionHistoryTimeWindow = "string",
RequiresDuplicateDetection = false,
DefaultMessageTimeToLive = "string",
Status = "Active",
SupportOrdering = false,
TopicName = "string",
});
example, err := servicebus.NewTopic(ctx, "azure-nativeTopicResource", &servicebus.TopicArgs{
NamespaceName: "string",
ResourceGroupName: "string",
EnableBatchedOperations: false,
AutoDeleteOnIdle: "string",
EnableExpress: false,
EnablePartitioning: false,
MaxSizeInMegabytes: 0,
DuplicateDetectionHistoryTimeWindow: "string",
RequiresDuplicateDetection: false,
DefaultMessageTimeToLive: "string",
Status: "Active",
SupportOrdering: false,
TopicName: "string",
})
var azure_nativeTopicResource = new Topic("azure-nativeTopicResource", TopicArgs.builder()
.namespaceName("string")
.resourceGroupName("string")
.enableBatchedOperations(false)
.autoDeleteOnIdle("string")
.enableExpress(false)
.enablePartitioning(false)
.maxSizeInMegabytes(0)
.duplicateDetectionHistoryTimeWindow("string")
.requiresDuplicateDetection(false)
.defaultMessageTimeToLive("string")
.status("Active")
.supportOrdering(false)
.topicName("string")
.build());
azure_native_topic_resource = azure_native.servicebus.Topic("azure-nativeTopicResource",
namespace_name=string,
resource_group_name=string,
enable_batched_operations=False,
auto_delete_on_idle=string,
enable_express=False,
enable_partitioning=False,
max_size_in_megabytes=0,
duplicate_detection_history_time_window=string,
requires_duplicate_detection=False,
default_message_time_to_live=string,
status=Active,
support_ordering=False,
topic_name=string)
const azure_nativeTopicResource = new azure_native.servicebus.Topic("azure-nativeTopicResource", {
namespaceName: "string",
resourceGroupName: "string",
enableBatchedOperations: false,
autoDeleteOnIdle: "string",
enableExpress: false,
enablePartitioning: false,
maxSizeInMegabytes: 0,
duplicateDetectionHistoryTimeWindow: "string",
requiresDuplicateDetection: false,
defaultMessageTimeToLive: "string",
status: "Active",
supportOrdering: false,
topicName: "string",
});
type: azure-native:servicebus:Topic
properties:
autoDeleteOnIdle: string
defaultMessageTimeToLive: string
duplicateDetectionHistoryTimeWindow: string
enableBatchedOperations: false
enableExpress: false
enablePartitioning: false
maxSizeInMegabytes: 0
namespaceName: string
requiresDuplicateDetection: false
resourceGroupName: string
status: Active
supportOrdering: false
topicName: string
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:
- Namespace
Name string - The namespace name
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- Auto
Delete stringOn Idle - ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
- Default
Message stringTime To Live - 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 stringHistory Time Window - ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- Enable
Batched boolOperations - 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 intIn Megabytes - Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
- Requires
Duplicate boolDetection - Value indicating if this topic requires duplicate detection.
- Status
Pulumi.
Azure Native. Service Bus. Entity Status - Enumerates the possible values for the status of a messaging entity.
- Support
Ordering bool - Value that indicates whether the topic supports ordering.
- Topic
Name string - The topic name.
- Namespace
Name string - The namespace name
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- Auto
Delete stringOn Idle - ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
- Default
Message stringTime To Live - 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 stringHistory Time Window - ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- Enable
Batched boolOperations - 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 intIn Megabytes - Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
- Requires
Duplicate boolDetection - Value indicating if this topic requires duplicate detection.
- Status
Entity
Status - Enumerates the possible values for the status of a messaging entity.
- Support
Ordering bool - Value that indicates whether the topic supports ordering.
- Topic
Name string - The topic name.
- namespace
Name String - The namespace name
- resource
Group StringName - Name of the Resource group within the Azure subscription.
- auto
Delete StringOn Idle - ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
- default
Message StringTime To Live - 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 StringHistory Time Window - ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- enable
Batched BooleanOperations - Value that indicates whether server-side batched operations are enabled.
- enable
Express Boolean - 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 Boolean - Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
- max
Size IntegerIn Megabytes - Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
- requires
Duplicate BooleanDetection - Value indicating if this topic requires duplicate detection.
- status
Entity
Status - Enumerates the possible values for the status of a messaging entity.
- support
Ordering Boolean - Value that indicates whether the topic supports ordering.
- topic
Name String - The topic name.
- namespace
Name string - The namespace name
- resource
Group stringName - Name of the Resource group within the Azure subscription.
- auto
Delete stringOn Idle - ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
- default
Message stringTime To Live - 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 stringHistory Time Window - ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- enable
Batched booleanOperations - Value that indicates whether server-side batched operations are enabled.
- enable
Express boolean - 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 boolean - Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
- max
Size numberIn Megabytes - Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
- requires
Duplicate booleanDetection - Value indicating if this topic requires duplicate detection.
- status
Entity
Status - Enumerates the possible values for the status of a messaging entity.
- support
Ordering boolean - Value that indicates whether the topic supports ordering.
- topic
Name string - The topic name.
- namespace_
name str - The namespace name
- resource_
group_ strname - Name of the Resource group within the Azure subscription.
- auto_
delete_ stron_ idle - ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
- default_
message_ strtime_ to_ live - 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_ strhistory_ time_ window - ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- enable_
batched_ booloperations - 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_ intin_ megabytes - Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
- requires_
duplicate_ booldetection - Value indicating if this topic requires duplicate detection.
- status
Entity
Status - 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.
- namespace
Name String - The namespace name
- resource
Group StringName - Name of the Resource group within the Azure subscription.
- auto
Delete StringOn Idle - ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
- default
Message StringTime To Live - 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 StringHistory Time Window - ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
- enable
Batched BooleanOperations - Value that indicates whether server-side batched operations are enabled.
- enable
Express Boolean - 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 Boolean - Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
- max
Size NumberIn Megabytes - Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
- requires
Duplicate BooleanDetection - Value indicating if this topic requires duplicate detection.
- status
"Active" | "Disabled" | "Restoring" | "Send
Disabled" | "Receive Disabled" | "Creating" | "Deleting" | "Renaming" | "Unknown" - Enumerates the possible values for the status of a messaging entity.
- support
Ordering Boolean - Value that indicates whether the topic supports ordering.
- topic
Name String - The topic name.
Outputs
All input properties are implicitly available as output properties. Additionally, the Topic resource produces the following output properties:
- Accessed
At string - Last time the message was sent, or a request was received, for this topic.
- Count
Details Pulumi.Azure Native. Service Bus. Outputs. Message Count Details Response - Message count details
- Created
At string - Exact time the message was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name
- Size
In doubleBytes - Size of the topic, in bytes.
- Subscription
Count int - Number of subscriptions.
- Type string
- Resource type
- Updated
At string - The exact time the message was updated.
- Accessed
At string - Last time the message was sent, or a request was received, for this topic.
- Count
Details MessageCount Details Response - Message count details
- Created
At string - Exact time the message was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name
- Size
In float64Bytes - Size of the topic, in bytes.
- Subscription
Count int - Number of subscriptions.
- Type string
- Resource type
- Updated
At string - The exact time the message was updated.
- accessed
At String - Last time the message was sent, or a request was received, for this topic.
- count
Details MessageCount Details Response - Message count details
- created
At String - Exact time the message was created.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name
- size
In DoubleBytes - Size of the topic, in bytes.
- subscription
Count Integer - Number of subscriptions.
- type String
- Resource type
- updated
At String - The exact time the message was updated.
- accessed
At string - Last time the message was sent, or a request was received, for this topic.
- count
Details MessageCount Details Response - Message count details
- created
At string - Exact time the message was created.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name
- size
In numberBytes - Size of the topic, in bytes.
- subscription
Count number - Number of subscriptions.
- type string
- Resource type
- updated
At 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 MessageCount Details Response - 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_ floatbytes - 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.
- accessed
At String - Last time the message was sent, or a request was received, for this topic.
- count
Details Property Map - Message count details
- created
At String - Exact time the message was created.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name
- size
In NumberBytes - Size of the topic, in bytes.
- subscription
Count Number - Number of subscriptions.
- type String
- Resource type
- updated
At String - The exact time the message was updated.
Supporting Types
EntityStatus, EntityStatusArgs
- Active
- Active
- Disabled
- Disabled
- Restoring
- Restoring
- Send
Disabled - SendDisabled
- Receive
Disabled - ReceiveDisabled
- Creating
- Creating
- Deleting
- Deleting
- Renaming
- Renaming
- Unknown
- Unknown
- Entity
Status Active - Active
- Entity
Status Disabled - Disabled
- Entity
Status Restoring - Restoring
- Entity
Status Send Disabled - SendDisabled
- Entity
Status Receive Disabled - ReceiveDisabled
- Entity
Status Creating - Creating
- Entity
Status Deleting - Deleting
- Entity
Status Renaming - Renaming
- Entity
Status 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
- Send
Disabled - SendDisabled
- Receive
Disabled - 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
- "Send
Disabled" - SendDisabled
- "Receive
Disabled" - ReceiveDisabled
- "Creating"
- Creating
- "Deleting"
- Deleting
- "Renaming"
- Renaming
- "Unknown"
- Unknown
MessageCountDetailsResponse, MessageCountDetailsResponseArgs
- Active
Message doubleCount - Number of active messages in the queue, topic, or subscription.
- Dead
Letter doubleMessage Count - Number of messages that are dead lettered.
- Scheduled
Message doubleCount - Number of scheduled messages.
- Transfer
Dead doubleLetter Message Count - Number of messages transferred into dead letters.
- Transfer
Message doubleCount - Number of messages transferred to another queue, topic, or subscription.
- Active
Message float64Count - Number of active messages in the queue, topic, or subscription.
- Dead
Letter float64Message Count - Number of messages that are dead lettered.
- Scheduled
Message float64Count - Number of scheduled messages.
- Transfer
Dead float64Letter Message Count - Number of messages transferred into dead letters.
- Transfer
Message float64Count - Number of messages transferred to another queue, topic, or subscription.
- active
Message DoubleCount - Number of active messages in the queue, topic, or subscription.
- dead
Letter DoubleMessage Count - Number of messages that are dead lettered.
- scheduled
Message DoubleCount - Number of scheduled messages.
- transfer
Dead DoubleLetter Message Count - Number of messages transferred into dead letters.
- transfer
Message DoubleCount - Number of messages transferred to another queue, topic, or subscription.
- active
Message numberCount - Number of active messages in the queue, topic, or subscription.
- dead
Letter numberMessage Count - Number of messages that are dead lettered.
- scheduled
Message numberCount - Number of scheduled messages.
- transfer
Dead numberLetter Message Count - Number of messages transferred into dead letters.
- transfer
Message numberCount - Number of messages transferred to another queue, topic, or subscription.
- active_
message_ floatcount - Number of active messages in the queue, topic, or subscription.
- dead_
letter_ floatmessage_ count - Number of messages that are dead lettered.
- scheduled_
message_ floatcount - Number of scheduled messages.
- transfer_
dead_ floatletter_ message_ count - Number of messages transferred into dead letters.
- transfer_
message_ floatcount - Number of messages transferred to another queue, topic, or subscription.
- active
Message NumberCount - Number of active messages in the queue, topic, or subscription.
- dead
Letter NumberMessage Count - Number of messages that are dead lettered.
- scheduled
Message NumberCount - Number of scheduled messages.
- transfer
Dead NumberLetter Message Count - Number of messages transferred into dead letters.
- transfer
Message NumberCount - 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0