Microsoft.ServiceBus namespaces/topics/subscriptions/rules 2017-04-01

The namespaces/topics/subscriptions/rules resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ServiceBus/namespaces/topics/subscriptions/rules resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ServiceBus/namespaces/topics/subscriptions/rules@2017-04-01' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    action: {
      compatibilityLevel: int
      requiresPreprocessing: bool
      sqlExpression: 'string'
    }
    correlationFilter: {
      contentType: 'string'
      correlationId: 'string'
      label: 'string'
      messageId: 'string'
      properties: {}
      replyTo: 'string'
      replyToSessionId: 'string'
      requiresPreprocessing: bool
      sessionId: 'string'
      to: 'string'
    }
    filterType: 'string'
    sqlFilter: {
      compatibilityLevel: int
      requiresPreprocessing: bool
      sqlExpression: 'string'
    }
  }
}

Property values

namespaces/topics/subscriptions/rules

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ServiceBus/namespaces/topics/subscriptions/rules'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2017-04-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (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.
parentSymbolicName
properties Description of Rule Resource. Ruleproperties

Ruleproperties

Name Description Value
action Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. Action
correlationFilter Represents the correlation filter expression. CorrelationFilter
filterType Rule filter types 'CorrelationFilter'
'SqlFilter'
sqlFilter Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. SqlFilter

Action

Name Description Value
compatibilityLevel This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. int
requiresPreprocessing Value that indicates whether the rule action requires preprocessing. bool
sqlExpression SQL expression. e.g. MyProperty='ABC' string

CorrelationFilter

Name Description Value
contentType Content type of the message. string
correlationId Identifier of the correlation. string
label Application specific label. string
messageId Identifier of the message. string
properties dictionary object for custom filters object
replyTo Address of the queue to reply to. string
replyToSessionId Session identifier to reply to. string
requiresPreprocessing Value that indicates whether the rule action requires preprocessing. bool
sessionId Session identifier. string
to Address to send to. string

SqlFilter

Name Description Value
compatibilityLevel This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. int
requiresPreprocessing Value that indicates whether the rule action requires preprocessing. bool
sqlExpression The SQL expression. e.g. MyProperty='ABC' string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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
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