Microsoft.ServiceBus namespaces/queues

Bicep resource definition

The namespaces/queues resource type can be deployed with operations that target:

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@2025-05-01-preview' = {
  parent: resourceSymbolicName
  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'
    userMetadata: 'string'
  }
}

Property Values

Microsoft.ServiceBus/namespaces/queues

SBQueueProperties

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

The namespaces/queues resource type can be deployed with operations that target:

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": "2025-05-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",
    "userMetadata": "string"
  }
}

Property Values

Microsoft.ServiceBus/namespaces/queues

SBQueueProperties

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Create a Service Bus namespace and queue	This template enables you to deploy a Service Bus Standard namespace and a queue.
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.

Terraform (AzAPI provider) resource definition

The namespaces/queues resource type can be deployed with operations that target:

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@2025-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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"
      userMetadata = "string"
    }
  }
}

Property Values

Microsoft.ServiceBus/namespaces/queues

SBQueueProperties

Usage Examples

Terraform Samples

A basic example of deploying ServiceBus Queue.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "namespace" {
  type      = "Microsoft.ServiceBus/namespaces@2022-01-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      disableLocalAuth    = false
      publicNetworkAccess = "Enabled"
      zoneRedundant       = false
    }
    sku = {
      capacity = 0
      name     = "Standard"
      tier     = "Standard"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "queue" {
  type      = "Microsoft.ServiceBus/namespaces/queues@2021-06-01-preview"
  parent_id = azapi_resource.namespace.id
  name      = var.resource_name
  body = {
    properties = {
      deadLetteringOnMessageExpiration = false
      enableBatchedOperations          = true
      enableExpress                    = false
      enablePartitioning               = true
      maxDeliveryCount                 = 10
      maxSizeInMegabytes               = 81920
      requiresDuplicateDetection       = false
      requiresSession                  = false
      status                           = "Active"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}