Microsoft.ServiceBus namespaces/topics 2015-08-01
Bicep resource definition
The namespaces/topics 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/topics resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ServiceBus/namespaces/topics@2015-08-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
autoDeleteOnIdle: 'string'
defaultMessageTimeToLive: 'string'
duplicateDetectionHistoryTimeWindow: 'string'
enableBatchedOperations: bool
enableExpress: bool
enablePartitioning: bool
entityAvailabilityStatus: 'string'
filteringMessagesBeforePublishing: bool
isAnonymousAccessible: bool
isExpress: bool
maxSizeInMegabytes: int
requiresDuplicateDetection: bool
status: 'string'
supportOrdering: bool
}
}
Property values
Microsoft.ServiceBus/namespaces/topics
| Name | Description | Value |
|---|---|---|
| location | Location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| 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 | The Topic Properties definition. | TopicProperties |
TopicProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteOnIdle | TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string |
| defaultMessageTimeToLive | Default message time 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 | 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 | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | bool |
| enablePartitioning | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | bool |
| entityAvailabilityStatus | Entity availability status for the topic. | 'Available' 'Limited' 'Renaming' 'Restoring' 'Unknown' |
| filteringMessagesBeforePublishing | Whether messages should be filtered before publishing. | bool |
| isAnonymousAccessible | Value that indicates whether the message is accessible anonymously. | bool |
| isExpress | bool | |
| maxSizeInMegabytes | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. | int |
| requiresDuplicateDetection | Value indicating if this topic requires duplicate detection. | bool |
| status | Enumerates the possible values for the status of a messaging entity. | 'Active' 'Creating' 'Deleting' 'Disabled' 'ReceiveDisabled' 'Renaming' 'Restoring' 'SendDisabled' 'Unknown' |
| supportOrdering | Value that indicates whether the topic supports ordering. | bool |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| 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/topics 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/topics resource, add the following JSON to your template.
{
"type": "Microsoft.ServiceBus/namespaces/topics",
"apiVersion": "2015-08-01",
"name": "string",
"location": "string",
"properties": {
"autoDeleteOnIdle": "string",
"defaultMessageTimeToLive": "string",
"duplicateDetectionHistoryTimeWindow": "string",
"enableBatchedOperations": "bool",
"enableExpress": "bool",
"enablePartitioning": "bool",
"entityAvailabilityStatus": "string",
"filteringMessagesBeforePublishing": "bool",
"isAnonymousAccessible": "bool",
"isExpress": "bool",
"maxSizeInMegabytes": "int",
"requiresDuplicateDetection": "bool",
"status": "string",
"supportOrdering": "bool"
}
}
Property values
Microsoft.ServiceBus/namespaces/topics
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2015-08-01' |
| location | Location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| properties | The Topic Properties definition. | TopicProperties |
| type | The resource type | 'Microsoft.ServiceBus/namespaces/topics' |
TopicProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteOnIdle | TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string |
| defaultMessageTimeToLive | Default message time 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 | 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 | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | bool |
| enablePartitioning | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | bool |
| entityAvailabilityStatus | Entity availability status for the topic. | 'Available' 'Limited' 'Renaming' 'Restoring' 'Unknown' |
| filteringMessagesBeforePublishing | Whether messages should be filtered before publishing. | bool |
| isAnonymousAccessible | Value that indicates whether the message is accessible anonymously. | bool |
| isExpress | bool | |
| maxSizeInMegabytes | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. | int |
| requiresDuplicateDetection | Value indicating if this topic requires duplicate detection. | bool |
| status | Enumerates the possible values for the status of a messaging entity. | 'Active' 'Creating' 'Deleting' 'Disabled' 'ReceiveDisabled' 'Renaming' 'Restoring' 'SendDisabled' 'Unknown' |
| supportOrdering | Value that indicates whether the topic supports ordering. | bool |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Correlating messages over Logic Apps using Service Bus |
which shows how we can correlate messages over Logic Apps using Azure Service Bus |
| 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. |
| 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/topics 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/topics resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces/topics@2015-08-01"
name = "string"
location = "string"
body = jsonencode({
properties = {
autoDeleteOnIdle = "string"
defaultMessageTimeToLive = "string"
duplicateDetectionHistoryTimeWindow = "string"
enableBatchedOperations = bool
enableExpress = bool
enablePartitioning = bool
entityAvailabilityStatus = "string"
filteringMessagesBeforePublishing = bool
isAnonymousAccessible = bool
isExpress = bool
maxSizeInMegabytes = int
requiresDuplicateDetection = bool
status = "string"
supportOrdering = bool
}
})
}
Property values
Microsoft.ServiceBus/namespaces/topics
| Name | Description | Value |
|---|---|---|
| location | Location of the resource. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: namespaces |
| properties | The Topic Properties definition. | TopicProperties |
| type | The resource type | "Microsoft.ServiceBus/namespaces/topics@2015-08-01" |
TopicProperties
| Name | Description | Value |
|---|---|---|
| autoDeleteOnIdle | TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. | string |
| defaultMessageTimeToLive | Default message time 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 | 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 | Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. | bool |
| enablePartitioning | Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. | bool |
| entityAvailabilityStatus | Entity availability status for the topic. | 'Available' 'Limited' 'Renaming' 'Restoring' 'Unknown' |
| filteringMessagesBeforePublishing | Whether messages should be filtered before publishing. | bool |
| isAnonymousAccessible | Value that indicates whether the message is accessible anonymously. | bool |
| isExpress | bool | |
| maxSizeInMegabytes | Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. | int |
| requiresDuplicateDetection | Value indicating if this topic requires duplicate detection. | bool |
| status | Enumerates the possible values for the status of a messaging entity. | 'Active' 'Creating' 'Deleting' 'Disabled' 'ReceiveDisabled' 'Renaming' 'Restoring' 'SendDisabled' 'Unknown' |
| supportOrdering | Value that indicates whether the topic supports ordering. | bool |