Microsoft.ServiceBus namespaces 2018-01-01-preview

Bicep resource definition

The namespaces 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 resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ServiceBus/namespaces@2018-01-01-preview' = {
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'SystemAssigned'
  }
  location: 'string'
  name: 'string'
  properties: {
    encryption: {
      keySource: 'Microsoft.KeyVault'
      keyVaultProperties: {
        keyName: 'string'
        keyVaultUri: 'string'
      }
    }
    zoneRedundant: bool
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Encryption

Name Description Value
keySource Enumerates the possible value of keySource for Encryption 'Microsoft.KeyVault'
keyVaultProperties Properties of KeyVault KeyVaultProperties

Identity

Name Description Value
principalId ObjectId from the KeyVault string
tenantId TenantId from the KeyVault string
type Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' 'SystemAssigned'

KeyVaultProperties

Name Description Value
keyName Name of the Key from KeyVault string
keyVaultUri Uri of KeyVault string

Microsoft.ServiceBus/namespaces

Name Description Value
identity Properties of BYOK Identity description Identity
location The Geo-location where the resource lives string (required)
name The resource name string (required)
properties Properties of the namespace. SBNamespaceProperties
sku Properties of SKU SBSku
tags Resource tags Dictionary of tag names and values. See Tags in templates

SBNamespaceProperties

Name Description Value
encryption Properties of BYOK Encryption description Encryption
zoneRedundant Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. bool

SBSku

Name Description Value
capacity The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. int
name Name of this SKU. 'Basic'
'Premium'
'Standard' (required)
tier The billing tier of this particular SKU. 'Basic'
'Premium'
'Standard'

TrackedResourceTags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Create a Service Bus namespace and queue This template enables you to deploy a Service Bus Standard namespace and a queue.
Create a Service Bus namespace Virtual Network rule This template enables you to deploy a Service Bus Premium namespace with Virtual Network rule
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.
Creates a Dapr microservices app using Container Apps Create a Dapr microservices app using Container Apps.
Creates a Dapr pub-sub servicebus app using Container Apps Create a Dapr pub-sub servicebus app using Container Apps.

ARM template resource definition

The namespaces 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 resource, add the following JSON to your template.

{
  "type": "Microsoft.ServiceBus/namespaces",
  "apiVersion": "2018-01-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "SystemAssigned"
  },
  "location": "string",
  "properties": {
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": {
        "keyName": "string",
        "keyVaultUri": "string"
      }
    },
    "zoneRedundant": "bool"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Encryption

Name Description Value
keySource Enumerates the possible value of keySource for Encryption 'Microsoft.KeyVault'
keyVaultProperties Properties of KeyVault KeyVaultProperties

Identity

Name Description Value
principalId ObjectId from the KeyVault string
tenantId TenantId from the KeyVault string
type Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' 'SystemAssigned'

KeyVaultProperties

Name Description Value
keyName Name of the Key from KeyVault string
keyVaultUri Uri of KeyVault string

Microsoft.ServiceBus/namespaces

Name Description Value
apiVersion The api version '2018-01-01-preview'
identity Properties of BYOK Identity description Identity
location The Geo-location where the resource lives string (required)
name The resource name string (required)
properties Properties of the namespace. SBNamespaceProperties
sku Properties of SKU SBSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ServiceBus/namespaces'

SBNamespaceProperties

Name Description Value
encryption Properties of BYOK Encryption description Encryption
zoneRedundant Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. bool

SBSku

Name Description Value
capacity The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. int
name Name of this SKU. 'Basic'
'Premium'
'Standard' (required)
tier The billing tier of this particular SKU. 'Basic'
'Premium'
'Standard'

TrackedResourceTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Connect to a Service Bus namespace via private endpoint

Deploy to Azure
This sample shows how to use configure a virtual network and private DNS zone to access a Service Bus namespace via private endpoint.
Correlating messages over Logic Apps using Service Bus

Deploy to Azure
which shows how we can correlate messages over Logic Apps using Azure Service Bus
Create a Service Bus Geo-recovery

