Microsoft.ServiceBus namespaces/queues 2021-06-01-preview
Bicep resource definition
The namespaces/queues resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ServiceBus/namespaces/queues resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2021-06-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
autoDeleteOnIdle: 'string'
deadLetteringOnMessageExpiration: bool
defaultMessageTimeToLive: 'string'
duplicateDetectionHistoryTimeWindow: 'string'
enableBatchedOperations: bool
enableExpress: bool
enablePartitioning: bool
forwardDeadLetteredMessagesTo: 'string'
forwardTo: 'string'
lockDuration: 'string'
maxDeliveryCount: int
maxMessageSizeInKilobytes: int
maxSizeInMegabytes: int
requiresDuplicateDetection: bool
requiresSession: bool
status: 'string'
}
}
Property values
namespaces/queues
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-260 Valid characters: Alphanumerics, periods, hyphens, underscores, and slashes. Start and end with alphanumeric. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: namespaces |
| properties | Queue Properties | SBQueueProperties |
SBQueueProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | string |
| deadLetteringOnMessageExpiration | A value that indicates whether this queue has dead letter support when a message expires. | bool |
| defaultMessageTimeToLive | 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. | string |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool |
| enableExpress | A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. | bool |
| enablePartitioning | A value that indicates whether the queue is to be partitioned across multiple message brokers. | bool |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string |
| forwardTo | Queue/Topic name to forward the messages | string |
| lockDuration | 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. | string |
| maxDeliveryCount | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. | int |
| maxMessageSizeInKilobytes | Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. | int |
| maxSizeInMegabytes | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. | int |
| requiresDuplicateDetection | A value indicating if this queue requires duplicate detection. | bool |
| requiresSession | A value that indicates whether the queue supports the concept of sessions. | bool |
| status | Enumerates the possible values for the status of a messaging entity. | 'Active' 'Creating' 'Deleting' 'Disabled' 'ReceiveDisabled' 'Renaming' 'Restoring' 'SendDisabled' 'Unknown' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create Azure Event Grid Custom Topic and Queue Subscription |
Creates an Azure Event Grid custom topic and a service bus queue subscription. Template originally authored by Markus Meyer. |
| Create a Service Bus namespace and queue authorization rule |
This template enables you to deploy a Service Bus Standard namespace, and authorization rules for both the namespace and a queue. |
| Create a Service Bus namespace and queue |
This template enables you to deploy a Service Bus Standard namespace and a queue. |
ARM template resource definition
The namespaces/queues resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ServiceBus/namespaces/queues resource, add the following JSON to your template.
{
"type": "Microsoft.ServiceBus/namespaces/queues",
"apiVersion": "2021-06-01-preview",
"name": "string",
"properties": {
"autoDeleteOnIdle": "string",
"deadLetteringOnMessageExpiration": "bool",
"defaultMessageTimeToLive": "string",
"duplicateDetectionHistoryTimeWindow": "string",
"enableBatchedOperations": "bool",
"enableExpress": "bool",
"enablePartitioning": "bool",
"forwardDeadLetteredMessagesTo": "string",
"forwardTo": "string",
"lockDuration": "string",
"maxDeliveryCount": "int",
"maxMessageSizeInKilobytes": "int",
"maxSizeInMegabytes": "int",
"requiresDuplicateDetection": "bool",
"requiresSession": "bool",
"status": "string"
}
}
Property values
namespaces/queues
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ServiceBus/namespaces/queues' |
| apiVersion | The resource api version | '2021-06-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-260 Valid characters: Alphanumerics, periods, hyphens, underscores, and slashes. Start and end with alphanumeric. |
| properties | Queue Properties | SBQueueProperties |
SBQueueProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | string |
| deadLetteringOnMessageExpiration | A value that indicates whether this queue has dead letter support when a message expires. | bool |
| defaultMessageTimeToLive | 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. | string |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool |
| enableExpress | A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. | bool |
| enablePartitioning | A value that indicates whether the queue is to be partitioned across multiple message brokers. | bool |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string |
| forwardTo | Queue/Topic name to forward the messages | string |
| lockDuration | 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. | string |
| maxDeliveryCount | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. | int |
| maxMessageSizeInKilobytes | Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. | int |
| maxSizeInMegabytes | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. | int |
| requiresDuplicateDetection | A value indicating if this queue requires duplicate detection. | bool |
| requiresSession | A value that indicates whether the queue supports the concept of sessions. | bool |
| status | Enumerates the possible values for the status of a messaging entity. | 'Active' 'Creating' 'Deleting' 'Disabled' 'ReceiveDisabled' 'Renaming' 'Restoring' 'SendDisabled' 'Unknown' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create Azure Event Grid Custom Topic and Queue Subscription |
Creates an Azure Event Grid custom topic and a service bus queue subscription. Template originally authored by Markus Meyer. |
| Create a Service Bus namespace and queue authorization rule |
This template enables you to deploy a Service Bus Standard namespace, and authorization rules for both the namespace and a queue. |
| Create a Service Bus namespace and queue |
This template enables you to deploy a Service Bus Standard namespace and a queue. |
Terraform (AzAPI provider) resource definition
The namespaces/queues resource type can be deployed to:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ServiceBus/namespaces/queues resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces/queues@2021-06-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
autoDeleteOnIdle = "string"
deadLetteringOnMessageExpiration = bool
defaultMessageTimeToLive = "string"
duplicateDetectionHistoryTimeWindow = "string"
enableBatchedOperations = bool
enableExpress = bool
enablePartitioning = bool
forwardDeadLetteredMessagesTo = "string"
forwardTo = "string"
lockDuration = "string"
maxDeliveryCount = int
maxMessageSizeInKilobytes = int
maxSizeInMegabytes = int
requiresDuplicateDetection = bool
requiresSession = bool
status = "string"
}
})
}
Property values
namespaces/queues
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ServiceBus/namespaces/queues@2021-06-01-preview" |
| name | The resource name | string (required) Character limit: 1-260 Valid characters: Alphanumerics, periods, hyphens, underscores, and slashes. Start and end with alphanumeric. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: namespaces |
| properties | Queue Properties | SBQueueProperties |
SBQueueProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. | string |
| deadLetteringOnMessageExpiration | A value that indicates whether this queue has dead letter support when a message expires. | bool |
| defaultMessageTimeToLive | 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. | string |
| duplicateDetectionHistoryTimeWindow | ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. | string |
| enableBatchedOperations | Value that indicates whether server-side batched operations are enabled. | bool |
| enableExpress | A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. | bool |
| enablePartitioning | A value that indicates whether the queue is to be partitioned across multiple message brokers. | bool |
| forwardDeadLetteredMessagesTo | Queue/Topic name to forward the Dead Letter message | string |
| forwardTo | Queue/Topic name to forward the messages | string |
| lockDuration | 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. | string |
| maxDeliveryCount | The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. | int |
| maxMessageSizeInKilobytes | Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024. | int |
| maxSizeInMegabytes | The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024. | int |
| requiresDuplicateDetection | A value indicating if this queue requires duplicate detection. | bool |
| requiresSession | A value that indicates whether the queue supports the concept of sessions. | bool |
| status | Enumerates the possible values for the status of a messaging entity. | "Active" "Creating" "Deleting" "Disabled" "ReceiveDisabled" "Renaming" "Restoring" "SendDisabled" "Unknown" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for