Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. servicebus
  5. Subscription
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.servicebus.Subscription

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Description of subscription resource.

Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-01-01-preview.

Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native servicebus [ApiVersion]. See the version guide for details.

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",
    });

});
Copy
package main

import (
	servicebus "github.com/pulumi/pulumi-azure-native-sdk/servicebus/v3"
	"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
	})
}
Copy
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());

    }
}
Copy
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",
});
Copy
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")
Copy
resources:
  subscription:
    type: azure-native:servicebus:Subscription
    properties:
      enableBatchedOperations: true
      namespaceName: sdk-Namespace-1349
      resourceGroupName: ResourceGroup
      subscriptionName: sdk-Subscriptions-2178
      topicName: sdk-Topics-8740
Copy

Create Subscription Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Subscription(name: string, args: SubscriptionArgs, opts?: CustomResourceOptions);
@overload
def Subscription(resource_name: str,
                 args: SubscriptionArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 namespace_name: Optional[str] = None,
                 topic_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 default_message_time_to_live: Optional[str] = None,
                 lock_duration: 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,
                 is_client_affine: Optional[bool] = None,
                 auto_delete_on_idle: Optional[str] = None,
                 max_delivery_count: Optional[int] = None,
                 dead_lettering_on_message_expiration: Optional[bool] = None,
                 requires_session: Optional[bool] = None,
                 dead_lettering_on_filter_evaluation_exceptions: Optional[bool] = None,
                 status: Optional[EntityStatus] = None,
                 subscription_name: Optional[str] = None,
                 client_affine_properties: Optional[SBClientAffinePropertiesArgs] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SubscriptionArgs
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_nativeSubscriptionResource = new AzureNative.ServiceBus.Subscription("azure-nativeSubscriptionResource", new()
{
    NamespaceName = "string",
    TopicName = "string",
    ResourceGroupName = "string",
    DefaultMessageTimeToLive = "string",
    LockDuration = "string",
    DuplicateDetectionHistoryTimeWindow = "string",
    EnableBatchedOperations = false,
    ForwardDeadLetteredMessagesTo = "string",
    ForwardTo = "string",
    IsClientAffine = false,
    AutoDeleteOnIdle = "string",
    MaxDeliveryCount = 0,
    DeadLetteringOnMessageExpiration = false,
    RequiresSession = false,
    DeadLetteringOnFilterEvaluationExceptions = false,
    Status = AzureNative.ServiceBus.EntityStatus.Active,
    SubscriptionName = "string",
    ClientAffineProperties = new AzureNative.ServiceBus.Inputs.SBClientAffinePropertiesArgs
    {
        ClientId = "string",
        IsDurable = false,
        IsShared = false,
    },
});
Copy
example, err := servicebus.NewSubscription(ctx, "azure-nativeSubscriptionResource", &servicebus.SubscriptionArgs{
	NamespaceName:                             pulumi.String("string"),
	TopicName:                                 pulumi.String("string"),
	ResourceGroupName:                         pulumi.String("string"),
	DefaultMessageTimeToLive:                  pulumi.String("string"),
	LockDuration:                              pulumi.String("string"),
	DuplicateDetectionHistoryTimeWindow:       pulumi.String("string"),
	EnableBatchedOperations:                   pulumi.Bool(false),
	ForwardDeadLetteredMessagesTo:             pulumi.String("string"),
	ForwardTo:                                 pulumi.String("string"),
	IsClientAffine:                            pulumi.Bool(false),
	AutoDeleteOnIdle:                          pulumi.String("string"),
	MaxDeliveryCount:                          pulumi.Int(0),
	DeadLetteringOnMessageExpiration:          pulumi.Bool(false),
	RequiresSession:                           pulumi.Bool(false),
	DeadLetteringOnFilterEvaluationExceptions: pulumi.Bool(false),
	Status:           servicebus.EntityStatusActive,
	SubscriptionName: pulumi.String("string"),
	ClientAffineProperties: &servicebus.SBClientAffinePropertiesArgs{
		ClientId:  pulumi.String("string"),
		IsDurable: pulumi.Bool(false),
		IsShared:  pulumi.Bool(false),
	},
})
Copy
var azure_nativeSubscriptionResource = new Subscription("azure-nativeSubscriptionResource", SubscriptionArgs.builder()
    .namespaceName("string")
    .topicName("string")
    .resourceGroupName("string")
    .defaultMessageTimeToLive("string")
    .lockDuration("string")
    .duplicateDetectionHistoryTimeWindow("string")
    .enableBatchedOperations(false)
    .forwardDeadLetteredMessagesTo("string")
    .forwardTo("string")
    .isClientAffine(false)
    .autoDeleteOnIdle("string")
    .maxDeliveryCount(0)
    .deadLetteringOnMessageExpiration(false)
    .requiresSession(false)
    .deadLetteringOnFilterEvaluationExceptions(false)
    .status("Active")
    .subscriptionName("string")
    .clientAffineProperties(SBClientAffinePropertiesArgs.builder()
        .clientId("string")
        .isDurable(false)
        .isShared(false)
        .build())
    .build());
Copy
azure_native_subscription_resource = azure_native.servicebus.Subscription("azure-nativeSubscriptionResource",
    namespace_name="string",
    topic_name="string",
    resource_group_name="string",
    default_message_time_to_live="string",
    lock_duration="string",
    duplicate_detection_history_time_window="string",
    enable_batched_operations=False,
    forward_dead_lettered_messages_to="string",
    forward_to="string",
    is_client_affine=False,
    auto_delete_on_idle="string",
    max_delivery_count=0,
    dead_lettering_on_message_expiration=False,
    requires_session=False,
    dead_lettering_on_filter_evaluation_exceptions=False,
    status=azure_native.servicebus.EntityStatus.ACTIVE,
    subscription_name="string",
    client_affine_properties={
        "client_id": "string",
        "is_durable": False,
        "is_shared": False,
    })
Copy
const azure_nativeSubscriptionResource = new azure_native.servicebus.Subscription("azure-nativeSubscriptionResource", {
    namespaceName: "string",
    topicName: "string",
    resourceGroupName: "string",
    defaultMessageTimeToLive: "string",
    lockDuration: "string",
    duplicateDetectionHistoryTimeWindow: "string",
    enableBatchedOperations: false,
    forwardDeadLetteredMessagesTo: "string",
    forwardTo: "string",
    isClientAffine: false,
    autoDeleteOnIdle: "string",
    maxDeliveryCount: 0,
    deadLetteringOnMessageExpiration: false,
    requiresSession: false,
    deadLetteringOnFilterEvaluationExceptions: false,
    status: azure_native.servicebus.EntityStatus.Active,
    subscriptionName: "string",
    clientAffineProperties: {
        clientId: "string",
        isDurable: false,
        isShared: false,
    },
});
Copy
type: azure-native:servicebus:Subscription
properties:
    autoDeleteOnIdle: string
    clientAffineProperties:
        clientId: string
        isDurable: false
        isShared: false
    deadLetteringOnFilterEvaluationExceptions: false
    deadLetteringOnMessageExpiration: false
    defaultMessageTimeToLive: string
    duplicateDetectionHistoryTimeWindow: string
    enableBatchedOperations: false
    forwardDeadLetteredMessagesTo: string
    forwardTo: string
    isClientAffine: false
    lockDuration: string
    maxDeliveryCount: 0
    namespaceName: string
    requiresSession: false
    resourceGroupName: string
    status: Active
    subscriptionName: string
    topicName: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Subscription resource accepts the following input properties:

NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
TopicName
This property is required.
Changes to this property will trigger replacement.
string
The topic name.
AutoDeleteOnIdle string
ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
ClientAffineProperties Pulumi.AzureNative.ServiceBus.Inputs.SBClientAffineProperties
Properties specific to client affine subscriptions.
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
IsClientAffine bool
Value that indicates whether the subscription has an affinity to the client id.
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 Changes to this property will trigger replacement. string
The subscription name.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
TopicName
This property is required.
Changes to this property will trigger replacement.
string
The topic name.
AutoDeleteOnIdle string
ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
ClientAffineProperties SBClientAffinePropertiesArgs
Properties specific to client affine subscriptions.
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
IsClientAffine bool
Value that indicates whether the subscription has an affinity to the client id.
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 Changes to this property will trigger replacement. string
The subscription name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
topicName
This property is required.
Changes to this property will trigger replacement.
String
The topic name.
autoDeleteOnIdle String
ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
clientAffineProperties SBClientAffineProperties
Properties specific to client affine subscriptions.
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
isClientAffine Boolean
Value that indicates whether the subscription has an affinity to the client id.
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 Changes to this property will trigger replacement. String
The subscription name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
topicName
This property is required.
Changes to this property will trigger replacement.
string
The topic name.
autoDeleteOnIdle string
ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
clientAffineProperties SBClientAffineProperties
Properties specific to client affine subscriptions.
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
isClientAffine boolean
Value that indicates whether the subscription has an affinity to the client id.
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 Changes to this property will trigger replacement. string
The subscription name.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The namespace name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
topic_name
This property is required.
Changes to this property will trigger replacement.
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.
client_affine_properties SBClientAffinePropertiesArgs
Properties specific to client affine subscriptions.
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
is_client_affine bool
Value that indicates whether the subscription has an affinity to the client id.
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 Changes to this property will trigger replacement. str
The subscription name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
topicName
This property is required.
Changes to this property will trigger replacement.
String
The topic name.
autoDeleteOnIdle String
ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
clientAffineProperties Property Map
Properties specific to client affine subscriptions.
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
isClientAffine Boolean
Value that indicates whether the subscription has an affinity to the client id.
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 Changes to this property will trigger replacement. 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.
AzureApiVersion string
The Azure API version of the resource.
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.
Location string
The geo-location where the resource lives
MessageCount double
Number of messages.
Name string
The name of the resource
SystemData Pulumi.AzureNative.ServiceBus.Outputs.SystemDataResponse
The system meta data relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
UpdatedAt string
The exact time the message was updated.
AccessedAt string
Last time there was a receive request to this subscription.
AzureApiVersion string
The Azure API version of the resource.
CountDetails MessageCountDetailsResponse
Message count details
CreatedAt string
Exact time the message was created.
Id string
The provider-assigned unique ID for this managed resource.
Location string
The geo-location where the resource lives
MessageCount float64
Number of messages.
Name string
The name of the resource
SystemData SystemDataResponse
The system meta data relating to this resource.
Type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
UpdatedAt string
The exact time the message was updated.
accessedAt String
Last time there was a receive request to this subscription.
azureApiVersion String
The Azure API version of the resource.
countDetails MessageCountDetailsResponse
Message count details
createdAt String
Exact time the message was created.
id String
The provider-assigned unique ID for this managed resource.
location String
The geo-location where the resource lives
messageCount Double
Number of messages.
name String
The name of the resource
systemData SystemDataResponse
The system meta data relating to this resource.
type String
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt String
The exact time the message was updated.
accessedAt string
Last time there was a receive request to this subscription.
azureApiVersion string
The Azure API version of the resource.
countDetails MessageCountDetailsResponse
Message count details
createdAt string
Exact time the message was created.
id string
The provider-assigned unique ID for this managed resource.
location string
The geo-location where the resource lives
messageCount number
Number of messages.
name string
The name of the resource
systemData SystemDataResponse
The system meta data relating to this resource.
type string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt string
The exact time the message was updated.
accessed_at str
Last time there was a receive request to this subscription.
azure_api_version str
The Azure API version of the resource.
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.
location str
The geo-location where the resource lives
message_count float
Number of messages.
name str
The name of the resource
system_data SystemDataResponse
The system meta data relating to this resource.
type str
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updated_at str
The exact time the message was updated.
accessedAt String
Last time there was a receive request to this subscription.
azureApiVersion String
The Azure API version of the resource.
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.
location String
The geo-location where the resource lives
messageCount Number
Number of messages.
name String
The name of the resource
systemData Property Map
The system meta data relating to this resource.
type String
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
updatedAt String
The exact time the message was updated.

Supporting Types

EntityStatus
, EntityStatusArgs

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
, MessageCountDetailsResponseArgs

ActiveMessageCount This property is required. double
Number of active messages in the queue, topic, or subscription.
DeadLetterMessageCount This property is required. double
Number of messages that are dead lettered.
ScheduledMessageCount This property is required. double
Number of scheduled messages.
TransferDeadLetterMessageCount This property is required. double
Number of messages transferred into dead letters.
TransferMessageCount This property is required. double
Number of messages transferred to another queue, topic, or subscription.
ActiveMessageCount This property is required. float64
Number of active messages in the queue, topic, or subscription.
DeadLetterMessageCount This property is required. float64
Number of messages that are dead lettered.
ScheduledMessageCount This property is required. float64
Number of scheduled messages.
TransferDeadLetterMessageCount This property is required. float64
Number of messages transferred into dead letters.
TransferMessageCount This property is required. float64
Number of messages transferred to another queue, topic, or subscription.
activeMessageCount This property is required. Double
Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount This property is required. Double
Number of messages that are dead lettered.
scheduledMessageCount This property is required. Double
Number of scheduled messages.
transferDeadLetterMessageCount This property is required. Double
Number of messages transferred into dead letters.
transferMessageCount This property is required. Double
Number of messages transferred to another queue, topic, or subscription.
activeMessageCount This property is required. number
Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount This property is required. number
Number of messages that are dead lettered.
scheduledMessageCount This property is required. number
Number of scheduled messages.
transferDeadLetterMessageCount This property is required. number
Number of messages transferred into dead letters.
transferMessageCount This property is required. number
Number of messages transferred to another queue, topic, or subscription.
active_message_count This property is required. float
Number of active messages in the queue, topic, or subscription.
dead_letter_message_count This property is required. float
Number of messages that are dead lettered.
scheduled_message_count This property is required. float
Number of scheduled messages.
transfer_dead_letter_message_count This property is required. float
Number of messages transferred into dead letters.
transfer_message_count This property is required. float
Number of messages transferred to another queue, topic, or subscription.
activeMessageCount This property is required. Number
Number of active messages in the queue, topic, or subscription.
deadLetterMessageCount This property is required. Number
Number of messages that are dead lettered.
scheduledMessageCount This property is required. Number
Number of scheduled messages.
transferDeadLetterMessageCount This property is required. Number
Number of messages transferred into dead letters.
transferMessageCount This property is required. Number
Number of messages transferred to another queue, topic, or subscription.

SBClientAffineProperties
, SBClientAffinePropertiesArgs

ClientId string
Indicates the Client ID of the application that created the client-affine subscription.
IsDurable bool
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
IsShared bool
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
ClientId string
Indicates the Client ID of the application that created the client-affine subscription.
IsDurable bool
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
IsShared bool
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
clientId String
Indicates the Client ID of the application that created the client-affine subscription.
isDurable Boolean
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
isShared Boolean
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
clientId string
Indicates the Client ID of the application that created the client-affine subscription.
isDurable boolean
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
isShared boolean
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
client_id str
Indicates the Client ID of the application that created the client-affine subscription.
is_durable bool
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
is_shared bool
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
clientId String
Indicates the Client ID of the application that created the client-affine subscription.
isDurable Boolean
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
isShared Boolean
For client-affine subscriptions, this value indicates whether the subscription is shared or not.

SBClientAffinePropertiesResponse
, SBClientAffinePropertiesResponseArgs

ClientId string
Indicates the Client ID of the application that created the client-affine subscription.
IsDurable bool
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
IsShared bool
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
ClientId string
Indicates the Client ID of the application that created the client-affine subscription.
IsDurable bool
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
IsShared bool
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
clientId String
Indicates the Client ID of the application that created the client-affine subscription.
isDurable Boolean
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
isShared Boolean
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
clientId string
Indicates the Client ID of the application that created the client-affine subscription.
isDurable boolean
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
isShared boolean
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
client_id str
Indicates the Client ID of the application that created the client-affine subscription.
is_durable bool
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
is_shared bool
For client-affine subscriptions, this value indicates whether the subscription is shared or not.
clientId String
Indicates the Client ID of the application that created the client-affine subscription.
isDurable Boolean
For client-affine subscriptions, this value indicates whether the subscription is durable or not.
isShared Boolean
For client-affine subscriptions, this value indicates whether the subscription is shared or not.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The type of identity that last modified the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The type of identity that last modified the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

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/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native