1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. servicebus
  5. SubscriptionRule
azure logo
Azure Classic v5.38.0, Mar 21 23

azure.servicebus.SubscriptionRule

Manages a ServiceBus Subscription Rule.

Example Usage

SQL Filter)

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleNamespace = new Azure.ServiceBus.Namespace("exampleNamespace", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "Standard",
        Tags = 
        {
            { "source", "example" },
        },
    });

    var exampleTopic = new Azure.ServiceBus.Topic("exampleTopic", new()
    {
        NamespaceId = exampleNamespace.Id,
        EnablePartitioning = true,
    });

    var exampleSubscription = new Azure.ServiceBus.Subscription("exampleSubscription", new()
    {
        TopicId = exampleTopic.Id,
        MaxDeliveryCount = 1,
    });

    var exampleSubscriptionRule = new Azure.ServiceBus.SubscriptionRule("exampleSubscriptionRule", new()
    {
        SubscriptionId = exampleSubscription.Id,
        FilterType = "SqlFilter",
        SqlFilter = "colour = 'red'",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/servicebus"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("Standard"),
			Tags: pulumi.StringMap{
				"source": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{
			NamespaceId:        exampleNamespace.ID(),
			EnablePartitioning: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleSubscription, err := servicebus.NewSubscription(ctx, "exampleSubscription", &servicebus.SubscriptionArgs{
			TopicId:          exampleTopic.ID(),
			MaxDeliveryCount: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = servicebus.NewSubscriptionRule(ctx, "exampleSubscriptionRule", &servicebus.SubscriptionRuleArgs{
			SubscriptionId: exampleSubscription.ID(),
			FilterType:     pulumi.String("SqlFilter"),
			SqlFilter:      pulumi.String("colour = 'red'"),
		})
		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.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.servicebus.Namespace;
import com.pulumi.azure.servicebus.NamespaceArgs;
import com.pulumi.azure.servicebus.Topic;
import com.pulumi.azure.servicebus.TopicArgs;
import com.pulumi.azure.servicebus.Subscription;
import com.pulumi.azure.servicebus.SubscriptionArgs;
import com.pulumi.azure.servicebus.SubscriptionRule;
import com.pulumi.azure.servicebus.SubscriptionRuleArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku("Standard")
            .tags(Map.of("source", "example"))
            .build());

        var exampleTopic = new Topic("exampleTopic", TopicArgs.builder()        
            .namespaceId(exampleNamespace.id())
            .enablePartitioning(true)
            .build());

        var exampleSubscription = new Subscription("exampleSubscription", SubscriptionArgs.builder()        
            .topicId(exampleTopic.id())
            .maxDeliveryCount(1)
            .build());

        var exampleSubscriptionRule = new SubscriptionRule("exampleSubscriptionRule", SubscriptionRuleArgs.builder()        
            .subscriptionId(exampleSubscription.id())
            .filterType("SqlFilter")
            .sqlFilter("colour = 'red'")
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("exampleTopic",
    namespace_id=example_namespace.id,
    enable_partitioning=True)
example_subscription = azure.servicebus.Subscription("exampleSubscription",
    topic_id=example_topic.id,
    max_delivery_count=1)
example_subscription_rule = azure.servicebus.SubscriptionRule("exampleSubscriptionRule",
    subscription_id=example_subscription.id,
    filter_type="SqlFilter",
    sql_filter="colour = 'red'")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
    tags: {
        source: "example",
    },
});
const exampleTopic = new azure.servicebus.Topic("exampleTopic", {
    namespaceId: exampleNamespace.id,
    enablePartitioning: true,
});
const exampleSubscription = new azure.servicebus.Subscription("exampleSubscription", {
    topicId: exampleTopic.id,
    maxDeliveryCount: 1,
});
const exampleSubscriptionRule = new azure.servicebus.SubscriptionRule("exampleSubscriptionRule", {
    subscriptionId: exampleSubscription.id,
    filterType: "SqlFilter",
    sqlFilter: "colour = 'red'",
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleNamespace:
    type: azure:servicebus:Namespace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: Standard
      tags:
        source: example
  exampleTopic:
    type: azure:servicebus:Topic
    properties:
      namespaceId: ${exampleNamespace.id}
      enablePartitioning: true
  exampleSubscription:
    type: azure:servicebus:Subscription
    properties:
      topicId: ${exampleTopic.id}
      maxDeliveryCount: 1
  exampleSubscriptionRule:
    type: azure:servicebus:SubscriptionRule
    properties:
      subscriptionId: ${exampleSubscription.id}
      filterType: SqlFilter
      sqlFilter: colour = 'red'

Correlation Filter)

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleNamespace = new Azure.ServiceBus.Namespace("exampleNamespace", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "Standard",
        Tags = 
        {
            { "source", "example" },
        },
    });

    var exampleTopic = new Azure.ServiceBus.Topic("exampleTopic", new()
    {
        NamespaceId = exampleNamespace.Id,
        EnablePartitioning = true,
    });

    var exampleSubscription = new Azure.ServiceBus.Subscription("exampleSubscription", new()
    {
        TopicId = exampleTopic.Id,
        MaxDeliveryCount = 1,
    });

    var exampleSubscriptionRule = new Azure.ServiceBus.SubscriptionRule("exampleSubscriptionRule", new()
    {
        SubscriptionId = exampleSubscription.Id,
        FilterType = "CorrelationFilter",
        CorrelationFilter = new Azure.ServiceBus.Inputs.SubscriptionRuleCorrelationFilterArgs
        {
            CorrelationId = "high",
            Label = "red",
            Properties = 
            {
                { "customProperty", "value" },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/servicebus"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku:               pulumi.String("Standard"),
			Tags: pulumi.StringMap{
				"source": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{
			NamespaceId:        exampleNamespace.ID(),
			EnablePartitioning: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleSubscription, err := servicebus.NewSubscription(ctx, "exampleSubscription", &servicebus.SubscriptionArgs{
			TopicId:          exampleTopic.ID(),
			MaxDeliveryCount: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = servicebus.NewSubscriptionRule(ctx, "exampleSubscriptionRule", &servicebus.SubscriptionRuleArgs{
			SubscriptionId: exampleSubscription.ID(),
			FilterType:     pulumi.String("CorrelationFilter"),
			CorrelationFilter: &servicebus.SubscriptionRuleCorrelationFilterArgs{
				CorrelationId: pulumi.String("high"),
				Label:         pulumi.String("red"),
				Properties: pulumi.StringMap{
					"customProperty": pulumi.String("value"),
				},
			},
		})
		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.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.servicebus.Namespace;
import com.pulumi.azure.servicebus.NamespaceArgs;
import com.pulumi.azure.servicebus.Topic;
import com.pulumi.azure.servicebus.TopicArgs;
import com.pulumi.azure.servicebus.Subscription;
import com.pulumi.azure.servicebus.SubscriptionArgs;
import com.pulumi.azure.servicebus.SubscriptionRule;
import com.pulumi.azure.servicebus.SubscriptionRuleArgs;
import com.pulumi.azure.servicebus.inputs.SubscriptionRuleCorrelationFilterArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku("Standard")
            .tags(Map.of("source", "example"))
            .build());

        var exampleTopic = new Topic("exampleTopic", TopicArgs.builder()        
            .namespaceId(exampleNamespace.id())
            .enablePartitioning(true)
            .build());

        var exampleSubscription = new Subscription("exampleSubscription", SubscriptionArgs.builder()        
            .topicId(exampleTopic.id())
            .maxDeliveryCount(1)
            .build());

        var exampleSubscriptionRule = new SubscriptionRule("exampleSubscriptionRule", SubscriptionRuleArgs.builder()        
            .subscriptionId(exampleSubscription.id())
            .filterType("CorrelationFilter")
            .correlationFilter(SubscriptionRuleCorrelationFilterArgs.builder()
                .correlationId("high")
                .label("red")
                .properties(Map.of("customProperty", "value"))
                .build())
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("exampleTopic",
    namespace_id=example_namespace.id,
    enable_partitioning=True)
example_subscription = azure.servicebus.Subscription("exampleSubscription",
    topic_id=example_topic.id,
    max_delivery_count=1)
example_subscription_rule = azure.servicebus.SubscriptionRule("exampleSubscriptionRule",
    subscription_id=example_subscription.id,
    filter_type="CorrelationFilter",
    correlation_filter=azure.servicebus.SubscriptionRuleCorrelationFilterArgs(
        correlation_id="high",
        label="red",
        properties={
            "customProperty": "value",
        },
    ))

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "Standard",
    tags: {
        source: "example",
    },
});
const exampleTopic = new azure.servicebus.Topic("exampleTopic", {
    namespaceId: exampleNamespace.id,
    enablePartitioning: true,
});
const exampleSubscription = new azure.servicebus.Subscription("exampleSubscription", {
    topicId: exampleTopic.id,
    maxDeliveryCount: 1,
});
const exampleSubscriptionRule = new azure.servicebus.SubscriptionRule("exampleSubscriptionRule", {
    subscriptionId: exampleSubscription.id,
    filterType: "CorrelationFilter",
    correlationFilter: {
        correlationId: "high",
        label: "red",
        properties: {
            customProperty: "value",
        },
    },
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleNamespace:
    type: azure:servicebus:Namespace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: Standard
      tags:
        source: example
  exampleTopic:
    type: azure:servicebus:Topic
    properties:
      namespaceId: ${exampleNamespace.id}
      enablePartitioning: true
  exampleSubscription:
    type: azure:servicebus:Subscription
    properties:
      topicId: ${exampleTopic.id}
      maxDeliveryCount: 1
  exampleSubscriptionRule:
    type: azure:servicebus:SubscriptionRule
    properties:
      subscriptionId: ${exampleSubscription.id}
      filterType: CorrelationFilter
      correlationFilter:
        correlationId: high
        label: red
        properties:
          customProperty: value

Create SubscriptionRule Resource

new SubscriptionRule(name: string, args: SubscriptionRuleArgs, opts?: CustomResourceOptions);
@overload
def SubscriptionRule(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     action: Optional[str] = None,
                     correlation_filter: Optional[SubscriptionRuleCorrelationFilterArgs] = None,
                     filter_type: Optional[str] = None,
                     name: Optional[str] = None,
                     sql_filter: Optional[str] = None,
                     subscription_id: Optional[str] = None)
@overload
def SubscriptionRule(resource_name: str,
                     args: SubscriptionRuleArgs,
                     opts: Optional[ResourceOptions] = None)
func NewSubscriptionRule(ctx *Context, name string, args SubscriptionRuleArgs, opts ...ResourceOption) (*SubscriptionRule, error)
public SubscriptionRule(string name, SubscriptionRuleArgs args, CustomResourceOptions? opts = null)
public SubscriptionRule(String name, SubscriptionRuleArgs args)
public SubscriptionRule(String name, SubscriptionRuleArgs args, CustomResourceOptions options)

type: azure:servicebus:SubscriptionRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SubscriptionRuleArgs
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 SubscriptionRuleArgs
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 SubscriptionRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SubscriptionRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SubscriptionRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

SubscriptionRule 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 SubscriptionRule resource accepts the following input properties:

FilterType string

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

SubscriptionId string

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

Action string

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

CorrelationFilter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

Name string

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

SqlFilter string

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

FilterType string

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

SubscriptionId string

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

Action string

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

CorrelationFilter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

Name string

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

SqlFilter string

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

filterType String

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

subscriptionId String

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

action String

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlationFilter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

name String

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

sqlFilter String

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

filterType string

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

subscriptionId string

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

action string

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlationFilter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

name string

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

sqlFilter string

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

filter_type str

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

subscription_id str

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

action str

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlation_filter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

name str

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

sql_filter str

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

filterType String

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

subscriptionId String

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

action String

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlationFilter Property Map

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

name String

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

sqlFilter String

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

SqlFilterCompatibilityLevel int
Id string

The provider-assigned unique ID for this managed resource.

SqlFilterCompatibilityLevel int
id String

The provider-assigned unique ID for this managed resource.

sqlFilterCompatibilityLevel Integer
id string

The provider-assigned unique ID for this managed resource.

sqlFilterCompatibilityLevel number
id str

The provider-assigned unique ID for this managed resource.

sql_filter_compatibility_level int
id String

The provider-assigned unique ID for this managed resource.

sqlFilterCompatibilityLevel Number

Look up Existing SubscriptionRule Resource

Get an existing SubscriptionRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SubscriptionRuleState, opts?: CustomResourceOptions): SubscriptionRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        correlation_filter: Optional[SubscriptionRuleCorrelationFilterArgs] = None,
        filter_type: Optional[str] = None,
        name: Optional[str] = None,
        sql_filter: Optional[str] = None,
        sql_filter_compatibility_level: Optional[int] = None,
        subscription_id: Optional[str] = None) -> SubscriptionRule
func GetSubscriptionRule(ctx *Context, name string, id IDInput, state *SubscriptionRuleState, opts ...ResourceOption) (*SubscriptionRule, error)
public static SubscriptionRule Get(string name, Input<string> id, SubscriptionRuleState? state, CustomResourceOptions? opts = null)
public static SubscriptionRule get(String name, Output<String> id, SubscriptionRuleState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Action string

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

CorrelationFilter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

FilterType string

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

Name string

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

SqlFilter string

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

SqlFilterCompatibilityLevel int
SubscriptionId string

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

Action string

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

CorrelationFilter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

FilterType string

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

Name string

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

SqlFilter string

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

SqlFilterCompatibilityLevel int
SubscriptionId string

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

action String

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlationFilter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

filterType String

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

name String

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

sqlFilter String

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

sqlFilterCompatibilityLevel Integer
subscriptionId String

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

action string

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlationFilter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

filterType string

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

name string

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

sqlFilter string

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

sqlFilterCompatibilityLevel number
subscriptionId string

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

action str

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlation_filter SubscriptionRuleCorrelationFilterArgs

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

filter_type str

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

name str

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

sql_filter str

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

sql_filter_compatibility_level int
subscription_id str

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

action String

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlationFilter Property Map

A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

filterType String

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

name String

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

sqlFilter String

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

sqlFilterCompatibilityLevel Number
subscriptionId String

The ID of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

Supporting Types

SubscriptionRuleCorrelationFilter

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>

A list of user defined properties to be included in the filter. Specified as a map of name/value pairs.

ReplyTo string

Address of the queue to reply to.

ReplyToSessionId string

Session identifier to reply to.

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

A list of user defined properties to be included in the filter. Specified as a map of name/value pairs.

ReplyTo string

Address of the queue to reply to.

ReplyToSessionId string

Session identifier to reply to.

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>

A list of user defined properties to be included in the filter. Specified as a map of name/value pairs.

replyTo String

Address of the queue to reply to.

replyToSessionId String

Session identifier to reply to.

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}

A list of user defined properties to be included in the filter. Specified as a map of name/value pairs.

replyTo string

Address of the queue to reply to.

replyToSessionId string

Session identifier to reply to.

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]

A list of user defined properties to be included in the filter. Specified as a map of name/value pairs.

reply_to str

Address of the queue to reply to.

reply_to_session_id str

Session identifier to reply to.

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>

A list of user defined properties to be included in the filter. Specified as a map of name/value pairs.

replyTo String

Address of the queue to reply to.

replyToSessionId String

Session identifier to reply to.

sessionId String

Session identifier.

to String

Address to send to.

Import

Service Bus Subscription Rule can be imported using the resource id, e.g.

 $ pulumi import azure:servicebus/subscriptionRule:SubscriptionRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ServiceBus/namespaces/sbns1/topics/sntopic1/subscriptions/sbsub1/rules/sbrule1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.