Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. servicebus
  6. DefaultRule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.28.0
published on Sunday, Sep 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.servicebus.DefaultRule

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.28.0
published on Sunday, Sep 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    The “$Default” rule that Azure automatically creates alongside every ServiceBus subscription.

    By default this rule has a TrueFilter, which allows all messages through to the subscription. This resource lets you manage that rule directly: update its filter (e.g. to a SqlFilter or CorrelationFilter), or delete this resource to remove the rule entirely.

    Unlike Rule, this resource has no ruleName input since it always refers to the “$Default” rule that Azure creates for you; there’s no need to construct or import its resource ID by hand.

    Note: deleting this resource permanently removes the “$Default” rule from the subscription. If no other rules exist afterwards, the subscription will not receive any messages from the topic.

    See Issue #4489 for more details on the problem this resource solves.

    Create DefaultRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DefaultRule(name: string, args: DefaultRuleArgs, opts?: CustomResourceOptions);
    @overload
def DefaultRule(resource_name: str,
                args: DefaultRuleArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def DefaultRule(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                namespace_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                subscription_name: Optional[str] = None,
                topic_name: Optional[str] = None,
                action: Optional[ActionArgs] = None,
                correlation_filter: Optional[CorrelationFilterArgs] = None,
                filter_type: Optional[FilterType] = None,
                sql_filter: Optional[SqlFilterArgs] = None)
    func NewDefaultRule(ctx *Context, name string, args DefaultRuleArgs, opts ...ResourceOption) (*DefaultRule, error)
    public DefaultRule(string name, DefaultRuleArgs args, CustomResourceOptions? opts = null)
    public DefaultRule(String name, DefaultRuleArgs args)
public DefaultRule(String name, DefaultRuleArgs args, CustomResourceOptions options)

    type: azure-native:servicebus:DefaultRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "azure-native_servicebus_default_rule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DefaultRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DefaultRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DefaultRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DefaultRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DefaultRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var defaultRuleResource = new AzureNative.ServiceBus.DefaultRule("defaultRuleResource", new()
{
    NamespaceName = "string",
    ResourceGroupName = "string",
    SubscriptionName = "string",
    TopicName = "string",
    Action = new AzureNative.ServiceBus.Inputs.ActionArgs
    {
        CompatibilityLevel = 0,
        RequiresPreprocessing = false,
        SqlExpression = "string",
    },
    CorrelationFilter = new AzureNative.ServiceBus.Inputs.CorrelationFilterArgs
    {
        ContentType = "string",
        CorrelationId = "string",
        Label = "string",
        MessageId = "string",
        Properties = 
        {
            { "string", "string" },
        },
        ReplyTo = "string",
        ReplyToSessionId = "string",
        RequiresPreprocessing = false,
        SessionId = "string",
        To = "string",
    },
    FilterType = AzureNative.ServiceBus.FilterType.SqlFilter,
    SqlFilter = new AzureNative.ServiceBus.Inputs.SqlFilterArgs
    {
        CompatibilityLevel = 0,
        RequiresPreprocessing = false,
        SqlExpression = "string",
    },
});

    example, err := servicebus.NewDefaultRule(ctx, "defaultRuleResource", &servicebus.DefaultRuleArgs{
	NamespaceName:     pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	SubscriptionName:  pulumi.String("string"),
	TopicName:         pulumi.String("string"),
	Action: &servicebus.ActionArgs{
		CompatibilityLevel:    pulumi.Int(0),
		RequiresPreprocessing: pulumi.Bool(false),
		SqlExpression:         pulumi.String("string"),
	},
	CorrelationFilter: &servicebus.CorrelationFilterArgs{
		ContentType:   pulumi.String("string"),
		CorrelationId: pulumi.String("string"),
		Label:         pulumi.String("string"),
		MessageId:     pulumi.String("string"),
		Properties: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ReplyTo:               pulumi.String("string"),
		ReplyToSessionId:      pulumi.String("string"),
		RequiresPreprocessing: pulumi.Bool(false),
		SessionId:             pulumi.String("string"),
		To:                    pulumi.String("string"),
	},
	FilterType: servicebus.FilterTypeSqlFilter,
	SqlFilter: &servicebus.SqlFilterArgs{
		CompatibilityLevel:    pulumi.Int(0),
		RequiresPreprocessing: pulumi.Bool(false),
		SqlExpression:         pulumi.String("string"),
	},
})

    resource "azure-native_servicebus_default_rule" "defaultRuleResource" {
  lifecycle {
    create_before_destroy = true
  }
  namespace_name      = "string"
  resource_group_name = "string"
  subscription_name   = "string"
  topic_name          = "string"
  action = {
    compatibility_level    = 0
    requires_preprocessing = false
    sql_expression         = "string"
  }
  correlation_filter = {
    content_type   = "string"
    correlation_id = "string"
    label          = "string"
    message_id     = "string"
    properties = {
      "string" = "string"
    }
    reply_to               = "string"
    reply_to_session_id    = "string"
    requires_preprocessing = false
    session_id             = "string"
    to                     = "string"
  }
  filter_type = "SqlFilter"
  sql_filter = {
    compatibility_level    = 0
    requires_preprocessing = false
    sql_expression         = "string"
  }
}

    var defaultRuleResource = new DefaultRule("defaultRuleResource", DefaultRuleArgs.builder()
    .namespaceName("string")
    .resourceGroupName("string")
    .subscriptionName("string")
    .topicName("string")
    .action(com.pulumi.azurenative.servicebus.inputs.ActionArgs.builder()
        .compatibilityLevel(0)
        .requiresPreprocessing(false)
        .sqlExpression("string")
        .build())
    .correlationFilter(CorrelationFilterArgs.builder()
        .contentType("string")
        .correlationId("string")
        .label("string")
        .messageId("string")
        .properties(Map.of("string", "string"))
        .replyTo("string")
        .replyToSessionId("string")
        .requiresPreprocessing(false)
        .sessionId("string")
        .to("string")
        .build())
    .filterType("SqlFilter")
    .sqlFilter(SqlFilterArgs.builder()
        .compatibilityLevel(0)
        .requiresPreprocessing(false)
        .sqlExpression("string")
        .build())
    .build());

    default_rule_resource = azure_native.servicebus.DefaultRule("defaultRuleResource",
    namespace_name="string",
    resource_group_name="string",
    subscription_name="string",
    topic_name="string",
    action={
        "compatibility_level": 0,
        "requires_preprocessing": False,
        "sql_expression": "string",
    },
    correlation_filter={
        "content_type": "string",
        "correlation_id": "string",
        "label": "string",
        "message_id": "string",
        "properties": {
            "string": "string",
        },
        "reply_to": "string",
        "reply_to_session_id": "string",
        "requires_preprocessing": False,
        "session_id": "string",
        "to": "string",
    },
    filter_type=azure_native.servicebus.FilterType.SQL_FILTER,
    sql_filter={
        "compatibility_level": 0,
        "requires_preprocessing": False,
        "sql_expression": "string",
    })

    const defaultRuleResource = new azure_native.servicebus.DefaultRule("defaultRuleResource", {
    namespaceName: "string",
    resourceGroupName: "string",
    subscriptionName: "string",
    topicName: "string",
    action: {
        compatibilityLevel: 0,
        requiresPreprocessing: false,
        sqlExpression: "string",
    },
    correlationFilter: {
        contentType: "string",
        correlationId: "string",
        label: "string",
        messageId: "string",
        properties: {
            string: "string",
        },
        replyTo: "string",
        replyToSessionId: "string",
        requiresPreprocessing: false,
        sessionId: "string",
        to: "string",
    },
    filterType: azure_native.servicebus.FilterType.SqlFilter,
    sqlFilter: {
        compatibilityLevel: 0,
        requiresPreprocessing: false,
        sqlExpression: "string",
    },
});

    type: azure-native:servicebus:DefaultRule
