We recommend using Azure Native.
azure.eventhub.Queue
Explore with Pulumi AI
Manages a ServiceBus Queue.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "my-servicebus",
location: "West Europe",
});
const exampleNamespace = new azure.servicebus.Namespace("example", {
name: "tfex-servicebus-namespace",
location: example.location,
resourceGroupName: example.name,
sku: "Standard",
tags: {
source: "example",
},
});
const exampleQueue = new azure.servicebus.Queue("example", {
name: "tfex_servicebus_queue",
namespaceId: exampleNamespace.id,
enablePartitioning: true,
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="my-servicebus",
location="West Europe")
example_namespace = azure.servicebus.Namespace("example",
name="tfex-servicebus-namespace",
location=example.location,
resource_group_name=example.name,
sku="Standard",
tags={
"source": "example",
})
example_queue = azure.servicebus.Queue("example",
name="tfex_servicebus_queue",
namespace_id=example_namespace.id,
enable_partitioning=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 {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("my-servicebus"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleNamespace, err := servicebus.NewNamespace(ctx, "example", &servicebus.NamespaceArgs{
Name: pulumi.String("tfex-servicebus-namespace"),
Location: example.Location,
ResourceGroupName: example.Name,
Sku: pulumi.String("Standard"),
Tags: pulumi.StringMap{
"source": pulumi.String("example"),
},
})
if err != nil {
return err
}
_, err = servicebus.NewQueue(ctx, "example", &servicebus.QueueArgs{
Name: pulumi.String("tfex_servicebus_queue"),
NamespaceId: exampleNamespace.ID(),
EnablePartitioning: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "my-servicebus",
Location = "West Europe",
});
var exampleNamespace = new Azure.ServiceBus.Namespace("example", new()
{
Name = "tfex-servicebus-namespace",
Location = example.Location,
ResourceGroupName = example.Name,
Sku = "Standard",
Tags =
{
{ "source", "example" },
},
});
var exampleQueue = new Azure.ServiceBus.Queue("example", new()
{
Name = "tfex_servicebus_queue",
NamespaceId = exampleNamespace.Id,
EnablePartitioning = true,
});
});
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("my-servicebus")
.location("West Europe")
.build());
var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
.name("tfex-servicebus-namespace")
.location(example.location())
.resourceGroupName(example.name())
.sku("Standard")
.tags(Map.of("source", "example"))
.build());
var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()
.name("tfex_servicebus_queue")
.namespaceId(exampleNamespace.id())
.enablePartitioning(true)
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: my-servicebus
location: West Europe
exampleNamespace:
type: azure:servicebus:Namespace
name: example
properties:
name: tfex-servicebus-namespace
location: ${example.location}
resourceGroupName: ${example.name}
sku: Standard
tags:
source: example
exampleQueue:
type: azure:servicebus:Queue
name: example
properties:
name: tfex_servicebus_queue
namespaceId: ${exampleNamespace.id}
enablePartitioning: true
Create Queue Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);
@overload
def Queue(resource_name: str,
args: QueueArgs,
opts: Optional[ResourceOptions] = None)
@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)
func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)
public Queue(string name, QueueArgs args, CustomResourceOptions? opts = null)
type: azure:eventhub:Queue
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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:
- Namespace
Id string - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- Auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- Dead
Lettering boolOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - Default
Message stringTtl - 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 stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - Enable
Batched boolOperations - 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- Forward
Dead stringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- Forward
To string - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- Lock
Duration 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
). - Max
Delivery intCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - Max
Message intSize In Kilobytes - 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 intIn Megabytes - 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.
- Requires
Duplicate boolDetection - 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 string
- The status of the Queue. Possible values are
Active
,Creating
,Deleting
,Disabled
,ReceiveDisabled
,Renaming
,SendDisabled
,Unknown
. Note thatRestoring
is not accepted. Defaults toActive
.
- Namespace
Id string - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- Auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- Dead
Lettering boolOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - Default
Message stringTtl - 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 stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - Enable
Batched boolOperations - 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- Forward
Dead stringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- Forward
To string - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- Lock
Duration 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
). - Max
Delivery intCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - Max
Message intSize In Kilobytes - 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 intIn Megabytes - 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.
- Requires
Duplicate boolDetection - 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 string
- The status of the Queue. Possible values are
Active
,Creating
,Deleting
,Disabled
,ReceiveDisabled
,Renaming
,SendDisabled
,Unknown
. Note thatRestoring
is not accepted. Defaults toActive
.
- namespace
Id String - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- auto
Delete StringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- dead
Lettering BooleanOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - default
Message StringTtl - 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 StringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - enable
Batched BooleanOperations - Boolean flag which controls whether server-side batched operations are enabled. Defaults to
true
. - enable
Express 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- enable
Partitioning 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- forward
Dead StringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- forward
To String - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- lock
Duration 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
). - max
Delivery IntegerCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - max
Message IntegerSize In Kilobytes - 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 IntegerIn Megabytes - 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.
- requires
Duplicate BooleanDetection - Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to
false
. - requires
Session 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 thatRestoring
is not accepted. Defaults toActive
.
- namespace
Id string - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- dead
Lettering booleanOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - default
Message stringTtl - 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 stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - enable
Batched booleanOperations - Boolean flag which controls whether server-side batched operations are enabled. Defaults to
true
. - enable
Express 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- enable
Partitioning 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- forward
Dead stringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- forward
To string - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- lock
Duration 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
). - max
Delivery numberCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - max
Message numberSize In Kilobytes - 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 numberIn Megabytes - 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.
- requires
Duplicate booleanDetection - Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to
false
. - requires
Session 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 thatRestoring
is not accepted. Defaults toActive
.
- 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_ stron_ idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- dead_
lettering_ boolon_ message_ expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - default_
message_ strttl - 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_ strhistory_ time_ window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - enable_
batched_ booloperations - 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- forward_
dead_ strlettered_ messages_ to - 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_ intcount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - max_
message_ intsize_ in_ kilobytes - 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_ intin_ megabytes - 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_ booldetection - 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 thatRestoring
is not accepted. Defaults toActive
.
- namespace
Id String - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- auto
Delete StringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- dead
Lettering BooleanOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - default
Message StringTtl - 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 StringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - enable
Batched BooleanOperations - Boolean flag which controls whether server-side batched operations are enabled. Defaults to
true
. - enable
Express 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- enable
Partitioning 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- forward
Dead StringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- forward
To String - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- lock
Duration 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
). - max
Delivery NumberCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - max
Message NumberSize In Kilobytes - 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 NumberIn Megabytes - 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.
- requires
Duplicate BooleanDetection - Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to
false
. - requires
Session 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 thatRestoring
is not accepted. Defaults toActive
.
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.
- Namespace
Name string - Resource
Group stringName
- Id string
- The provider-assigned unique ID for this managed resource.
- Namespace
Name string - Resource
Group stringName
- id String
- The provider-assigned unique ID for this managed resource.
- namespace
Name String - resource
Group StringName
- id string
- The provider-assigned unique ID for this managed resource.
- namespace
Name string - resource
Group stringName
- id str
- The provider-assigned unique ID for this managed resource.
- namespace_
name str - resource_
group_ strname
- id String
- The provider-assigned unique ID for this managed resource.
- namespace
Name String - resource
Group StringName
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.
- Auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- Dead
Lettering boolOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - Default
Message stringTtl - 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 stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - Enable
Batched boolOperations - 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- Forward
Dead stringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- Forward
To string - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- Lock
Duration 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
). - Max
Delivery intCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - Max
Message intSize In Kilobytes - 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 intIn Megabytes - 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.
- Namespace
Id string - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- Namespace
Name string - Requires
Duplicate boolDetection - 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 stringName - Status string
- The status of the Queue. Possible values are
Active
,Creating
,Deleting
,Disabled
,ReceiveDisabled
,Renaming
,SendDisabled
,Unknown
. Note thatRestoring
is not accepted. Defaults toActive
.
- Auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- Dead
Lettering boolOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - Default
Message stringTtl - 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 stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - Enable
Batched boolOperations - 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- Forward
Dead stringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- Forward
To string - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- Lock
Duration 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
). - Max
Delivery intCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - Max
Message intSize In Kilobytes - 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 intIn Megabytes - 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.
- Namespace
Id string - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- Namespace
Name string - Requires
Duplicate boolDetection - 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 stringName - Status string
- The status of the Queue. Possible values are
Active
,Creating
,Deleting
,Disabled
,ReceiveDisabled
,Renaming
,SendDisabled
,Unknown
. Note thatRestoring
is not accepted. Defaults toActive
.
- auto
Delete StringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- dead
Lettering BooleanOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - default
Message StringTtl - 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 StringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - enable
Batched BooleanOperations - Boolean flag which controls whether server-side batched operations are enabled. Defaults to
true
. - enable
Express 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- enable
Partitioning 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- forward
Dead StringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- forward
To String - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- lock
Duration 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
). - max
Delivery IntegerCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - max
Message IntegerSize In Kilobytes - 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 IntegerIn Megabytes - 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.
- namespace
Id String - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- namespace
Name String - requires
Duplicate BooleanDetection - Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to
false
. - requires
Session 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
. - resource
Group StringName - status String
- The status of the Queue. Possible values are
Active
,Creating
,Deleting
,Disabled
,ReceiveDisabled
,Renaming
,SendDisabled
,Unknown
. Note thatRestoring
is not accepted. Defaults toActive
.
- auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- dead
Lettering booleanOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - default
Message stringTtl - 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 stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - enable
Batched booleanOperations - Boolean flag which controls whether server-side batched operations are enabled. Defaults to
true
. - enable
Express 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- enable
Partitioning 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- forward
Dead stringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- forward
To string - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- lock
Duration 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
). - max
Delivery numberCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - max
Message numberSize In Kilobytes - 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 numberIn Megabytes - 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.
- namespace
Id string - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- namespace
Name string - requires
Duplicate booleanDetection - Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to
false
. - requires
Session 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
. - resource
Group stringName - status string
- The status of the Queue. Possible values are
Active
,Creating
,Deleting
,Disabled
,ReceiveDisabled
,Renaming
,SendDisabled
,Unknown
. Note thatRestoring
is not accepted. Defaults toActive
.
- auto_
delete_ stron_ idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- dead_
lettering_ boolon_ message_ expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - default_
message_ strttl - 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_ strhistory_ time_ window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - enable_
batched_ booloperations - 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- forward_
dead_ strlettered_ messages_ to - 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_ intcount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - max_
message_ intsize_ in_ kilobytes - 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_ intin_ megabytes - 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_ booldetection - 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_ strname - status str
- The status of the Queue. Possible values are
Active
,Creating
,Deleting
,Disabled
,ReceiveDisabled
,Renaming
,SendDisabled
,Unknown
. Note thatRestoring
is not accepted. Defaults toActive
.
- auto
Delete StringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.
- dead
Lettering BooleanOn Message Expiration - Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to
false
. - default
Message StringTtl - 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 StringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (
PT10M
). - enable
Batched BooleanOperations - Boolean flag which controls whether server-side batched operations are enabled. Defaults to
true
. - enable
Express 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 tofalse
.NOTE: Service Bus Premium namespaces do not support Express Entities, so
enable_express
MUST be set tofalse
.- enable
Partitioning 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. For premium namespace, partitioning is available at namespace creation, and all queues and topics in the partitioned namespace will be partitioned, for the premium namespace that has
premium_messaging_partitions
sets to1
, the namespace is not partitioned.- forward
Dead StringLettered Messages To - The name of a Queue or Topic to automatically forward dead lettered messages to.
- forward
To String - The name of a Queue or Topic to automatically forward messages to. Please see the documentation for more information.
- lock
Duration 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
). - max
Delivery NumberCount - Integer value which controls when a message is automatically dead lettered. Defaults to
10
. - max
Message NumberSize In Kilobytes - 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 NumberIn Megabytes - 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.
- namespace
Id String - The ID of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.
- namespace
Name String - requires
Duplicate BooleanDetection - Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to
false
. - requires
Session 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
. - resource
Group StringName - status String
- The status of the Queue. Possible values are
Active
,Creating
,Deleting
,Disabled
,ReceiveDisabled
,Renaming
,SendDisabled
,Unknown
. Note thatRestoring
is not accepted. Defaults toActive
.
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.