SubscriptionArgs

data class SubscriptionArgs(val autoDeleteOnIdle: Output<String>? = null, val clientAffineProperties: Output<SBClientAffinePropertiesArgs>? = null, val deadLetteringOnFilterEvaluationExceptions: Output<Boolean>? = null, val deadLetteringOnMessageExpiration: Output<Boolean>? = null, val defaultMessageTimeToLive: Output<String>? = null, val duplicateDetectionHistoryTimeWindow: Output<String>? = null, val enableBatchedOperations: Output<Boolean>? = null, val forwardDeadLetteredMessagesTo: Output<String>? = null, val forwardTo: Output<String>? = null, val isClientAffine: Output<Boolean>? = null, val lockDuration: Output<String>? = null, val maxDeliveryCount: Output<Int>? = null, val namespaceName: Output<String>? = null, val requiresSession: Output<Boolean>? = null, val resourceGroupName: Output<String>? = null, val status: Output<EntityStatus>? = null, val subscriptionName: Output<String>? = null, val topicName: Output<String>? = null) : ConvertibleToJava<SubscriptionArgs>

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/#accessing-any-api-version-via-local-packages 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",
});
});
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
})
}
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

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}

Constructors

Link copied to clipboard
constructor(autoDeleteOnIdle: Output<String>? = null, clientAffineProperties: Output<SBClientAffinePropertiesArgs>? = null, deadLetteringOnFilterEvaluationExceptions: Output<Boolean>? = null, deadLetteringOnMessageExpiration: Output<Boolean>? = null, defaultMessageTimeToLive: Output<String>? = null, duplicateDetectionHistoryTimeWindow: Output<String>? = null, enableBatchedOperations: Output<Boolean>? = null, forwardDeadLetteredMessagesTo: Output<String>? = null, forwardTo: Output<String>? = null, isClientAffine: Output<Boolean>? = null, lockDuration: Output<String>? = null, maxDeliveryCount: Output<Int>? = null, namespaceName: Output<String>? = null, requiresSession: Output<Boolean>? = null, resourceGroupName: Output<String>? = null, status: Output<EntityStatus>? = null, subscriptionName: Output<String>? = null, topicName: Output<String>? = null)

Properties

Link copied to clipboard
val autoDeleteOnIdle: Output<String>? = null

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

Link copied to clipboard

Properties specific to client affine subscriptions.

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

Link copied to clipboard

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

Link copied to clipboard
val defaultMessageTimeToLive: Output<String>? = null

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.

Link copied to clipboard

ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

Link copied to clipboard
val enableBatchedOperations: Output<Boolean>? = null

Value that indicates whether server-side batched operations are enabled.

Link copied to clipboard

Queue/Topic name to forward the Dead Letter message

Link copied to clipboard
val forwardTo: Output<String>? = null

Queue/Topic name to forward the messages

Link copied to clipboard
val isClientAffine: Output<Boolean>? = null

Value that indicates whether the subscription has an affinity to the client id.

Link copied to clipboard
val lockDuration: Output<String>? = null

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

Link copied to clipboard
val maxDeliveryCount: Output<Int>? = null

Number of maximum deliveries.

Link copied to clipboard
val namespaceName: Output<String>? = null

The namespace name

Link copied to clipboard
val requiresSession: Output<Boolean>? = null

Value indicating if a subscription supports the concept of sessions.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val status: Output<EntityStatus>? = null

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

Link copied to clipboard
val subscriptionName: Output<String>? = null

The subscription name.

Link copied to clipboard
val topicName: Output<String>? = null

The topic name.

Functions

Link copied to clipboard
open override fun toJava(): SubscriptionArgs