1. Packages
  2. Azure Classic
  3. API Docs
  4. servicebus
  5. Queue

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

azure.servicebus.Queue

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi

    Manages a ServiceBus Queue.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleNamespace = new Azure.ServiceBus.Namespace("exampleNamespace", new()
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "Standard",
            Tags = 
            {
                { "source", "example" },
            },
        });
    
        var exampleQueue = new Azure.ServiceBus.Queue("exampleQueue", new()
        {
            NamespaceId = exampleNamespace.Id,
            EnablePartitioning = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/servicebus"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			Sku:               pulumi.String("Standard"),
    			Tags: pulumi.StringMap{
    				"source": pulumi.String("example"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = servicebus.NewQueue(ctx, "exampleQueue", &servicebus.QueueArgs{
    			NamespaceId:        exampleNamespace.ID(),
    			EnablePartitioning: pulumi.Bool(true),
    		})
    		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.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 pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_namespace = azure.servicebus.Namespace("exampleNamespace",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        sku="Standard",
        tags={
            "source": "example",
        })
    example_queue = azure.servicebus.Queue("exampleQueue",
        namespace_id=example_namespace.id,
        enable_partitioning=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        sku: "Standard",
        tags: {
            source: "example",
        },
    });
    const exampleQueue = new azure.servicebus.Queue("exampleQueue", {
        namespaceId: exampleNamespace.id,
        enablePartitioning: true,
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleNamespace:
        type: azure:servicebus:Namespace
        properties:
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
          sku: Standard
          tags:
            source: example
      exampleQueue:
        type: azure:servicebus:Queue
        properties:
          namespaceId: ${exampleNamespace.id}
          enablePartitioning: true
    

    Create Queue Resource

    new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);
    @overload
    def Queue(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auto_delete_on_idle: Optional[str] = None,
              dead_lettering_on_message_expiration: Optional[bool] = None,
              default_message_ttl: Optional[str] = None,
              duplicate_detection_history_time_window: Optional[str] = None,
              enable_batched_operations: Optional[bool] = None,
              enable_express: Optional[bool] = None,
              enable_partitioning: 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,
              max_message_size_in_kilobytes: Optional[int] = None,
              max_size_in_megabytes: Optional[int] = None,
              name: Optional[str] = None,
              namespace_id: Optional[str] = None,
              requires_duplicate_detection: Optional[bool] = None,
              requires_session: Optional[bool] = None,
              status: Optional[str] = None)
    @overload
    def Queue(resource_name: str,
              args: QueueArgs,
              opts: Optional[ResourceOptions] = None)
    func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)
    public Queue(string name, QueueArgs args, CustomResourceOptions? opts = null)
    public Queue(String name, QueueArgs args)
    public Queue(String name, QueueArgs args, CustomResourceOptions options)
    
    type: azure:servicebus:Queue
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args QueueArgs
    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 QueueArgs
    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 QueueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    NamespaceId string
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    AutoDeleteOnIdle string
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    DeadLetteringOnMessageExpiration bool
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    DefaultMessageTtl string
    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 string
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    EnableBatchedOperations bool
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    EnableExpress bool

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    EnablePartitioning bool

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    ForwardDeadLetteredMessagesTo string
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    ForwardTo string
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    LockDuration string
    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 int
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    MaxMessageSizeInKilobytes int
    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 int
    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 string
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    RequiresDuplicateDetection bool
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    RequiresSession bool
    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 string
    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.
    NamespaceId string
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    AutoDeleteOnIdle string
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    DeadLetteringOnMessageExpiration bool
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    DefaultMessageTtl string
    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 string
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    EnableBatchedOperations bool
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    EnableExpress bool

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    EnablePartitioning bool

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    ForwardDeadLetteredMessagesTo string
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    ForwardTo string
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    LockDuration string
    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 int
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    MaxMessageSizeInKilobytes int
    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 int
    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 string
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    RequiresDuplicateDetection bool
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    RequiresSession bool
    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 string
    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.
    namespaceId String
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    autoDeleteOnIdle String
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    deadLetteringOnMessageExpiration Boolean
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    defaultMessageTtl String
    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 String
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    enableBatchedOperations Boolean
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    enableExpress Boolean

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    enablePartitioning Boolean

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    forwardDeadLetteredMessagesTo String
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    forwardTo String
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    lockDuration String
    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 Integer
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    maxMessageSizeInKilobytes Integer
    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 Integer
    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 String
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    requiresDuplicateDetection Boolean
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    requiresSession Boolean
    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 String
    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.
    namespaceId string
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    autoDeleteOnIdle string
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    deadLetteringOnMessageExpiration boolean
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    defaultMessageTtl string
    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 string
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    enableBatchedOperations boolean
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    enableExpress boolean

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    enablePartitioning boolean

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    forwardDeadLetteredMessagesTo string
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    forwardTo string
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    lockDuration string
    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 number
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    maxMessageSizeInKilobytes number
    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 number
    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 string
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    requiresDuplicateDetection boolean
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    requiresSession boolean
    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 string
    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.
    namespace_id str
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    auto_delete_on_idle str
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    dead_lettering_on_message_expiration bool
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    default_message_ttl str
    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.
    duplicate_detection_history_time_window str
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    enable_batched_operations bool
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    enable_express bool

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    enable_partitioning bool

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    forward_dead_lettered_messages_to str
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    forward_to str
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    lock_duration str
    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).
    max_delivery_count int
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    max_message_size_in_kilobytes int
    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.
    max_size_in_megabytes int
    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 str
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    requires_duplicate_detection bool
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    requires_session bool
    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 str
    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.
    namespaceId String
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    autoDeleteOnIdle String
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    deadLetteringOnMessageExpiration Boolean
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    defaultMessageTtl String
    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 String
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    enableBatchedOperations Boolean
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    enableExpress Boolean

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    enablePartitioning Boolean

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    forwardDeadLetteredMessagesTo String
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    forwardTo String
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    lockDuration String
    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 Number
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    maxMessageSizeInKilobytes Number
    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 Number
    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 String
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    requiresDuplicateDetection Boolean
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    requiresSession Boolean
    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 String
    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.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    NamespaceName string
    ResourceGroupName string
    Id string
    The provider-assigned unique ID for this managed resource.
    NamespaceName string
    ResourceGroupName string
    id String
    The provider-assigned unique ID for this managed resource.
    namespaceName String
    resourceGroupName String
    id string
    The provider-assigned unique ID for this managed resource.
    namespaceName string
    resourceGroupName string
    id str
    The provider-assigned unique ID for this managed resource.
    namespace_name str
    resource_group_name str
    id String
    The provider-assigned unique ID for this managed resource.
    namespaceName String
    resourceGroupName String

    Look up Existing Queue Resource

    Get an existing Queue resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: QueueState, opts?: CustomResourceOptions): Queue
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_delete_on_idle: Optional[str] = None,
            dead_lettering_on_message_expiration: Optional[bool] = None,
            default_message_ttl: Optional[str] = None,
            duplicate_detection_history_time_window: Optional[str] = None,
            enable_batched_operations: Optional[bool] = None,
            enable_express: Optional[bool] = None,
            enable_partitioning: 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,
            max_message_size_in_kilobytes: Optional[int] = None,
            max_size_in_megabytes: Optional[int] = None,
            name: Optional[str] = None,
            namespace_id: Optional[str] = None,
            namespace_name: Optional[str] = None,
            requires_duplicate_detection: Optional[bool] = None,
            requires_session: Optional[bool] = None,
            resource_group_name: Optional[str] = None,
            status: Optional[str] = None) -> Queue
    func GetQueue(ctx *Context, name string, id IDInput, state *QueueState, opts ...ResourceOption) (*Queue, error)
    public static Queue Get(string name, Input<string> id, QueueState? state, CustomResourceOptions? opts = null)
    public static Queue get(String name, Output<String> id, QueueState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoDeleteOnIdle string
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    DeadLetteringOnMessageExpiration bool
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    DefaultMessageTtl string
    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 string
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    EnableBatchedOperations bool
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    EnableExpress bool

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    EnablePartitioning bool

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    ForwardDeadLetteredMessagesTo string
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    ForwardTo string
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    LockDuration string
    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 int
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    MaxMessageSizeInKilobytes int
    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 int
    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 string
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    NamespaceId string
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    NamespaceName string
    RequiresDuplicateDetection bool
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    RequiresSession bool
    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.
    ResourceGroupName string
    Status string
    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.
    AutoDeleteOnIdle string
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    DeadLetteringOnMessageExpiration bool
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    DefaultMessageTtl string
    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 string
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    EnableBatchedOperations bool
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    EnableExpress bool

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    EnablePartitioning bool

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    ForwardDeadLetteredMessagesTo string
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    ForwardTo string
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    LockDuration string
    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 int
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    MaxMessageSizeInKilobytes int
    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 int
    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 string
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    NamespaceId string
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    NamespaceName string
    RequiresDuplicateDetection bool
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    RequiresSession bool
    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.
    ResourceGroupName string
    Status string
    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.
    autoDeleteOnIdle String
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    deadLetteringOnMessageExpiration Boolean
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    defaultMessageTtl String
    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 String
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    enableBatchedOperations Boolean
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    enableExpress Boolean

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    enablePartitioning Boolean

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    forwardDeadLetteredMessagesTo String
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    forwardTo String
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    lockDuration String
    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 Integer
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    maxMessageSizeInKilobytes Integer
    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 Integer
    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 String
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    namespaceId String
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    namespaceName String
    requiresDuplicateDetection Boolean
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    requiresSession Boolean
    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.
    resourceGroupName String
    status String
    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.
    autoDeleteOnIdle string
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    deadLetteringOnMessageExpiration boolean
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    defaultMessageTtl string
    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 string
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    enableBatchedOperations boolean
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    enableExpress boolean

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    enablePartitioning boolean

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    forwardDeadLetteredMessagesTo string
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    forwardTo string
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    lockDuration string
    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 number
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    maxMessageSizeInKilobytes number
    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 number
    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 string
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    namespaceId string
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    namespaceName string
    requiresDuplicateDetection boolean
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    requiresSession boolean
    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.
    resourceGroupName string
    status string
    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.
    auto_delete_on_idle str
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    dead_lettering_on_message_expiration bool
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    default_message_ttl str
    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.
    duplicate_detection_history_time_window str
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    enable_batched_operations bool
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    enable_express bool

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    enable_partitioning bool

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    forward_dead_lettered_messages_to str
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    forward_to str
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    lock_duration str
    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).
    max_delivery_count int
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    max_message_size_in_kilobytes int
    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.
    max_size_in_megabytes int
    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 str
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    namespace_id str
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    namespace_name str
    requires_duplicate_detection bool
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    requires_session bool
    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.
    resource_group_name str
    status str
    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.
    autoDeleteOnIdle String
    The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
    deadLetteringOnMessageExpiration Boolean
    Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.
    defaultMessageTtl String
    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 String
    The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (PT10M).
    enableBatchedOperations Boolean
    Boolean flag which controls whether server-side batched operations are enabled. Defaults to true.
    enableExpress Boolean

    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.

    NOTE: Service Bus Premium namespaces do not support Express Entities, so enable_express MUST be set to false.

    enablePartitioning Boolean

    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.

    NOTE: Partitioning is available at entity creation for all queues and topics in Basic or Standard SKUs. It is not available for the Premium messaging SKU, but any previously existing partitioned entities in Premium namespaces continue to work as expected. Please see the documentation for more information.

    forwardDeadLetteredMessagesTo String
    The name of a Queue or Topic to automatically forward dead lettered messages to.
    forwardTo String
    The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
    lockDuration String
    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 Number
    Integer value which controls when a message is automatically dead lettered. Defaults to 10.
    maxMessageSizeInKilobytes Number
    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 Number
    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 String
    Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.
    namespaceId String
    The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
    namespaceName String
    requiresDuplicateDetection Boolean
    Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.
    requiresSession Boolean
    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.
    resourceGroupName String
    status String
    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.

    Import

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

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.67.0 published on Wednesday, Feb 21, 2024 by Pulumi