Deploy to Azure
This template allows you to configure Service Bus Geo-disaster recovery alias on premium SKU Namespaces.
Create a Service Bus namespace

Deploy to Azure
This template enables you to deploy a Service Bus namespace with a Basic/Standard SKU.
Create a Service Bus namespace and queue

Deploy to Azure
This template enables you to deploy a Service Bus Standard namespace and a queue.
Create a Service Bus namespace and queue authorization rule

Deploy to Azure
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 Topic

Deploy to Azure
This template creates a Service Bus Namespace and Topic.
Create a Service Bus namespace IP Filter rule

Deploy to Azure
This template enables you to deploy a Service Bus Premium namespace with IP Filter rule
Create a Service Bus namespace Virtual Network rule

Deploy to Azure
This template enables you to deploy a Service Bus Premium namespace with Virtual Network rule
Create a Service Bus namespace, topic, and subscription

Deploy to Azure
This template enables you to deploy a Service Bus Standard namespace, a topic, and a subscription.
Create a Service Bus namespace, topic, subscription and Rule

Deploy to Azure
This template enables you to deploy a Service Bus Standard namespace, a topic, a subscription and a rule.
Create a Service Bus Premium Namespace and AuthorizationRule

Deploy to Azure
This template creates a Service Bus Premium Namespace and a namespace AuthorizationRule
Create a Service Bus Topic with Subscription and SQL Filter

Deploy to Azure
This template creates a Service Bus Namespace and Topic with a Subscription using a SQL Filter expression to recieve only the messages that match the defined SQL Filter Expression.
Create Azure Event Grid Custom Topic and Queue Subscription

Deploy to Azure
Creates an Azure Event Grid custom topic and a service bus queue subscription. Template originally authored by Markus Meyer.
Create Azure Event Grid Custom Topic Subscription

Deploy to Azure
Creates an Azure Event Grid custom topic and a service bus topic subscription. Template originally authored by Markus Meyer.
Creates a Dapr microservices app using Container Apps

Deploy to Azure
Create a Dapr microservices app using Container Apps.
Creates a Dapr pub-sub servicebus app using Container Apps

Deploy to Azure
Create a Dapr pub-sub servicebus app using Container Apps.
EPiserverCMS in Azure

Deploy to Azure
This template allows you to create resources required for EpiServerCMS deployment in Azure
Integration Patterns - Message Router - Service Bus

Deploy to Azure
Solution which shows how we can set up the Message Router pattern using a Service Bus Topic

Terraform (AzAPI provider) resource definition

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

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ServiceBus/namespaces resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2018-01-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "SystemAssigned"
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      encryption = {
        keySource = "Microsoft.KeyVault"
        keyVaultProperties = {
          keyName = "string"
          keyVaultUri = "string"
        }
      }
      zoneRedundant = bool
    }
  })
}

Property values

Encryption

Name Description Value
keySource Enumerates the possible value of keySource for Encryption 'Microsoft.KeyVault'
keyVaultProperties Properties of KeyVault KeyVaultProperties

Identity

Name Description Value
principalId ObjectId from the KeyVault string
tenantId TenantId from the KeyVault string
type Enumerates the possible value Identity type, which currently supports only 'SystemAssigned' 'SystemAssigned'

KeyVaultProperties

Name Description Value
keyName Name of the Key from KeyVault string
keyVaultUri Uri of KeyVault string

Microsoft.ServiceBus/namespaces

Name Description Value
identity Properties of BYOK Identity description Identity
location The Geo-location where the resource lives string (required)
name The resource name string (required)
properties Properties of the namespace. SBNamespaceProperties
sku Properties of SKU SBSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ServiceBus/namespaces@2018-01-01-preview"

SBNamespaceProperties

Name Description Value
encryption Properties of BYOK Encryption description Encryption
zoneRedundant Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. bool

SBSku

Name Description Value
capacity The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4. int
name Name of this SKU. 'Basic'
'Premium'
'Standard' (required)
tier The billing tier of this particular SKU. 'Basic'
'Premium'
'Standard'

TrackedResourceTags

Name Description Value