pulumi-azure-kotlin/com.pulumi.azure.eventhub.kotlin/QueueArgs

QueueArgs

data class QueueArgs constructor(val autoDeleteOnIdle: Output<String>? = null, val deadLetteringOnMessageExpiration: Output<Boolean>? = null, val defaultMessageTtl: 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<Int>? = null, val maxSizeInMegabytes: Output<Int>? = null, val name: Output<String>? = null, val namespaceId: Output<String>? = null, val requiresDuplicateDetection: Output<Boolean>? = null, val requiresSession: Output<Boolean>? = null, val status: Output<String>? = null) : ConvertibleToJava<QueueArgs>

Manages a ServiceBus Queue.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.servicebus.Namespace;
import com.pulumi.azure.servicebus.NamespaceArgs;
import com.pulumi.azure.servicebus.Queue;
import com.pulumi.azure.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku("Standard")
            .tags(Map.of("source", "example"))
            .build());
        var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()
            .namespaceId(exampleNamespace.id())
            .enablePartitioning(true)
            .build());
    }
}

Import

Service Bus Queue can be imported using the resource id, e.g.

$ pulumi import azure:eventhub/queue:Queue example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ServiceBus/namespaces/sbns1/queues/snqueue1

Constructors

QueueArgs

fun ~~QueueArgs~~(autoDeleteOnIdle: Output<String>? = null, deadLetteringOnMessageExpiration: Output<Boolean>? = null, defaultMessageTtl: 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<Int>? = null, maxSizeInMegabytes: Output<Int>? = null, name: Output<String>? = null, namespaceId: Output<String>? = null, requiresDuplicateDetection: Output<Boolean>? = null, requiresSession: Output<Boolean>? = null, status: Output<String>? = null)

Functions

toJava

open override fun toJava(): QueueArgs

Properties

autoDeleteOnIdle

val autoDeleteOnIdle: Output<String>? = null

The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.

deadLetteringOnMessageExpiration

val deadLetteringOnMessageExpiration: Output<Boolean>? = null

Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.

defaultMessageTtl

val defaultMessageTtl: Output<String>? = null

The ISO 8601 timespan duration of the TTL of messages sent to this queue. This is the default value used when TTL is not set on message itself.

duplicateDetectionHistoryTimeWindow

val duplicateDetectionHistoryTimeWindow: Output<String>? = null

The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).

enableBatchedOperations

val enableBatchedOperations: Output<Boolean>? = null

Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.

enableExpress

val enableExpress: Output<Boolean>? = null

Boolean flag which controls whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. Defaults to false for Basic and Standard. For Premium, it MUST be set to false.

enablePartitioning

val enablePartitioning: Output<Boolean>? = null

Boolean flag which controls whether to enable the queue to be partitioned across multiple message brokers. Changing this forces a new resource to be created. Defaults to false for Basic and Standard.

forwardDeadLetteredMessagesTo

val forwardDeadLetteredMessagesTo: Output<String>? = null

The name of a Queue or Topic to automatically forward dead lettered messages to.

forwardTo

val forwardTo: Output<String>? = null

The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.

lockDuration

val lockDuration: Output<String>? = null

The ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. Maximum value is 5 minutes. Defaults to 1 minute (PT1M).

maxDeliveryCount

val maxDeliveryCount: Output<Int>? = null

Integer value which controls when a message is automatically dead lettered. Defaults to 10.

maxMessageSizeInKilobytes

val maxMessageSizeInKilobytes: Output<Int>? = null

Integer value which controls the maximum size of a message allowed on the queue for Premium SKU. For supported values see the "Large messages support" section of this document.

maxSizeInMegabytes

val maxSizeInMegabytes: Output<Int>? = null

Integer value which controls the size of memory allocated for the queue. For supported values see the "Queue or topic size" section of Service Bus Quotas. Defaults to 1024.

name

val name: Output<String>? = null

Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

namespaceId

val namespaceId: Output<String>? = null

The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

requiresDuplicateDetection

val requiresDuplicateDetection: Output<Boolean>? = null

Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.

requiresSession

val requiresSession: Output<Boolean>? = null

Boolean flag which controls whether the Queue requires sessions. This will allow ordered handling of unbounded sequences of related messages. With sessions enabled a queue can guarantee first-in-first-out delivery of messages. Changing this forces a new resource to be created. Defaults to false.

status

val status: Output<String>? = null

The status of the Queue. Possible values are Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, SendDisabled, Unknown. Note that Restoring is not accepted. Defaults to Active.