properties:
    action:
        compatibilityLevel: 0
        requiresPreprocessing: false
        sqlExpression: string
    correlationFilter:
        contentType: string
        correlationId: string
        label: string
        messageId: string
        properties:
            string: string
        replyTo: string
        replyToSessionId: string
        requiresPreprocessing: false
        sessionId: string
        to: string
    filterType: SqlFilter
    namespaceName: string
    resourceGroupName: string
    sqlFilter:
        compatibilityLevel: 0
        requiresPreprocessing: false
        sqlExpression: string
    subscriptionName: string
    topicName: string

    DefaultRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DefaultRule resource accepts the following input properties:

    NamespaceName string
    The namespace name
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SubscriptionName string
    The subscription name.
    TopicName string
    The topic name.
    Action Pulumi.AzureNative.ServiceBus.Inputs.Action
    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    CorrelationFilter Pulumi.AzureNative.ServiceBus.Inputs.CorrelationFilter
    Properties of correlationFilter
    FilterType Pulumi.AzureNative.ServiceBus.FilterType
    Filter type that is evaluated against a BrokeredMessage.
    SqlFilter Pulumi.AzureNative.ServiceBus.Inputs.SqlFilter
    Properties of sqlFilter
    NamespaceName string
    The namespace name
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SubscriptionName string
    The subscription name.
    TopicName string
    The topic name.
    Action ActionArgs
    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    CorrelationFilter CorrelationFilterArgs
    Properties of correlationFilter
    FilterType FilterType
    Filter type that is evaluated against a BrokeredMessage.
    SqlFilter SqlFilterArgs
    Properties of sqlFilter
    namespace_name string
    The namespace name
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    subscription_name string
    The subscription name.
    topic_name string
    The topic name.
    action object
    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    correlation_filter object
    Properties of correlationFilter
    filter_type "SqlFilter" | "CorrelationFilter"
    Filter type that is evaluated against a BrokeredMessage.
    sql_filter object
    Properties of sqlFilter
    namespaceName String
    The namespace name
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    subscriptionName String
    The subscription name.
    topicName String
    The topic name.
    action Action
    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    correlationFilter CorrelationFilter
    Properties of correlationFilter
    filterType FilterType
    Filter type that is evaluated against a BrokeredMessage.
    sqlFilter SqlFilter
    Properties of sqlFilter
    namespaceName string
    The namespace name
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    subscriptionName string
    The subscription name.
    topicName string
    The topic name.
    action Action
    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    correlationFilter CorrelationFilter
    Properties of correlationFilter
    filterType FilterType
    Filter type that is evaluated against a BrokeredMessage.
    sqlFilter SqlFilter
    Properties of sqlFilter
    namespace_name str
    The namespace name
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    subscription_name str
    The subscription name.
    topic_name str
    The topic name.
    action ActionArgs
    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    correlation_filter CorrelationFilterArgs
    Properties of correlationFilter
    filter_type FilterType
    Filter type that is evaluated against a BrokeredMessage.
    sql_filter SqlFilterArgs
    Properties of sqlFilter
    namespaceName String
    The namespace name
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    subscriptionName String
    The subscription name.
    topicName String
    The topic name.
    action Property Map
    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    correlationFilter Property Map
    Properties of correlationFilter
    filterType "SqlFilter" | "CorrelationFilter"
    Filter type that is evaluated against a BrokeredMessage.
    sqlFilter Property Map
    Properties of sqlFilter

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DefaultRule resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.ServiceBus.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    azure_api_version string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    system_data object
    The system meta data relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData Property Map
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

    Supporting Types

    Action, ActionArgs

    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    CompatibilityLevel int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SqlExpression string
    SQL expression. e.g. MyProperty='ABC'
    CompatibilityLevel int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SqlExpression string
    SQL expression. e.g. MyProperty='ABC'
    compatibility_level number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    sql_expression string
    SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel Integer
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression String
    SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression string
    SQL expression. e.g. MyProperty='ABC'
    compatibility_level int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    sql_expression str
    SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel Number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression String
    SQL expression. e.g. MyProperty='ABC'

    ActionResponse, ActionResponseArgs

    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
    CompatibilityLevel int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SqlExpression string
    SQL expression. e.g. MyProperty='ABC'
    CompatibilityLevel int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SqlExpression string
    SQL expression. e.g. MyProperty='ABC'
    compatibility_level number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    sql_expression string
    SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel Integer
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression String
    SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression string
    SQL expression. e.g. MyProperty='ABC'
    compatibility_level int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    sql_expression str
    SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel Number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression String
    SQL expression. e.g. MyProperty='ABC'

    CorrelationFilter, CorrelationFilterArgs

    Represents the correlation filter expression.
    ContentType string
    Content type of the message.
    CorrelationId string
    Identifier of the correlation.
    Label string
    Application specific label.
    MessageId string
    Identifier of the message.
    Properties Dictionary<string, string>
    dictionary object for custom filters
    ReplyTo string
    Address of the queue to reply to.
    ReplyToSessionId string
    Session identifier to reply to.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SessionId string
    Session identifier.
    To string
    Address to send to.
    ContentType string
    Content type of the message.
    CorrelationId string
    Identifier of the correlation.
    Label string
    Application specific label.
    MessageId string
    Identifier of the message.
    Properties map[string]string
    dictionary object for custom filters
    ReplyTo string
    Address of the queue to reply to.
    ReplyToSessionId string
    Session identifier to reply to.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SessionId string
    Session identifier.
    To string
    Address to send to.
    content_type string
    Content type of the message.
    correlation_id string
    Identifier of the correlation.
    label string
    Application specific label.
    message_id string
    Identifier of the message.
    properties map(string)
    dictionary object for custom filters
    reply_to string
    Address of the queue to reply to.
    reply_to_session_id string
    Session identifier to reply to.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    session_id string
    Session identifier.
    to string
    Address to send to.
    contentType String
    Content type of the message.
    correlationId String
    Identifier of the correlation.
    label String
    Application specific label.
    messageId String
    Identifier of the message.
    properties Map<String,String>
    dictionary object for custom filters
    replyTo String
    Address of the queue to reply to.
    replyToSessionId String
    Session identifier to reply to.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sessionId String
    Session identifier.
    to String
    Address to send to.
    contentType string
    Content type of the message.
    correlationId string
    Identifier of the correlation.
    label string
    Application specific label.
    messageId string
    Identifier of the message.
    properties {[key: string]: string}
    dictionary object for custom filters
    replyTo string
    Address of the queue to reply to.
    replyToSessionId string
    Session identifier to reply to.
    requiresPreprocessing boolean
    Value that indicates whether the rule action requires preprocessing.
    sessionId string
    Session identifier.
    to string
    Address to send to.
    content_type str
    Content type of the message.
    correlation_id str
    Identifier of the correlation.
    label str
    Application specific label.
    message_id str
    Identifier of the message.
    properties Mapping[str, str]
    dictionary object for custom filters
    reply_to str
    Address of the queue to reply to.
    reply_to_session_id str
    Session identifier to reply to.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    session_id str
    Session identifier.
    to str
    Address to send to.
    contentType String
    Content type of the message.
    correlationId String
    Identifier of the correlation.
    label String
    Application specific label.
    messageId String
    Identifier of the message.
    properties Map<String>
    dictionary object for custom filters
    replyTo String
    Address of the queue to reply to.
    replyToSessionId String
    Session identifier to reply to.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sessionId String
    Session identifier.
    to String
    Address to send to.

    CorrelationFilterResponse, CorrelationFilterResponseArgs

    Represents the correlation filter expression.
    ContentType string
    Content type of the message.
    CorrelationId string
    Identifier of the correlation.
    Label string
    Application specific label.
    MessageId string
    Identifier of the message.
    Properties Dictionary<string, string>
    dictionary object for custom filters
    ReplyTo string
    Address of the queue to reply to.
    ReplyToSessionId string
    Session identifier to reply to.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SessionId string
    Session identifier.
    To string
    Address to send to.
    ContentType string
    Content type of the message.
    CorrelationId string
    Identifier of the correlation.
    Label string
    Application specific label.
    MessageId string
    Identifier of the message.
    Properties map[string]string
    dictionary object for custom filters
    ReplyTo string
    Address of the queue to reply to.
    ReplyToSessionId string
    Session identifier to reply to.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SessionId string
    Session identifier.
    To string
    Address to send to.
    content_type string
    Content type of the message.
    correlation_id string
    Identifier of the correlation.
    label string
    Application specific label.
    message_id string
    Identifier of the message.
    properties map(string)
    dictionary object for custom filters
    reply_to string
    Address of the queue to reply to.
    reply_to_session_id string
    Session identifier to reply to.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    session_id string
    Session identifier.
    to string
    Address to send to.
    contentType String
    Content type of the message.
    correlationId String
    Identifier of the correlation.
    label String
    Application specific label.
    messageId String
    Identifier of the message.
    properties Map<String,String>
    dictionary object for custom filters
    replyTo String
    Address of the queue to reply to.
    replyToSessionId String
    Session identifier to reply to.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sessionId String
    Session identifier.
    to String
    Address to send to.
    contentType string
    Content type of the message.
    correlationId string
    Identifier of the correlation.
    label string
    Application specific label.
    messageId string
    Identifier of the message.
    properties {[key: string]: string}
    dictionary object for custom filters
    replyTo string
    Address of the queue to reply to.
    replyToSessionId string
    Session identifier to reply to.
    requiresPreprocessing boolean
    Value that indicates whether the rule action requires preprocessing.
    sessionId string
    Session identifier.
    to string
    Address to send to.
    content_type str
    Content type of the message.
    correlation_id str
    Identifier of the correlation.
    label str
    Application specific label.
    message_id str
    Identifier of the message.
    properties Mapping[str, str]
    dictionary object for custom filters
    reply_to str
    Address of the queue to reply to.
    reply_to_session_id str
    Session identifier to reply to.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    session_id str
    Session identifier.
    to str
    Address to send to.
    contentType String
    Content type of the message.
    correlationId String
    Identifier of the correlation.
    label String
    Application specific label.
    messageId String
    Identifier of the message.
    properties Map<String>
    dictionary object for custom filters
    replyTo String
    Address of the queue to reply to.
    replyToSessionId String
    Session identifier to reply to.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sessionId String
    Session identifier.
    to String
    Address to send to.

    FilterType, FilterTypeArgs

    SqlFilter
    SqlFilter
    CorrelationFilter
    CorrelationFilter
    FilterTypeSqlFilter
    SqlFilter
    FilterTypeCorrelationFilter
    CorrelationFilter
    "SqlFilter"
    SqlFilter
    "CorrelationFilter"
    CorrelationFilter
    SqlFilter
    SqlFilter
    CorrelationFilter
    CorrelationFilter
    SqlFilter
    SqlFilter
    CorrelationFilter
    CorrelationFilter
    SQL_FILTER
    SqlFilter
    CORRELATION_FILTER
    CorrelationFilter
    "SqlFilter"
    SqlFilter
    "CorrelationFilter"
    CorrelationFilter

    SqlFilter, SqlFilterArgs

    Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
    CompatibilityLevel int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SqlExpression string
    The SQL expression. e.g. MyProperty='ABC'
    CompatibilityLevel int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SqlExpression string
    The SQL expression. e.g. MyProperty='ABC'
    compatibility_level number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    sql_expression string
    The SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel Integer
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression String
    The SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression string
    The SQL expression. e.g. MyProperty='ABC'
    compatibility_level int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    sql_expression str
    The SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel Number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression String
    The SQL expression. e.g. MyProperty='ABC'

    SqlFilterResponse, SqlFilterResponseArgs

    Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
    CompatibilityLevel int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SqlExpression string
    The SQL expression. e.g. MyProperty='ABC'
    CompatibilityLevel int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    RequiresPreprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    SqlExpression string
    The SQL expression. e.g. MyProperty='ABC'
    compatibility_level number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    sql_expression string
    The SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel Integer
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression String
    The SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression string
    The SQL expression. e.g. MyProperty='ABC'
    compatibility_level int
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requires_preprocessing bool
    Value that indicates whether the rule action requires preprocessing.
    sql_expression str
    The SQL expression. e.g. MyProperty='ABC'
    compatibilityLevel Number
    This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
    requiresPreprocessing Boolean
    Value that indicates whether the rule action requires preprocessing.
    sqlExpression String
    The SQL expression. e.g. MyProperty='ABC'

    SystemDataResponse, SystemDataResponseArgs

    Metadata pertaining to creation and last modification of the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:servicebus:DefaultRule myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/$Default

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.28.0
    published on Sunday, Sep 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial