azure-native.servicebus.getTopic

Explore with Pulumi AI

Returns a description for the specified topic. API Version: 2017-04-01.

Using getTopic

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTopic(args: GetTopicArgs, opts?: InvokeOptions): Promise<GetTopicResult>
function getTopicOutput(args: GetTopicOutputArgs, opts?: InvokeOptions): Output<GetTopicResult>
def get_topic(namespace_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              topic_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTopicResult
def get_topic_output(namespace_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              topic_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTopicResult]
func LookupTopic(ctx *Context, args *LookupTopicArgs, opts ...InvokeOption) (*LookupTopicResult, error)
func LookupTopicOutput(ctx *Context, args *LookupTopicOutputArgs, opts ...InvokeOption) LookupTopicResultOutput

> Note: This function is named LookupTopic in the Go SDK.

public static class GetTopic 
{
    public static Task<GetTopicResult> InvokeAsync(GetTopicArgs args, InvokeOptions? opts = null)
    public static Output<GetTopicResult> Invoke(GetTopicInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:servicebus:getTopic
  arguments:
    # arguments dictionary

The following arguments are supported:

NamespaceName string

The namespace name

ResourceGroupName string

Name of the Resource group within the Azure subscription.

TopicName string

The topic name.

NamespaceName string

The namespace name

ResourceGroupName string

Name of the Resource group within the Azure subscription.

TopicName string

The topic name.

namespaceName String

The namespace name

resourceGroupName String

Name of the Resource group within the Azure subscription.

topicName String

The topic name.

namespaceName string

The namespace name

resourceGroupName string

Name of the Resource group within the Azure subscription.

topicName string

The topic name.

namespace_name str

The namespace name

resource_group_name str

Name of the Resource group within the Azure subscription.

topic_name str

The topic name.

namespaceName String

The namespace name

resourceGroupName String

Name of the Resource group within the Azure subscription.

topicName String

The topic name.

getTopic Result

The following output properties are available:

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

Resource Id

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.

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 string

Enumerates the possible values for the status of a messaging entity.

SupportOrdering bool

Value that indicates whether the topic supports ordering.

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

Resource Id

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.

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 string

Enumerates the possible values for the status of a messaging entity.

SupportOrdering bool

Value that indicates whether the topic supports ordering.

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

Resource Id

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.

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 String

Enumerates the possible values for the status of a messaging entity.

supportOrdering Boolean

Value that indicates whether the topic supports ordering.

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

Resource Id

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.

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 string

Enumerates the possible values for the status of a messaging entity.

supportOrdering boolean

Value that indicates whether the topic supports ordering.

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

Resource Id

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.

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 str

Enumerates the possible values for the status of a messaging entity.

support_ordering bool

Value that indicates whether the topic supports ordering.

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

Resource Id

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.

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 String

Enumerates the possible values for the status of a messaging entity.

supportOrdering Boolean

Value that indicates whether the topic supports ordering.

Supporting Types

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.

Package Details

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