Azure Native v1.103.0, Jun 2 23

azure-native.servicebus.getRule

Explore with Pulumi AI

Retrieves the description for the specified rule. API Version: 2017-04-01.

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: Resource Id
Name string: Resource name
Type string: Resource type
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: Resource Id
Name string: Resource name
Type string: Resource type
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: Resource Id
name String: Resource name
type String: Resource type
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: Resource Id
name string: Resource name
type string: Resource type
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: Resource Id
name str: Resource name
type str: Resource type
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: Resource Id
name String: Resource name
type String: Resource type
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'

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0