Azure Native v1.103.0, Jun 2 23

azure-native.servicebus.Subscription

Explore with Pulumi AI

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

Example Usage

SubscriptionCreate

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

return await Deployment.RunAsync(() => 
{
    var subscription = new AzureNative.ServiceBus.Subscription("subscription", new()
    {
        EnableBatchedOperations = true,
        NamespaceName = "sdk-Namespace-1349",
        ResourceGroupName = "ResourceGroup",
        SubscriptionName = "sdk-Subscriptions-2178",
        TopicName = "sdk-Topics-8740",
    });

});

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.NewSubscription(ctx, "subscription", &servicebus.SubscriptionArgs{
			EnableBatchedOperations: pulumi.Bool(true),
			NamespaceName:           pulumi.String("sdk-Namespace-1349"),
			ResourceGroupName:       pulumi.String("ResourceGroup"),
			SubscriptionName:        pulumi.String("sdk-Subscriptions-2178"),
			TopicName:               pulumi.String("sdk-Topics-8740"),
		})
		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.Subscription;
import com.pulumi.azurenative.servicebus.SubscriptionArgs;
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 subscription = new Subscription("subscription", SubscriptionArgs.builder()        
            .enableBatchedOperations(true)
            .namespaceName("sdk-Namespace-1349")
            .resourceGroupName("ResourceGroup")
            .subscriptionName("sdk-Subscriptions-2178")
            .topicName("sdk-Topics-8740")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

subscription = azure_native.servicebus.Subscription("subscription",
    enable_batched_operations=True,
    namespace_name="sdk-Namespace-1349",
    resource_group_name="ResourceGroup",
    subscription_name="sdk-Subscriptions-2178",
    topic_name="sdk-Topics-8740")

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

const subscription = new azure_native.servicebus.Subscription("subscription", {
    enableBatchedOperations: true,
    namespaceName: "sdk-Namespace-1349",
    resourceGroupName: "ResourceGroup",
    subscriptionName: "sdk-Subscriptions-2178",
    topicName: "sdk-Topics-8740",
});

resources:
  subscription:
    type: azure-native:servicebus:Subscription
    properties:
      enableBatchedOperations: true
      namespaceName: sdk-Namespace-1349
      resourceGroupName: ResourceGroup
      subscriptionName: sdk-Subscriptions-2178
      topicName: sdk-Topics-8740

Create Subscription Resource

new Subscription(name: string, args: SubscriptionArgs, opts?: CustomResourceOptions);

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 auto_delete_on_idle: Optional[str] = None,
                 dead_lettering_on_filter_evaluation_exceptions: Optional[bool] = None,
                 dead_lettering_on_message_expiration: Optional[bool] = None,
                 default_message_time_to_live: Optional[str] = None,
                 duplicate_detection_history_time_window: Optional[str] = None,
                 enable_batched_operations: Optional[bool] = None,
                 forward_dead_lettered_messages_to: Optional[str] = None,
                 forward_to: Optional[str] = None,
                 lock_duration: Optional[str] = None,
                 max_delivery_count: Optional[int] = None,
                 namespace_name: Optional[str] = None,
                 requires_session: Optional[bool] = None,
                 resource_group_name: Optional[str] = None,
                 status: Optional[EntityStatus] = None,
                 subscription_name: Optional[str] = None,
                 topic_name: Optional[str] = None)
@overload
def Subscription(resource_name: str,
                 args: SubscriptionArgs,
                 opts: Optional[ResourceOptions] = None)

func NewSubscription(ctx *Context, name string, args SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)

public Subscription(string name, SubscriptionArgs args, CustomResourceOptions? opts = null)

public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)

type: azure-native:servicebus:Subscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args SubscriptionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Subscription 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 Subscription resource accepts the following input properties:

NamespaceName string: The namespace name
ResourceGroupName string: Name of the Resource group within the Azure subscription.
TopicName string: The topic name.
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 Pulumi.AzureNative.ServiceBus.EntityStatus: Enumerates the possible values for the status of a messaging entity.
SubscriptionName string: The subscription name.

NamespaceName string: The namespace name
ResourceGroupName string: Name of the Resource group within the Azure subscription.
TopicName string: The topic name.
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 EntityStatus: Enumerates the possible values for the status of a messaging entity.
SubscriptionName string: The subscription name.

namespaceName String: The namespace name
resourceGroupName String: Name of the Resource group within the Azure subscription.
topicName String: The topic name.
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 EntityStatus: Enumerates the possible values for the status of a messaging entity.
subscriptionName String: The subscription name.

namespaceName string: The namespace name
resourceGroupName string: Name of the Resource group within the Azure subscription.
topicName string: The topic name.
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 EntityStatus: Enumerates the possible values for the status of a messaging entity.
subscriptionName string: The subscription 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.
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 EntityStatus: Enumerates the possible values for the status of a messaging entity.
subscription_name str: The subscription name.

namespaceName String: The namespace name
resourceGroupName String: Name of the Resource group within the Azure subscription.
topicName String: The topic name.
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 "Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown": Enumerates the possible values for the status of a messaging entity.
subscriptionName String: The subscription name.

Outputs

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

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: The provider-assigned unique ID for this managed resource.
MessageCount double: Number of messages.
Name string: Resource name
Type string: Resource type
UpdatedAt string: The exact time the message was updated.

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: The provider-assigned unique ID for this managed resource.
MessageCount float64: Number of messages.
Name string: Resource name
Type string: Resource type
UpdatedAt string: The exact time the message was updated.

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: The provider-assigned unique ID for this managed resource.
messageCount Double: Number of messages.
name String: Resource name
type String: Resource type
updatedAt String: The exact time the message was updated.

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: The provider-assigned unique ID for this managed resource.
messageCount number: Number of messages.
name string: Resource name
type string: Resource type
updatedAt string: The exact time the message was updated.

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: The provider-assigned unique ID for this managed resource.
message_count float: Number of messages.
name str: Resource name
type str: Resource type
updated_at str: The exact time the message was updated.

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: The provider-assigned unique ID for this managed resource.
messageCount Number: Number of messages.
name String: Resource name
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:Subscription sdk-Subscriptions-2178 /subscriptions/Subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-1349/topics/sdk-Topics-8740/subscriptions/sdk-Subscriptions-2178

Package Details

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