azure-native.servicebus.Queue

Explore with Pulumi AI

Description of queue Resource. API Version: 2017-04-01.

Example Usage

QueueCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var queue = new AzureNative.ServiceBus.Queue("queue", new()
    {
        EnablePartitioning = true,
        NamespaceName = "sdk-Namespace-3174",
        QueueName = "sdk-Queues-5647",
        ResourceGroupName = "ArunMonocle",
    });

});
package main

import (
	servicebus "github.com/pulumi/pulumi-azure-native-sdk/servicebus"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicebus.NewQueue(ctx, "queue", &servicebus.QueueArgs{
			EnablePartitioning: pulumi.Bool(true),
			NamespaceName:      pulumi.String("sdk-Namespace-3174"),
			QueueName:          pulumi.String("sdk-Queues-5647"),
			ResourceGroupName:  pulumi.String("ArunMonocle"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.servicebus.Queue;
import com.pulumi.azurenative.servicebus.QueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var queue = new Queue("queue", QueueArgs.builder()        
            .enablePartitioning(true)
            .namespaceName("sdk-Namespace-3174")
            .queueName("sdk-Queues-5647")
            .resourceGroupName("ArunMonocle")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

queue = azure_native.servicebus.Queue("queue",
    enable_partitioning=True,
    namespace_name="sdk-Namespace-3174",
    queue_name="sdk-Queues-5647",
    resource_group_name="ArunMonocle")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const queue = new azure_native.servicebus.Queue("queue", {
    enablePartitioning: true,
    namespaceName: "sdk-Namespace-3174",
    queueName: "sdk-Queues-5647",
    resourceGroupName: "ArunMonocle",
});
resources:
  queue:
    type: azure-native:servicebus:Queue
    properties:
      enablePartitioning: true
      namespaceName: sdk-Namespace-3174
      queueName: sdk-Queues-5647
      resourceGroupName: ArunMonocle

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_time_to_live: 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_size_in_megabytes: Optional[int] = None,
          namespace_name: Optional[str] = None,
          queue_name: Optional[str] = None,
          requires_duplicate_detection: Optional[bool] = None,
          requires_session: Optional[bool] = None,
          resource_group_name: Optional[str] = None,
          status: Optional[EntityStatus] = 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-native: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:

NamespaceName string

The namespace name

ResourceGroupName string

Name of the Resource group within the Azure subscription.

AutoDeleteOnIdle string

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

DeadLetteringOnMessageExpiration bool

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

DefaultMessageTimeToLive string

ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

DuplicateDetectionHistoryTimeWindow string

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

EnableBatchedOperations bool

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

EnableExpress bool

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

EnablePartitioning bool

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

ForwardDeadLetteredMessagesTo string

Queue/Topic name to forward the Dead Letter message

ForwardTo string

Queue/Topic name to forward the messages

LockDuration string

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

MaxDeliveryCount int

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

MaxSizeInMegabytes int

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

QueueName string

The queue name.

RequiresDuplicateDetection bool

A value indicating if this queue requires duplicate detection.

RequiresSession bool

A value that indicates whether the queue supports the concept of sessions.

Status Pulumi.AzureNative.ServiceBus.EntityStatus

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

NamespaceName string

The namespace name

ResourceGroupName string

Name of the Resource group within the Azure subscription.

AutoDeleteOnIdle string

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

DeadLetteringOnMessageExpiration bool

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

DefaultMessageTimeToLive string

ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

DuplicateDetectionHistoryTimeWindow string

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

EnableBatchedOperations bool

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

EnableExpress bool

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

EnablePartitioning bool

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

ForwardDeadLetteredMessagesTo string

Queue/Topic name to forward the Dead Letter message

ForwardTo string

Queue/Topic name to forward the messages

LockDuration string

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

MaxDeliveryCount int

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

MaxSizeInMegabytes int

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

QueueName string

The queue name.

RequiresDuplicateDetection bool

A value indicating if this queue requires duplicate detection.

RequiresSession bool

A value that indicates whether the queue supports the concept of sessions.

Status EntityStatus

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

namespaceName String

The namespace name

resourceGroupName String

Name of the Resource group within the Azure subscription.

autoDeleteOnIdle String

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

deadLetteringOnMessageExpiration Boolean

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

defaultMessageTimeToLive String

ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

duplicateDetectionHistoryTimeWindow String

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

enableBatchedOperations Boolean

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

enableExpress Boolean

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

enablePartitioning Boolean

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

forwardDeadLetteredMessagesTo String

Queue/Topic name to forward the Dead Letter message

forwardTo String

Queue/Topic name to forward the messages

lockDuration String

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

maxDeliveryCount Integer

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

maxSizeInMegabytes Integer

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

queueName String

The queue name.

requiresDuplicateDetection Boolean

A value indicating if this queue requires duplicate detection.

requiresSession Boolean

A value that indicates whether the queue supports the concept of sessions.

status EntityStatus

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

namespaceName string

The namespace name

resourceGroupName string

Name of the Resource group within the Azure subscription.

autoDeleteOnIdle string

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

deadLetteringOnMessageExpiration boolean

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

defaultMessageTimeToLive string

ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

duplicateDetectionHistoryTimeWindow string

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

enableBatchedOperations boolean

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

enableExpress boolean

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

enablePartitioning boolean

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

forwardDeadLetteredMessagesTo string

Queue/Topic name to forward the Dead Letter message

forwardTo string

Queue/Topic name to forward the messages

lockDuration string

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

maxDeliveryCount number

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

maxSizeInMegabytes number

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

queueName string

The queue name.

requiresDuplicateDetection boolean

A value indicating if this queue requires duplicate detection.

requiresSession boolean

A value that indicates whether the queue supports the concept of sessions.

status EntityStatus

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

namespace_name str

The namespace name

resource_group_name str

Name of the Resource group within the Azure subscription.

auto_delete_on_idle str

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

dead_lettering_on_message_expiration bool

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

default_message_time_to_live str

ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

duplicate_detection_history_time_window str

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

enable_batched_operations bool

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

enable_express bool

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

enable_partitioning bool

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

forward_dead_lettered_messages_to str

Queue/Topic name to forward the Dead Letter message

forward_to str

Queue/Topic name to forward the messages

lock_duration str

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

max_delivery_count int

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

max_size_in_megabytes int

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

queue_name str

The queue name.

requires_duplicate_detection bool

A value indicating if this queue requires duplicate detection.

requires_session bool

A value that indicates whether the queue supports the concept of sessions.

status EntityStatus

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

namespaceName String

The namespace name

resourceGroupName String

Name of the Resource group within the Azure subscription.

autoDeleteOnIdle String

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

deadLetteringOnMessageExpiration Boolean

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

defaultMessageTimeToLive String

ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

duplicateDetectionHistoryTimeWindow String

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

enableBatchedOperations Boolean

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

enableExpress Boolean

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

enablePartitioning Boolean

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

forwardDeadLetteredMessagesTo String

Queue/Topic name to forward the Dead Letter message

forwardTo String

Queue/Topic name to forward the messages

lockDuration String

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

maxDeliveryCount Number

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

maxSizeInMegabytes Number

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

queueName String

The queue name.

requiresDuplicateDetection Boolean

A value indicating if this queue requires duplicate detection.

requiresSession Boolean

A value that indicates whether the queue supports the concept of sessions.

status "Active" | "Disabled" | "Restoring" | "SendDisabled" | "ReceiveDisabled" | "Creating" | "Deleting" | "Renaming" | "Unknown"

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

Outputs

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

AccessedAt string

Last time a message was sent, or the last time there was a receive request to this queue.

CountDetails Pulumi.AzureNative.ServiceBus.Outputs.MessageCountDetailsResponse

Message Count Details.

CreatedAt string

The exact time the message was created.

Id string

The provider-assigned unique ID for this managed resource.

MessageCount double

The number of messages in the queue.

Name string

Resource name

SizeInBytes double

The size of the queue, in bytes.

Type string

Resource type

UpdatedAt string

The exact time the message was updated.

AccessedAt string

Last time a message was sent, or the last time there was a receive request to this queue.

CountDetails MessageCountDetailsResponse

Message Count Details.

CreatedAt string

The exact time the message was created.

Id string

The provider-assigned unique ID for this managed resource.

MessageCount float64

The number of messages in the queue.

Name string

Resource name

SizeInBytes float64

The size of the queue, in bytes.

Type string

Resource type

UpdatedAt string

The exact time the message was updated.

accessedAt String

Last time a message was sent, or the last time there was a receive request to this queue.

countDetails MessageCountDetailsResponse

Message Count Details.

createdAt String

The exact time the message was created.

id String

The provider-assigned unique ID for this managed resource.

messageCount Double

The number of messages in the queue.

name String

Resource name

sizeInBytes Double

The size of the queue, in bytes.

type String

Resource type

updatedAt String

The exact time the message was updated.

accessedAt string

Last time a message was sent, or the last time there was a receive request to this queue.

countDetails MessageCountDetailsResponse

Message Count Details.

createdAt string

The exact time the message was created.

id string

The provider-assigned unique ID for this managed resource.

messageCount number

The number of messages in the queue.

name string

Resource name

sizeInBytes number

The size of the queue, in bytes.

type string

Resource type

updatedAt string

The exact time the message was updated.

accessed_at str

Last time a message was sent, or the last time there was a receive request to this queue.

count_details MessageCountDetailsResponse

Message Count Details.

created_at str

The exact time the message was created.

id str

The provider-assigned unique ID for this managed resource.

message_count float

The number of messages in the queue.

name str

Resource name

size_in_bytes float

The size of the queue, in bytes.

type str

Resource type

updated_at str

The exact time the message was updated.

accessedAt String

Last time a message was sent, or the last time there was a receive request to this queue.

countDetails Property Map

Message Count Details.

createdAt String

The exact time the message was created.

id String

The provider-assigned unique ID for this managed resource.

messageCount Number

The number of messages in the queue.

name String

Resource name

sizeInBytes Number

The size of the queue, in bytes.

type String

Resource type

updatedAt String

The exact time the message was updated.

Supporting Types

EntityStatus

Active
Active
Disabled
Disabled
Restoring
Restoring
SendDisabled
SendDisabled
ReceiveDisabled
ReceiveDisabled
Creating
Creating
Deleting
Deleting
Renaming
Renaming
Unknown
Unknown
EntityStatusActive
Active
EntityStatusDisabled
Disabled
EntityStatusRestoring
Restoring
EntityStatusSendDisabled
SendDisabled
EntityStatusReceiveDisabled
ReceiveDisabled
EntityStatusCreating
Creating
EntityStatusDeleting
Deleting
EntityStatusRenaming
Renaming
EntityStatusUnknown
Unknown
Active
Active
Disabled
Disabled
Restoring
Restoring
SendDisabled
SendDisabled
ReceiveDisabled
ReceiveDisabled
Creating
Creating
Deleting
Deleting
Renaming
Renaming
Unknown
Unknown
Active
Active
Disabled
Disabled
Restoring
Restoring
SendDisabled
SendDisabled
ReceiveDisabled
ReceiveDisabled
Creating
Creating
Deleting
Deleting
Renaming
Renaming
Unknown
Unknown
ACTIVE
Active
DISABLED
Disabled
RESTORING
Restoring
SEND_DISABLED
SendDisabled
RECEIVE_DISABLED
ReceiveDisabled
CREATING
Creating
DELETING
Deleting
RENAMING
Renaming
UNKNOWN
Unknown
"Active"
Active
"Disabled"
Disabled
"Restoring"
Restoring
"SendDisabled"
SendDisabled
"ReceiveDisabled"
ReceiveDisabled
"Creating"
Creating
"Deleting"
Deleting
"Renaming"
Renaming
"Unknown"
Unknown

MessageCountDetailsResponse

ActiveMessageCount double

Number of active messages in the queue, topic, or subscription.

DeadLetterMessageCount double

Number of messages that are dead lettered.

ScheduledMessageCount double

Number of scheduled messages.

TransferDeadLetterMessageCount double

Number of messages transferred into dead letters.

TransferMessageCount double

Number of messages transferred to another queue, topic, or subscription.

ActiveMessageCount float64

Number of active messages in the queue, topic, or subscription.

DeadLetterMessageCount float64

Number of messages that are dead lettered.

ScheduledMessageCount float64

Number of scheduled messages.

TransferDeadLetterMessageCount float64

Number of messages transferred into dead letters.

TransferMessageCount float64

Number of messages transferred to another queue, topic, or subscription.

activeMessageCount Double

Number of active messages in the queue, topic, or subscription.

deadLetterMessageCount Double

Number of messages that are dead lettered.

scheduledMessageCount Double

Number of scheduled messages.

transferDeadLetterMessageCount Double

Number of messages transferred into dead letters.

transferMessageCount Double

Number of messages transferred to another queue, topic, or subscription.

activeMessageCount number

Number of active messages in the queue, topic, or subscription.

deadLetterMessageCount number

Number of messages that are dead lettered.

scheduledMessageCount number

Number of scheduled messages.

transferDeadLetterMessageCount number

Number of messages transferred into dead letters.

transferMessageCount number

Number of messages transferred to another queue, topic, or subscription.

active_message_count float

Number of active messages in the queue, topic, or subscription.

dead_letter_message_count float

Number of messages that are dead lettered.

scheduled_message_count float

Number of scheduled messages.

transfer_dead_letter_message_count float

Number of messages transferred into dead letters.

transfer_message_count float

Number of messages transferred to another queue, topic, or subscription.

activeMessageCount Number

Number of active messages in the queue, topic, or subscription.

deadLetterMessageCount Number

Number of messages that are dead lettered.

scheduledMessageCount Number

Number of scheduled messages.

transferDeadLetterMessageCount Number

Number of messages transferred into dead letters.

transferMessageCount Number

Number of messages transferred to another queue, topic, or subscription.

Import

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

$ pulumi import azure-native:servicebus:Queue sdk-Queues-5647 /subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647 

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0