Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The namespaces resource type can be deployed with operations that target:
- 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 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 |
---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
Module | Description |
---|---|
Service Bus Namespace | AVM Resource Module for Service Bus Namespace |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying 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:
- 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 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 |
---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
Template | Description |
---|---|
Connect to a Service Bus namespace via private endpoint |
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 |
which shows how we can correlate messages over Logic Apps using Azure Service Bus |
Create a Service Bus Geo-recovery |
This template allows you to configure Service Bus Geo-disaster recovery alias on premium SKU Namespaces. |
Create a Service Bus namespace |
This template enables you to deploy a Service Bus namespace with a Basic/Standard SKU. |
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 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 Topic |
This template creates a Service Bus Namespace and Topic. |
Create a Service Bus namespace IP Filter rule |
This template enables you to deploy a Service Bus Premium namespace with IP Filter rule |
Create a Service Bus namespace Virtual Network rule |
This template enables you to deploy a Service Bus Premium namespace with Virtual Network rule |
Create a Service Bus namespace, topic, and subscription |
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 |
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 |
This template creates a Service Bus Premium Namespace and a namespace AuthorizationRule |
Create a Service Bus Topic with Subscription and SQL Filter |
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 |
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 |
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 |
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. |
EPiserverCMS in Azure |
This template allows you to create resources required for EpiServerCMS deployment in Azure |
Integration Patterns - Message Router - Service Bus |
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"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
encryption = {
keySource = "Microsoft.KeyVault"
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
}
}
zoneRedundant = bool
}
sku = {
capacity = int
name = "string"
tier = "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. |
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 |
---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
Module | Description |
---|---|
Service Bus Namespace | AVM Resource Module for Service Bus Namespace |