QueueArgs

data class QueueArgs(val autoDeleteOnIdle: Output<String>? = null, val deadLetteringOnMessageExpiration: Output<Boolean>? = null, val defaultMessageTimeToLive: Output<String>? = null, val duplicateDetectionHistoryTimeWindow: Output<String>? = null, val enableBatchedOperations: Output<Boolean>? = null, val enableExpress: Output<Boolean>? = null, val enablePartitioning: Output<Boolean>? = null, val forwardDeadLetteredMessagesTo: Output<String>? = null, val forwardTo: Output<String>? = null, val lockDuration: Output<String>? = null, val maxDeliveryCount: Output<Int>? = null, val maxMessageSizeInKilobytes: Output<Double>? = null, val maxSizeInMegabytes: Output<Int>? = null, val namespaceName: Output<String>? = null, val queueName: Output<String>? = null, val requiresDuplicateDetection: Output<Boolean>? = null, val requiresSession: Output<Boolean>? = null, val resourceGroupName: Output<String>? = null, val status: Output<EntityStatus>? = null) : ConvertibleToJava<QueueArgs>

Description of queue 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

QueueCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var queue = new AzureNative.ServiceBus.Queue("queue", new()
{
EnablePartitioning = true,
NamespaceName = "sdk-Namespace-3174",
QueueName = "sdk-Queues-5647",
ResourceGroupName = "ArunMonocle",
});
});
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.NewQueue(ctx, "queue", &servicebus.QueueArgs{
EnablePartitioning: pulumi.Bool(true),
NamespaceName: pulumi.String("sdk-Namespace-3174"),
QueueName: pulumi.String("sdk-Queues-5647"),
ResourceGroupName: pulumi.String("ArunMonocle"),
})
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.Queue;
import com.pulumi.azurenative.servicebus.QueueArgs;
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 queue = new Queue("queue", QueueArgs.builder()
.enablePartitioning(true)
.namespaceName("sdk-Namespace-3174")
.queueName("sdk-Queues-5647")
.resourceGroupName("ArunMonocle")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:servicebus:Queue sdk-Queues-5647 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}

Constructors

Link copied to clipboard
constructor(autoDeleteOnIdle: Output<String>? = null, deadLetteringOnMessageExpiration: Output<Boolean>? = null, defaultMessageTimeToLive: Output<String>? = null, duplicateDetectionHistoryTimeWindow: Output<String>? = null, enableBatchedOperations: Output<Boolean>? = null, enableExpress: Output<Boolean>? = null, enablePartitioning: Output<Boolean>? = null, forwardDeadLetteredMessagesTo: Output<String>? = null, forwardTo: Output<String>? = null, lockDuration: Output<String>? = null, maxDeliveryCount: Output<Int>? = null, maxMessageSizeInKilobytes: Output<Double>? = null, maxSizeInMegabytes: Output<Int>? = null, namespaceName: Output<String>? = null, queueName: Output<String>? = null, requiresDuplicateDetection: Output<Boolean>? = null, requiresSession: Output<Boolean>? = null, resourceGroupName: Output<String>? = null, status: Output<EntityStatus>? = null)

Properties

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

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

Link copied to clipboard

A value that indicates whether this queue has dead letter support when a message expires.

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

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.

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
val enableExpress: Output<Boolean>? = null

A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

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

A value that indicates whether the queue is to be partitioned across multiple message brokers.

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 lockDuration: Output<String>? = null

ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

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

The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

Link copied to clipboard
val maxMessageSizeInKilobytes: Output<Double>? = null

Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.

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

The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

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

The namespace name

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

The queue name.

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

A value indicating if this queue requires duplicate detection.

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

A value that indicates whether the queue 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.

Functions

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