Microsoft.ServiceBus namespaces 2015-08-01
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@2015-08-01' = {
location: 'string'
name: 'string'
properties: {
createACSNamespace: bool
enabled: bool
status: 'string'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.ServiceBus/namespaces
| Name | Description | Value |
|---|---|---|
| location | Namespace location. | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the namespace. | NamespaceProperties |
| sku | SKU of the namespace. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
NamespaceCreateOrUpdateParametersTags
| Name | Description | Value |
|---|
NamespaceProperties
| Name | Description | Value |
|---|---|---|
| createACSNamespace | Indicates whether to create an ACS namespace. | bool |
| enabled | Specifies whether this instance is enabled. | bool |
| status | State of the namespace. | 'Activating' 'Active' 'Created' 'Creating' 'Disabled' 'Disabling' 'Enabling' 'Failed' 'Removed' 'Removing' 'SoftDeleted' 'SoftDeleting' 'Unknown' |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | The specified messaging units for the tier. | int |
| name | Name of this SKU. | 'Basic' 'Premium' 'Standard' |
| tier | The billing tier of this particular SKU. | 'Basic' 'Premium' 'Standard' (required) |
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": "2015-08-01",
"name": "string",
"location": "string",
"properties": {
"createACSNamespace": "bool",
"enabled": "bool",
"status": "string"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.ServiceBus/namespaces
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2015-08-01' |
| location | Namespace location. | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the namespace. | NamespaceProperties |
| sku | SKU of the namespace. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.ServiceBus/namespaces' |
NamespaceCreateOrUpdateParametersTags
| Name | Description | Value |
|---|
NamespaceProperties
| Name | Description | Value |
|---|---|---|
| createACSNamespace | Indicates whether to create an ACS namespace. | bool |
| enabled | Specifies whether this instance is enabled. | bool |
| status | State of the namespace. | 'Activating' 'Active' 'Created' 'Creating' 'Disabled' 'Disabling' 'Enabling' 'Failed' 'Removed' 'Removing' 'SoftDeleted' 'SoftDeleting' 'Unknown' |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | The specified messaging units for the tier. | int |
| name | Name of this SKU. | 'Basic' 'Premium' 'Standard' |
| tier | The billing tier of this particular SKU. | 'Basic' 'Premium' 'Standard' (required) |
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@2015-08-01"
name = "string"
location = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
createACSNamespace = bool
enabled = bool
status = "string"
}
})
}
Property Values
Microsoft.ServiceBus/namespaces
| Name | Description | Value |
|---|---|---|
| location | Namespace location. | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the namespace. | NamespaceProperties |
| sku | SKU of the namespace. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.ServiceBus/namespaces@2015-08-01" |
NamespaceCreateOrUpdateParametersTags
| Name | Description | Value |
|---|
NamespaceProperties
| Name | Description | Value |
|---|---|---|
| createACSNamespace | Indicates whether to create an ACS namespace. | bool |
| enabled | Specifies whether this instance is enabled. | bool |
| status | State of the namespace. | 'Activating' 'Active' 'Created' 'Creating' 'Disabled' 'Disabling' 'Enabling' 'Failed' 'Removed' 'Removing' 'SoftDeleted' 'SoftDeleting' 'Unknown' |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | The specified messaging units for the tier. | int |
| name | Name of this SKU. | 'Basic' 'Premium' 'Standard' |
| tier | The billing tier of this particular SKU. | 'Basic' 'Premium' 'Standard' (required) |
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 |