1. Packages
  2. Azure Native
  3. API Docs
  4. servicebus
  5. getRule
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.20.1 published on Friday, Dec 1, 2023 by Pulumi

azure-native.servicebus.getRule

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.20.1 published on Friday, Dec 1, 2023 by Pulumi

    Retrieves the description for the specified rule. Azure REST API version: 2022-01-01-preview.

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

    Using getRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
    function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>
    def get_rule(namespace_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 rule_name: Optional[str] = None,
                 subscription_name: Optional[str] = None,
                 topic_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetRuleResult
    def get_rule_output(namespace_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 rule_name: Optional[pulumi.Input[str]] = None,
                 subscription_name: Optional[pulumi.Input[str]] = None,
                 topic_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]
    func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
    func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

    > Note: This function is named LookupRule in the Go SDK.

    public static class GetRule 
    {
        public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:servicebus:getRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    NamespaceName string

    The namespace name

    ResourceGroupName string

    Name of the Resource group within the Azure subscription.

    RuleName string

    The rule name.

    SubscriptionName string

    The subscription name.

    TopicName string

    The topic name.

    NamespaceName string

    The namespace name

    ResourceGroupName string

    Name of the Resource group within the Azure subscription.

    RuleName string

    The rule name.

    SubscriptionName string

    The subscription name.

    TopicName string

    The topic name.

    namespaceName String

    The namespace name

    resourceGroupName String

    Name of the Resource group within the Azure subscription.

    ruleName String

    The rule name.

    subscriptionName String

    The subscription name.

    topicName String

    The topic name.

    namespaceName string

    The namespace name

    resourceGroupName string

    Name of the Resource group within the Azure subscription.

    ruleName string

    The rule name.

    subscriptionName string

    The subscription name.

    topicName string

    The topic name.

    namespace_name str

    The namespace name

    resource_group_name str

    Name of the Resource group within the Azure subscription.

    rule_name str

    The rule name.

    subscription_name str

    The subscription name.

    topic_name str

    The topic name.

    namespaceName String

    The namespace name

    resourceGroupName String

    Name of the Resource group within the Azure subscription.

    ruleName String

    The rule name.

    subscriptionName String

    The subscription name.

    topicName String

    The topic name.

    getRule Result

    The following output properties are available:

    Id string

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    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"

    Action Pulumi.AzureNative.ServiceBus.Outputs.ActionResponse

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

    Properties of correlationFilter

    FilterType string

    Filter type that is evaluated against a BrokeredMessage.

    SqlFilter Pulumi.AzureNative.ServiceBus.Outputs.SqlFilterResponse

    Properties of sqlFilter

    Id string

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    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"

    Action ActionResponse

    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.

    CorrelationFilter CorrelationFilterResponse

    Properties of correlationFilter

    FilterType string

    Filter type that is evaluated against a BrokeredMessage.

    SqlFilter SqlFilterResponse

    Properties of sqlFilter

    id String

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    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"

    action ActionResponse

    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.

    correlationFilter CorrelationFilterResponse

    Properties of correlationFilter

    filterType String

    Filter type that is evaluated against a BrokeredMessage.

    sqlFilter SqlFilterResponse

    Properties of sqlFilter

    id string

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    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"

    action ActionResponse

    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.

    correlationFilter CorrelationFilterResponse

    Properties of correlationFilter

    filterType string

    Filter type that is evaluated against a BrokeredMessage.

    sqlFilter SqlFilterResponse

    Properties of sqlFilter

    id str

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    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"

    action ActionResponse

    Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.

    correlation_filter CorrelationFilterResponse

    Properties of correlationFilter

    filter_type str

    Filter type that is evaluated against a BrokeredMessage.

    sql_filter SqlFilterResponse

    Properties of sqlFilter

    id String

    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

    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"

    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

    Filter type that is evaluated against a BrokeredMessage.

    sqlFilter Property Map

    Properties of sqlFilter

    Supporting Types

    ActionResponse

    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'

    CorrelationFilterResponse

    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.

    SqlFilterResponse

    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

    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.

    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.20.1 published on Friday, Dec 1, 2023 by Pulumi