azure-native.servicebus.getSubscription

Explore with Pulumi AI

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

Using getSubscription

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 getSubscription(args: GetSubscriptionArgs, opts?: InvokeOptions): Promise<GetSubscriptionResult>
function getSubscriptionOutput(args: GetSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionResult>
def get_subscription(namespace_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     subscription_name: Optional[str] = None,
                     topic_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSubscriptionResult
def get_subscription_output(namespace_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     subscription_name: Optional[pulumi.Input[str]] = None,
                     topic_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionResult]
func LookupSubscription(ctx *Context, args *LookupSubscriptionArgs, opts ...InvokeOption) (*LookupSubscriptionResult, error)
func LookupSubscriptionOutput(ctx *Context, args *LookupSubscriptionOutputArgs, opts ...InvokeOption) LookupSubscriptionResultOutput

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

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

The following arguments are supported:

NamespaceName string

The namespace name

ResourceGroupName string

Name of the Resource group within the Azure subscription.

SubscriptionName string

The subscription name.

TopicName string

The topic name.

NamespaceName string

The namespace name

ResourceGroupName string

Name of the Resource group within the Azure subscription.

SubscriptionName string

The subscription name.

TopicName string

The topic name.

namespaceName String

The namespace name

resourceGroupName String

Name of the Resource group within the Azure subscription.

subscriptionName String

The subscription name.

topicName String

The topic name.

namespaceName string

The namespace name

resourceGroupName string

Name of the Resource group within the Azure subscription.

subscriptionName string

The subscription name.

topicName string

The topic name.

namespace_name str

The namespace name

resource_group_name str

Name of the Resource group within the Azure subscription.

subscription_name str

The subscription name.

topic_name str

The topic name.

namespaceName String

The namespace name

resourceGroupName String

Name of the Resource group within the Azure subscription.

subscriptionName String

The subscription name.

topicName String

The topic name.

getSubscription Result

The following output properties are available:

AccessedAt string

Last time there was a receive request to this subscription.

CountDetails Pulumi.AzureNative.ServiceBus.Outputs.MessageCountDetailsResponse

Message count details

CreatedAt string

Exact time the message was created.

Id string

Resource Id

MessageCount double

Number of messages.

Name string

Resource name

Type string

Resource type

UpdatedAt string

The exact time the message was updated.

AutoDeleteOnIdle string

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

DeadLetteringOnFilterEvaluationExceptions bool

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

DeadLetteringOnMessageExpiration bool

Value that indicates whether a subscription has dead letter support when a message expires.

DefaultMessageTimeToLive string

ISO 8061 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

ISO 8601 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.

ForwardDeadLetteredMessagesTo string

Queue/Topic name to forward the Dead Letter message

ForwardTo string

Queue/Topic name to forward the messages

LockDuration string

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

MaxDeliveryCount int

Number of maximum deliveries.

RequiresSession bool

Value indicating if a subscription supports the concept of sessions.

Status string

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

AccessedAt string

Last time there was a receive request to this subscription.

CountDetails MessageCountDetailsResponse

Message count details

CreatedAt string

Exact time the message was created.

Id string

Resource Id

MessageCount float64

Number of messages.

Name string

Resource name

Type string

Resource type

UpdatedAt string

The exact time the message was updated.

AutoDeleteOnIdle string

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

DeadLetteringOnFilterEvaluationExceptions bool

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

DeadLetteringOnMessageExpiration bool

Value that indicates whether a subscription has dead letter support when a message expires.

DefaultMessageTimeToLive string

ISO 8061 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

ISO 8601 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.

ForwardDeadLetteredMessagesTo string

Queue/Topic name to forward the Dead Letter message

ForwardTo string

Queue/Topic name to forward the messages

LockDuration string

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

MaxDeliveryCount int

Number of maximum deliveries.

RequiresSession bool

Value indicating if a subscription supports the concept of sessions.

Status string

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

accessedAt String

Last time there was a receive request to this subscription.

countDetails MessageCountDetailsResponse

Message count details

createdAt String

Exact time the message was created.

id String

Resource Id

messageCount Double

Number of messages.

name String

Resource name

type String

Resource type

updatedAt String

The exact time the message was updated.

autoDeleteOnIdle String

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

deadLetteringOnFilterEvaluationExceptions Boolean

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

deadLetteringOnMessageExpiration Boolean

Value that indicates whether a subscription has dead letter support when a message expires.

defaultMessageTimeToLive String

ISO 8061 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

ISO 8601 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.

forwardDeadLetteredMessagesTo String

Queue/Topic name to forward the Dead Letter message

forwardTo String

Queue/Topic name to forward the messages

lockDuration String

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

maxDeliveryCount Integer

Number of maximum deliveries.

requiresSession Boolean

Value indicating if a subscription supports the concept of sessions.

status String

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

accessedAt string

Last time there was a receive request to this subscription.

countDetails MessageCountDetailsResponse

Message count details

createdAt string

Exact time the message was created.

id string

Resource Id

messageCount number

Number of messages.

name string

Resource name

type string

Resource type

updatedAt string

The exact time the message was updated.

autoDeleteOnIdle string

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

deadLetteringOnFilterEvaluationExceptions boolean

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

deadLetteringOnMessageExpiration boolean

Value that indicates whether a subscription has dead letter support when a message expires.

defaultMessageTimeToLive string

ISO 8061 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

ISO 8601 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.

forwardDeadLetteredMessagesTo string

Queue/Topic name to forward the Dead Letter message

forwardTo string

Queue/Topic name to forward the messages

lockDuration string

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

maxDeliveryCount number

Number of maximum deliveries.

requiresSession boolean

Value indicating if a subscription supports the concept of sessions.

status string

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

accessed_at str

Last time there was a receive request to this subscription.

count_details MessageCountDetailsResponse

Message count details

created_at str

Exact time the message was created.

id str

Resource Id

message_count float

Number of messages.

name str

Resource name

type str

Resource type

updated_at str

The exact time the message was updated.

auto_delete_on_idle str

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

dead_lettering_on_filter_evaluation_exceptions bool

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

dead_lettering_on_message_expiration bool

Value that indicates whether a subscription has dead letter support when a message expires.

default_message_time_to_live str

ISO 8061 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

ISO 8601 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.

forward_dead_lettered_messages_to str

Queue/Topic name to forward the Dead Letter message

forward_to str

Queue/Topic name to forward the messages

lock_duration str

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

max_delivery_count int

Number of maximum deliveries.

requires_session bool

Value indicating if a subscription supports the concept of sessions.

status str

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

accessedAt String

Last time there was a receive request to this subscription.

countDetails Property Map

Message count details

createdAt String

Exact time the message was created.

id String

Resource Id

messageCount Number

Number of messages.

name String

Resource name

type String

Resource type

updatedAt String

The exact time the message was updated.

autoDeleteOnIdle String

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

deadLetteringOnFilterEvaluationExceptions Boolean

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

deadLetteringOnMessageExpiration Boolean

Value that indicates whether a subscription has dead letter support when a message expires.

defaultMessageTimeToLive String

ISO 8061 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

ISO 8601 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.

forwardDeadLetteredMessagesTo String

Queue/Topic name to forward the Dead Letter message

forwardTo String

Queue/Topic name to forward the messages

lockDuration String

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

maxDeliveryCount Number

Number of maximum deliveries.

requiresSession Boolean

Value indicating if a subscription supports the concept of sessions.

status String

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

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