azure-native.servicebus.getRule
Explore with Pulumi AI
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:
- Namespace
Name string The namespace name
- Resource
Group stringName Name of the Resource group within the Azure subscription.
- Rule
Name string The rule name.
- Subscription
Name string The subscription name.
- Topic
Name string The topic name.
- Namespace
Name string The namespace name
- Resource
Group stringName Name of the Resource group within the Azure subscription.
- Rule
Name string The rule name.
- Subscription
Name string The subscription name.
- Topic
Name string The topic name.
- namespace
Name String The namespace name
- resource
Group StringName Name of the Resource group within the Azure subscription.
- rule
Name String The rule name.
- subscription
Name String The subscription name.
- topic
Name String The topic name.
- namespace
Name string The namespace name
- resource
Group stringName Name of the Resource group within the Azure subscription.
- rule
Name string The rule name.
- subscription
Name string The subscription name.
- topic
Name string The topic name.
- namespace_
name str The namespace name
- resource_
group_ strname 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.
- namespace
Name String The namespace name
- resource
Group StringName Name of the Resource group within the Azure subscription.
- rule
Name String The rule name.
- subscription
Name String The subscription name.
- topic
Name 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
- System
Data Pulumi.Azure Native. Service Bus. Outputs. System Data Response 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.
Azure Native. Service Bus. Outputs. Action Response Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
- Correlation
Filter Pulumi.Azure Native. Service Bus. Outputs. Correlation Filter Response Properties of correlationFilter
- Filter
Type string Filter type that is evaluated against a BrokeredMessage.
- Sql
Filter Pulumi.Azure Native. Service Bus. Outputs. Sql Filter Response 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
- System
Data SystemData Response 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
Action
Response Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
- Correlation
Filter CorrelationFilter Response Properties of correlationFilter
- Filter
Type string Filter type that is evaluated against a BrokeredMessage.
- Sql
Filter SqlFilter Response 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
- system
Data SystemData Response 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
Action
Response Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
- correlation
Filter CorrelationFilter Response Properties of correlationFilter
- filter
Type String Filter type that is evaluated against a BrokeredMessage.
- sql
Filter SqlFilter Response 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
- system
Data SystemData Response 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
Action
Response Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
- correlation
Filter CorrelationFilter Response Properties of correlationFilter
- filter
Type string Filter type that is evaluated against a BrokeredMessage.
- sql
Filter SqlFilter Response 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 SystemData Response 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
Action
Response Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
- correlation_
filter CorrelationFilter Response Properties of correlationFilter
- filter_
type str Filter type that is evaluated against a BrokeredMessage.
- sql_
filter SqlFilter Response 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
- system
Data 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.
- correlation
Filter Property Map Properties of correlationFilter
- filter
Type String Filter type that is evaluated against a BrokeredMessage.
- sql
Filter Property Map Properties of sqlFilter
Supporting Types
ActionResponse
- 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 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 string SQL expression. e.g. MyProperty='ABC'
- compatibility
Level Integer This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
- requires
Preprocessing Boolean Value that indicates whether the rule action requires preprocessing.
- sql
Expression String SQL expression. e.g. MyProperty='ABC'
- compatibility
Level number This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
- requires
Preprocessing boolean Value that indicates whether the rule action requires preprocessing.
- sql
Expression 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'
- compatibility
Level Number This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
- requires
Preprocessing Boolean Value that indicates whether the rule action requires preprocessing.
- sql
Expression String SQL expression. e.g. MyProperty='ABC'
CorrelationFilterResponse
- Content
Type string Content type of the message.
- Correlation
Id string Identifier of the correlation.
- Label string
Application specific label.
- Message
Id string Identifier of the message.
- Properties Dictionary<string, string>
dictionary object for custom filters
- Reply
To string Address of the queue to reply to.
- Reply
To stringSession Id Session identifier to reply to.
- Requires
Preprocessing bool Value that indicates whether the rule action requires preprocessing.
- Session
Id string Session identifier.
- To string
Address to send to.
- Content
Type string Content type of the message.
- Correlation
Id string Identifier of the correlation.
- Label string
Application specific label.
- Message
Id string Identifier of the message.
- Properties map[string]string
dictionary object for custom filters
- Reply
To string Address of the queue to reply to.
- Reply
To stringSession Id Session identifier to reply to.
- Requires
Preprocessing bool Value that indicates whether the rule action requires preprocessing.
- Session
Id string Session identifier.
- To string
Address to send to.
- content
Type String Content type of the message.
- correlation
Id String Identifier of the correlation.
- label String
Application specific label.
- message
Id String Identifier of the message.
- properties Map<String,String>
dictionary object for custom filters
- reply
To String Address of the queue to reply to.
- reply
To StringSession Id Session identifier to reply to.
- requires
Preprocessing Boolean Value that indicates whether the rule action requires preprocessing.
- session
Id String Session identifier.
- to String
Address to send to.
- content
Type string Content type of the message.
- correlation
Id string Identifier of the correlation.
- label string
Application specific label.
- message
Id string Identifier of the message.
- properties {[key: string]: string}
dictionary object for custom filters
- reply
To string Address of the queue to reply to.
- reply
To stringSession Id Session identifier to reply to.
- requires
Preprocessing boolean Value that indicates whether the rule action requires preprocessing.
- session
Id 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_ strsession_ id 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.
- content
Type String Content type of the message.
- correlation
Id String Identifier of the correlation.
- label String
Application specific label.
- message
Id String Identifier of the message.
- properties Map<String>
dictionary object for custom filters
- reply
To String Address of the queue to reply to.
- reply
To StringSession Id Session identifier to reply to.
- requires
Preprocessing Boolean Value that indicates whether the rule action requires preprocessing.
- session
Id String Session identifier.
- to String
Address to send to.
SqlFilterResponse
- 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 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 string The SQL expression. e.g. MyProperty='ABC'
- compatibility
Level Integer This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
- requires
Preprocessing Boolean Value that indicates whether the rule action requires preprocessing.
- sql
Expression String The SQL expression. e.g. MyProperty='ABC'
- compatibility
Level number This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
- requires
Preprocessing boolean Value that indicates whether the rule action requires preprocessing.
- sql
Expression 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'
- compatibility
Level Number This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
- requires
Preprocessing Boolean Value that indicates whether the rule action requires preprocessing.
- sql
Expression String The SQL expression. e.g. MyProperty='ABC'
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The type of identity that last modified the resource.
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The type of identity that last modified the resource.
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The type of identity that last modified the resource.
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The type of identity that last modified the resource.
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type 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_ strtype The type of identity that created the resource.
- last_
modified_ strat The type of identity that last modified the resource.
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The type of identity that last modified the resource.
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0