pulumi-azure-kotlin/com.pulumi.azure.eventhub.kotlin/SubscriptionRule

SubscriptionRule

class ~~SubscriptionRule~~ : KotlinCustomResource

Deprecated

azure.eventhub.SubscriptionRule has been deprecated in favor of azure.servicebus.SubscriptionRule

Manages a ServiceBus Subscription Rule.

Example Usage

SQL Filter)

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

Correlation Filter)

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

Import

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

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

Properties

action

val action: Output<String>?

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

correlationFilter

val correlationFilter: Output<SubscriptionRuleCorrelationFilter>?

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

filterType

val filterType: Output<String>

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

val id: Output<String>

name

val name: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

sqlFilter

val sqlFilter: Output<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

val sqlFilterCompatibilityLevel: Output<Int>

subscriptionId

val subscriptionId: Output<String>

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

urn

val urn: Output<String>