azurerm_servicebus_queue

Create and manage a ServiceBus Queue.

Example Usage

variable "location" {
  description = "Azure datacenter to deploy to."
  default = "West US"
}

variable "servicebus_name" {
  description = "Input your unique Azure service bus name"
}

resource "azurerm_resource_group" "test" {
  name     = "terraform-servicebus"
  location = "${var.location}"
}

resource "azurerm_servicebus_namespace" "test" {
  name                = "${var.servicebus_name}"
  location            = "${var.location}"
  resource_group_name = "${azurerm_resource_group.test.name}"
  sku                 = "standard"

  tags {
    source = "terraform"
  }
}

resource "azurerm_servicebus_queue" "test" {
  name                = "testQueue"
  resource_group_name = "${azurerm_resource_group.test.name}"
  namespace_name      = "${azurerm_servicebus_namespace.test.name}"

  enable_partitioning = true
}

Argument Reference

The following arguments are supported:

• name - (Required) Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

• namespace_name - (Required) The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

• location - (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

• resource_group_name - (Required) The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

• auto_delete_on_idle - (Optional) The idle interval after which the Queue is automatically deleted, minimum of 5 minutes. Provided in the TimeSpan format.

• default_message_ttl - (Optional) The TTL of messages sent to this queue. This is the default value used when TTL is not set on message itself. Provided in the TimeSpan format.

• duplicate_detection_history_time_window - (Optional) The duration during which duplicates can be detected. Default value is 10 minutes. Provided in the TimeSpan format.

• enable_express - (Optional) 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 - (Optional) 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. For Premium, it MUST be set to true.

NOTE: Service Bus Premium namespaces are always partitioned, so enable_partitioning MUST be set to true.

• lock_duration - (Optional) 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_size_in_megabytes - (Optional) Integer value which controls the size of memory allocated for the queue. For supported values see the "Queue/topic size" section of this document.

• requires_duplicate_detection - (Optional) Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.

• requires_session - (Optional) 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.

• dead_lettering_on_message_expiration - (Optional) Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.

TimeSpan Format

Some arguments for this resource are required in the TimeSpan format which is used to represent a length of time. The supported format is documented here

Attributes Reference

The following attributes are exported:

• id - The ServiceBus Queue ID.

Import

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

terraform import azurerm_servicebus_queue.test /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/microsoft.servicebus/namespaces/sbns1/queues/snqueue1