1. Packages
  2. Azure Native
  3. API Docs
  4. servicebus
  5. Rule
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.servicebus.Rule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Description of Rule Resource. Azure REST API version: 2022-01-01-preview. Prior API version in Azure Native 1.x: 2017-04-01.

    Other available API versions: 2022-10-01-preview.

    Example Usage

    RulesCreateCorrelationFilter

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var rule = new AzureNative.ServiceBus.Rule("rule", new()
        {
            CorrelationFilter = new AzureNative.ServiceBus.Inputs.CorrelationFilterArgs
            {
                Properties = 
                {
                    { "topicHint", "Crop" },
                },
            },
            FilterType = AzureNative.ServiceBus.FilterType.CorrelationFilter,
            NamespaceName = "sdk-Namespace-1319",
            ResourceGroupName = "resourceGroupName",
            RuleName = "sdk-Rules-6571",
            SubscriptionName = "sdk-Subscriptions-8691",
            TopicName = "sdk-Topics-2081",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/servicebus/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := servicebus.NewRule(ctx, "rule", &servicebus.RuleArgs{
    			CorrelationFilter: &servicebus.CorrelationFilterArgs{
    				Properties: pulumi.StringMap{
    					"topicHint": pulumi.String("Crop"),
    				},
    			},
    			FilterType:        pulumi.String(servicebus.FilterTypeCorrelationFilter),
    			NamespaceName:     pulumi.String("sdk-Namespace-1319"),
    			ResourceGroupName: pulumi.String("resourceGroupName"),
    			RuleName:          pulumi.String("sdk-Rules-6571"),
    			SubscriptionName:  pulumi.String("sdk-Subscriptions-8691"),
    			TopicName:         pulumi.String("sdk-Topics-2081"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.servicebus.Rule;
    import com.pulumi.azurenative.servicebus.RuleArgs;
    import com.pulumi.azurenative.servicebus.inputs.CorrelationFilterArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var rule = new Rule("rule", RuleArgs.builder()        
                .correlationFilter(CorrelationFilterArgs.builder()
                    .properties(Map.of("topicHint", "Crop"))
                    .build())
                .filterType("CorrelationFilter")
                .namespaceName("sdk-Namespace-1319")
                .resourceGroupName("resourceGroupName")
                .ruleName("sdk-Rules-6571")
                .subscriptionName("sdk-Subscriptions-8691")
                .topicName("sdk-Topics-2081")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    rule = azure_native.servicebus.Rule("rule",
        correlation_filter=azure_native.servicebus.CorrelationFilterArgs(
            properties={
                "topicHint": "Crop",
            },
        ),
        filter_type=azure_native.servicebus.FilterType.CORRELATION_FILTER,
        namespace_name="sdk-Namespace-1319",
        resource_group_name="resourceGroupName",
        rule_name="sdk-Rules-6571",
        subscription_name="sdk-Subscriptions-8691",
        topic_name="sdk-Topics-2081")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const rule = new azure_native.servicebus.Rule("rule", {
        correlationFilter: {
            properties: {
                topicHint: "Crop",
            },
        },
        filterType: azure_native.servicebus.FilterType.CorrelationFilter,
        namespaceName: "sdk-Namespace-1319",
        resourceGroupName: "resourceGroupName",
        ruleName: "sdk-Rules-6571",
        subscriptionName: "sdk-Subscriptions-8691",
        topicName: "sdk-Topics-2081",
    });
    
    resources:
      rule:
        type: azure-native:servicebus:Rule
        properties:
          correlationFilter:
            properties:
              topicHint: Crop
          filterType: CorrelationFilter
          namespaceName: sdk-Namespace-1319
          resourceGroupName: resourceGroupName
          ruleName: sdk-Rules-6571
          subscriptionName: sdk-Subscriptions-8691
          topicName: sdk-Topics-2081
    

    RulesCreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var rule = new AzureNative.ServiceBus.Rule("rule", new()
        {
            NamespaceName = "sdk-Namespace-1319",
            ResourceGroupName = "resourceGroupName",
            RuleName = "sdk-Rules-6571",
            SubscriptionName = "sdk-Subscriptions-8691",
            TopicName = "sdk-Topics-2081",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/servicebus/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := servicebus.NewRule(ctx, "rule", &servicebus.RuleArgs{
    			NamespaceName:     pulumi.String("sdk-Namespace-1319"),
    			ResourceGroupName: pulumi.String("resourceGroupName"),
    			RuleName:          pulumi.String("sdk-Rules-6571"),
    			SubscriptionName:  pulumi.String("sdk-Subscriptions-8691"),
    			TopicName:         pulumi.String("sdk-Topics-2081"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.servicebus.Rule;
    import com.pulumi.azurenative.servicebus.RuleArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var rule = new Rule("rule", RuleArgs.builder()        
                .namespaceName("sdk-Namespace-1319")
                .resourceGroupName("resourceGroupName")
                .ruleName("sdk-Rules-6571")
                .subscriptionName("sdk-Subscriptions-8691")
                .topicName("sdk-Topics-2081")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    rule = azure_native.servicebus.Rule("rule",
        namespace_name="sdk-Namespace-1319",
        resource_group_name="resourceGroupName",
        rule_name="sdk-Rules-6571",
        subscription_name="sdk-Subscriptions-8691",
        topic_name="sdk-Topics-2081")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const rule = new azure_native.servicebus.Rule("rule", {
        namespaceName: "sdk-Namespace-1319",
        resourceGroupName: "resourceGroupName",
        ruleName: "sdk-Rules-6571",
        subscriptionName: "sdk-Subscriptions-8691",
        topicName: "sdk-Topics-2081",
    });
    
    resources:
      rule:
        type: azure-native:servicebus:Rule
        properties:
          namespaceName: sdk-Namespace-1319
          resourceGroupName: resourceGroupName
          ruleName: sdk-Rules-6571
          subscriptionName: sdk-Subscriptions-8691
          topicName: sdk-Topics-2081
    

    RulesCreateSqlFilter

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var rule = new AzureNative.ServiceBus.Rule("rule", new()
        {
            FilterType = AzureNative.ServiceBus.FilterType.SqlFilter,
            NamespaceName = "sdk-Namespace-1319",
            ResourceGroupName = "resourceGroupName",
            RuleName = "sdk-Rules-6571",
            SqlFilter = new AzureNative.ServiceBus.Inputs.SqlFilterArgs
            {
                SqlExpression = "myproperty=test",
            },
            SubscriptionName = "sdk-Subscriptions-8691",
            TopicName = "sdk-Topics-2081",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/servicebus/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := servicebus.NewRule(ctx, "rule", &servicebus.RuleArgs{
    			FilterType:        pulumi.String(servicebus.FilterTypeSqlFilter),
    			NamespaceName:     pulumi.String("sdk-Namespace-1319"),
    			ResourceGroupName: pulumi.String("resourceGroupName"),
    			RuleName:          pulumi.String("sdk-Rules-6571"),
    			SqlFilter: &servicebus.SqlFilterArgs{
    				SqlExpression: pulumi.String("myproperty=test"),
    			},
    			SubscriptionName: pulumi.String("sdk-Subscriptions-8691"),
    			TopicName:        pulumi.String("sdk-Topics-2081"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.servicebus.Rule;
    import com.pulumi.azurenative.servicebus.RuleArgs;
    import com.pulumi.azurenative.servicebus.inputs.SqlFilterArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var rule = new Rule("rule", RuleArgs.builder()        
                .filterType("SqlFilter")
                .namespaceName("sdk-Namespace-1319")
                .resourceGroupName("resourceGroupName")
                .ruleName("sdk-Rules-6571")
                .sqlFilter(SqlFilterArgs.builder()
                    .sqlExpression("myproperty=test")
                    .build())
                .subscriptionName("sdk-Subscriptions-8691")
                .topicName("sdk-Topics-2081")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    rule = azure_native.servicebus.Rule("rule",
        filter_type=azure_native.servicebus.FilterType.SQL_FILTER,
        namespace_name="sdk-Namespace-1319",
        resource_group_name="resourceGroupName",
        rule_name="sdk-Rules-6571",
        sql_filter=azure_native.servicebus.SqlFilterArgs(
            sql_expression="myproperty=test",
        ),
        subscription_name="sdk-Subscriptions-8691",
        topic_name="sdk-Topics-2081")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const rule = new azure_native.servicebus.Rule("rule", {
        filterType: azure_native.servicebus.FilterType.SqlFilter,
        namespaceName: "sdk-Namespace-1319",
        resourceGroupName: "resourceGroupName",
        ruleName: "sdk-Rules-6571",
        sqlFilter: {
            sqlExpression: "myproperty=test",
        },
        subscriptionName: "sdk-Subscriptions-8691",
        topicName: "sdk-Topics-2081",
    });
    
    resources:
      rule:
        type: azure-native:servicebus:Rule
        properties:
          filterType: SqlFilter
          namespaceName: sdk-Namespace-1319
          resourceGroupName: resourceGroupName
          ruleName: sdk-Rules-6571
          sqlFilter:
            sqlExpression: myproperty=test
          subscriptionName: sdk-Subscriptions-8691
          topicName: sdk-Topics-2081
    

    Create Rule Resource

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

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
    def Rule(resource_name: str,
             args: RuleArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Rule(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[Union[str, FilterType]] = None,
             rule_name: Optional[str] = None,
             sql_filter: Optional[SqlFilterArgs] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
    public Rule(String name, RuleArgs args, CustomResourceOptions options)
    
    type: azure-native:servicebus:Rule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RuleArgs
    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 RuleArgs
    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 RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var azure_nativeRuleResource = new AzureNative.ServiceBus.Rule("azure-nativeRuleResource", 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 = "string",
        RuleName = "string",
        SqlFilter = new AzureNative.ServiceBus.Inputs.SqlFilterArgs
        {
            CompatibilityLevel = 0,
            RequiresPreprocessing = false,
            SqlExpression = "string",
        },
    });
    
    example, err := servicebus.NewRule(ctx, "azure-nativeRuleResource", &servicebus.RuleArgs{
    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: pulumi.String("string"),
    RuleName: pulumi.String("string"),
    SqlFilter: &servicebus.SqlFilterArgs{
    CompatibilityLevel: pulumi.Int(0),
    RequiresPreprocessing: pulumi.Bool(false),
    SqlExpression: pulumi.String("string"),
    },
    })
    
    var azure_nativeRuleResource = new Rule("azure-nativeRuleResource", RuleArgs.builder()        
        .namespaceName("string")
        .resourceGroupName("string")
        .subscriptionName("string")
        .topicName("string")
        .action(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("string")
        .ruleName("string")
        .sqlFilter(SqlFilterArgs.builder()
            .compatibilityLevel(0)
            .requiresPreprocessing(false)
            .sqlExpression("string")
            .build())
        .build());
    
    azure_native_rule_resource = azure_native.servicebus.Rule("azure-nativeRuleResource",
        namespace_name="string",
        resource_group_name="string",
        subscription_name="string",
        topic_name="string",
        action=azure_native.servicebus.ActionArgs(
            compatibility_level=0,
            requires_preprocessing=False,
            sql_expression="string",
        ),
        correlation_filter=azure_native.servicebus.CorrelationFilterArgs(
            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="string",
        rule_name="string",
        sql_filter=azure_native.servicebus.SqlFilterArgs(
            compatibility_level=0,
            requires_preprocessing=False,
            sql_expression="string",
        ))
    
    const azure_nativeRuleResource = new azure_native.servicebus.Rule("azure-nativeRuleResource", {
        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: "string",
        ruleName: "string",
        sqlFilter: {
            compatibilityLevel: 0,
            requiresPreprocessing: false,
            sqlExpression: "string",
        },
    });
    
    type: azure-native:servicebus:Rule
    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: string
        namespaceName: string
        resourceGroupName: string
        ruleName: string
        sqlFilter:
            compatibilityLevel: 0
            requiresPreprocessing: false
            sqlExpression: string
        subscriptionName: string
        topicName: string
    

    Rule Resource Properties

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

    Inputs

    The Rule resource accepts the following input properties:

    NamespaceName string
    The namespace name
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    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 string | Pulumi.AzureNative.ServiceBus.FilterType
    Filter type that is evaluated against a BrokeredMessage.
    RuleName string
    The rule name.
    SqlFilter Pulumi.AzureNative.ServiceBus.Inputs.SqlFilter
    Properties of sqlFilter
    NamespaceName string
    The namespace name
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    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 string | FilterType
    Filter type that is evaluated against a BrokeredMessage.
    RuleName string
    The rule name.
    SqlFilter SqlFilterArgs
    Properties of sqlFilter
    namespaceName String
    The namespace name
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    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 String | FilterType
    Filter type that is evaluated against a BrokeredMessage.
    ruleName String
    The rule name.
    sqlFilter SqlFilter
    Properties of sqlFilter
    namespaceName string
    The namespace name
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    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 string | FilterType
    Filter type that is evaluated against a BrokeredMessage.
    ruleName string
    The rule name.
    sqlFilter SqlFilter
    Properties of sqlFilter
    namespace_name str
    The namespace name
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    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 str | FilterType
    Filter type that is evaluated against a BrokeredMessage.
    rule_name str
    The rule name.
    sql_filter SqlFilterArgs
    Properties of sqlFilter
    namespaceName String
    The namespace name
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    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 String | "SqlFilter" | "CorrelationFilter"
    Filter type that is evaluated against a BrokeredMessage.
    ruleName String
    The rule name.
    sqlFilter Property Map
    Properties of sqlFilter

    Outputs

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

    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"
    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"
    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"
    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"
    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"
    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

    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'
    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

    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'
    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

    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.
    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

    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.
    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
    SQL_FILTER
    SqlFilter
    CORRELATION_FILTER
    CorrelationFilter
    "SqlFilter"
    SqlFilter
    "CorrelationFilter"
    CorrelationFilter

    SqlFilter, SqlFilterArgs

    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'
    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

    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'
    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

    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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:Rule sdk-Rules-6571 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName} 
    

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi