Azure Native v2.89.1, Mar 2 25

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.network.getRulesEngine

Explore with Pulumi AI

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

Using getRulesEngine

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 getRulesEngine(args: GetRulesEngineArgs, opts?: InvokeOptions): Promise<GetRulesEngineResult>
function getRulesEngineOutput(args: GetRulesEngineOutputArgs, opts?: InvokeOptions): Output<GetRulesEngineResult>

def get_rules_engine(front_door_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     rules_engine_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRulesEngineResult
def get_rules_engine_output(front_door_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     rules_engine_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRulesEngineResult]

func LookupRulesEngine(ctx *Context, args *LookupRulesEngineArgs, opts ...InvokeOption) (*LookupRulesEngineResult, error)
func LookupRulesEngineOutput(ctx *Context, args *LookupRulesEngineOutputArgs, opts ...InvokeOption) LookupRulesEngineResultOutput

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

public static class GetRulesEngine 
{
    public static Task<GetRulesEngineResult> InvokeAsync(GetRulesEngineArgs args, InvokeOptions? opts = null)
    public static Output<GetRulesEngineResult> Invoke(GetRulesEngineInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRulesEngineResult> getRulesEngine(GetRulesEngineArgs args, InvokeOptions options)
public static Output<GetRulesEngineResult> getRulesEngine(GetRulesEngineArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:network:getRulesEngine
  arguments:
    # arguments dictionary

The following arguments are supported:

FrontDoorName string: Name of the Front Door which is globally unique.
ResourceGroupName string: Name of the Resource group within the Azure subscription.
RulesEngineName string: Name of the Rules Engine which is unique within the Front Door.

FrontDoorName string: Name of the Front Door which is globally unique.
ResourceGroupName string: Name of the Resource group within the Azure subscription.
RulesEngineName string: Name of the Rules Engine which is unique within the Front Door.

frontDoorName String: Name of the Front Door which is globally unique.
resourceGroupName String: Name of the Resource group within the Azure subscription.
rulesEngineName String: Name of the Rules Engine which is unique within the Front Door.

frontDoorName string: Name of the Front Door which is globally unique.
resourceGroupName string: Name of the Resource group within the Azure subscription.
rulesEngineName string: Name of the Rules Engine which is unique within the Front Door.

front_door_name str: Name of the Front Door which is globally unique.
resource_group_name str: Name of the Resource group within the Azure subscription.
rules_engine_name str: Name of the Rules Engine which is unique within the Front Door.

frontDoorName String: Name of the Front Door which is globally unique.
resourceGroupName String: Name of the Resource group within the Azure subscription.
rulesEngineName String: Name of the Rules Engine which is unique within the Front Door.

getRulesEngine Result

The following output properties are available:

Id string: Resource ID.
Name string: Resource name.
ResourceState string: Resource status.
Type string: Resource type.
Rules List<Pulumi.AzureNative.Network.Outputs.RulesEngineRuleResponse>: A list of rules that define a particular Rules Engine Configuration.

Id string: Resource ID.
Name string: Resource name.
ResourceState string: Resource status.
Type string: Resource type.
Rules []RulesEngineRuleResponse: A list of rules that define a particular Rules Engine Configuration.

id String: Resource ID.
name String: Resource name.
resourceState String: Resource status.
type String: Resource type.
rules List<RulesEngineRuleResponse>: A list of rules that define a particular Rules Engine Configuration.

id string: Resource ID.
name string: Resource name.
resourceState string: Resource status.
type string: Resource type.
rules RulesEngineRuleResponse[]: A list of rules that define a particular Rules Engine Configuration.

id str: Resource ID.
name str: Resource name.
resource_state str: Resource status.
type str: Resource type.
rules Sequence[RulesEngineRuleResponse]: A list of rules that define a particular Rules Engine Configuration.

id String: Resource ID.
name String: Resource name.
resourceState String: Resource status.
type String: Resource type.
rules List<Property Map>: A list of rules that define a particular Rules Engine Configuration.

Supporting Types

CacheConfigurationResponse

CacheDuration string: The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year
DynamicCompression string: Whether to use dynamic compression for cached content
QueryParameterStripDirective string: Treatment of URL query terms when forming the cache key.
QueryParameters string: query parameters to include or exclude (comma separated).

CacheDuration string: The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year
DynamicCompression string: Whether to use dynamic compression for cached content
QueryParameterStripDirective string: Treatment of URL query terms when forming the cache key.
QueryParameters string: query parameters to include or exclude (comma separated).

cacheDuration String: The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year
dynamicCompression String: Whether to use dynamic compression for cached content
queryParameterStripDirective String: Treatment of URL query terms when forming the cache key.
queryParameters String: query parameters to include or exclude (comma separated).

cacheDuration string: The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year
dynamicCompression string: Whether to use dynamic compression for cached content
queryParameterStripDirective string: Treatment of URL query terms when forming the cache key.
queryParameters string: query parameters to include or exclude (comma separated).

cache_duration str: The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year
dynamic_compression str: Whether to use dynamic compression for cached content
query_parameter_strip_directive str: Treatment of URL query terms when forming the cache key.
query_parameters str: query parameters to include or exclude (comma separated).

cacheDuration String: The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year
dynamicCompression String: Whether to use dynamic compression for cached content
queryParameterStripDirective String: Treatment of URL query terms when forming the cache key.
queryParameters String: query parameters to include or exclude (comma separated).

ForwardingConfigurationResponse

BackendPool Pulumi.AzureNative.Network.Inputs.SubResourceResponse: A reference to the BackendPool which this rule routes to.
CacheConfiguration Pulumi.AzureNative.Network.Inputs.CacheConfigurationResponse: The caching configuration associated with this rule.
CustomForwardingPath string: A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
ForwardingProtocol string: Protocol this rule will use when forwarding traffic to backends.

BackendPool SubResourceResponse: A reference to the BackendPool which this rule routes to.
CacheConfiguration CacheConfigurationResponse: The caching configuration associated with this rule.
CustomForwardingPath string: A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
ForwardingProtocol string: Protocol this rule will use when forwarding traffic to backends.

backendPool SubResourceResponse: A reference to the BackendPool which this rule routes to.
cacheConfiguration CacheConfigurationResponse: The caching configuration associated with this rule.
customForwardingPath String: A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
forwardingProtocol String: Protocol this rule will use when forwarding traffic to backends.

backendPool SubResourceResponse: A reference to the BackendPool which this rule routes to.
cacheConfiguration CacheConfigurationResponse: The caching configuration associated with this rule.
customForwardingPath string: A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
forwardingProtocol string: Protocol this rule will use when forwarding traffic to backends.

backend_pool SubResourceResponse: A reference to the BackendPool which this rule routes to.
cache_configuration CacheConfigurationResponse: The caching configuration associated with this rule.
custom_forwarding_path str: A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
forwarding_protocol str: Protocol this rule will use when forwarding traffic to backends.

backendPool Property Map: A reference to the BackendPool which this rule routes to.
cacheConfiguration Property Map: The caching configuration associated with this rule.
customForwardingPath String: A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
forwardingProtocol String: Protocol this rule will use when forwarding traffic to backends.

HeaderActionResponse

HeaderActionType string: Which type of manipulation to apply to the header.
HeaderName string: The name of the header this action will apply to.
Value string: The value to update the given header name with. This value is not used if the actionType is Delete.

HeaderActionType string: Which type of manipulation to apply to the header.
HeaderName string: The name of the header this action will apply to.
Value string: The value to update the given header name with. This value is not used if the actionType is Delete.

headerActionType String: Which type of manipulation to apply to the header.
headerName String: The name of the header this action will apply to.
value String: The value to update the given header name with. This value is not used if the actionType is Delete.

headerActionType string: Which type of manipulation to apply to the header.
headerName string: The name of the header this action will apply to.
value string: The value to update the given header name with. This value is not used if the actionType is Delete.

header_action_type str: Which type of manipulation to apply to the header.
header_name str: The name of the header this action will apply to.
value str: The value to update the given header name with. This value is not used if the actionType is Delete.

headerActionType String: Which type of manipulation to apply to the header.
headerName String: The name of the header this action will apply to.
value String: The value to update the given header name with. This value is not used if the actionType is Delete.

RedirectConfigurationResponse

CustomFragment string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
CustomHost string: Host to redirect. Leave empty to use the incoming host as the destination host.
CustomPath string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
CustomQueryString string: The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
RedirectProtocol string: The protocol of the destination to where the traffic is redirected
RedirectType string: The redirect type the rule will use when redirecting traffic.

CustomFragment string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
CustomHost string: Host to redirect. Leave empty to use the incoming host as the destination host.
CustomPath string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
CustomQueryString string: The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
RedirectProtocol string: The protocol of the destination to where the traffic is redirected
RedirectType string: The redirect type the rule will use when redirecting traffic.

customFragment String: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
customHost String: Host to redirect. Leave empty to use the incoming host as the destination host.
customPath String: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
customQueryString String: The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
redirectProtocol String: The protocol of the destination to where the traffic is redirected
redirectType String: The redirect type the rule will use when redirecting traffic.

customFragment string: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
customHost string: Host to redirect. Leave empty to use the incoming host as the destination host.
customPath string: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
customQueryString string: The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
redirectProtocol string: The protocol of the destination to where the traffic is redirected
redirectType string: The redirect type the rule will use when redirecting traffic.

custom_fragment str: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
custom_host str: Host to redirect. Leave empty to use the incoming host as the destination host.
custom_path str: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
custom_query_string str: The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
redirect_protocol str: The protocol of the destination to where the traffic is redirected
redirect_type str: The redirect type the rule will use when redirecting traffic.

customFragment String: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
customHost String: Host to redirect. Leave empty to use the incoming host as the destination host.
customPath String: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
customQueryString String: The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.
redirectProtocol String: The protocol of the destination to where the traffic is redirected
redirectType String: The redirect type the rule will use when redirecting traffic.

RulesEngineActionResponse

RequestHeaderActions List<Pulumi.AzureNative.Network.Inputs.HeaderActionResponse>: A list of header actions to apply from the request from AFD to the origin.
ResponseHeaderActions List<Pulumi.AzureNative.Network.Inputs.HeaderActionResponse>: A list of header actions to apply from the response from AFD to the client.
RouteConfigurationOverride Pulumi.AzureNative.Network.Inputs.ForwardingConfigurationResponse | Pulumi.AzureNative.Network.Inputs.RedirectConfigurationResponse: Override the route configuration.

RequestHeaderActions []HeaderActionResponse: A list of header actions to apply from the request from AFD to the origin.
ResponseHeaderActions []HeaderActionResponse: A list of header actions to apply from the response from AFD to the client.
RouteConfigurationOverride ForwardingConfigurationResponse | RedirectConfigurationResponse: Override the route configuration.

requestHeaderActions List<HeaderActionResponse>: A list of header actions to apply from the request from AFD to the origin.
responseHeaderActions List<HeaderActionResponse>: A list of header actions to apply from the response from AFD to the client.
routeConfigurationOverride ForwardingConfigurationResponse | RedirectConfigurationResponse: Override the route configuration.

requestHeaderActions HeaderActionResponse[]: A list of header actions to apply from the request from AFD to the origin.
responseHeaderActions HeaderActionResponse[]: A list of header actions to apply from the response from AFD to the client.
routeConfigurationOverride ForwardingConfigurationResponse | RedirectConfigurationResponse: Override the route configuration.

request_header_actions Sequence[HeaderActionResponse]: A list of header actions to apply from the request from AFD to the origin.
response_header_actions Sequence[HeaderActionResponse]: A list of header actions to apply from the response from AFD to the client.
route_configuration_override ForwardingConfigurationResponse | RedirectConfigurationResponse: Override the route configuration.

requestHeaderActions List<Property Map>: A list of header actions to apply from the request from AFD to the origin.
responseHeaderActions List<Property Map>: A list of header actions to apply from the response from AFD to the client.
routeConfigurationOverride Property Map | Property Map: Override the route configuration.

RulesEngineMatchConditionResponse

RulesEngineMatchValue List<string>: Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
RulesEngineMatchVariable string: Match Variable
RulesEngineOperator string: Describes operator to apply to the match condition.
NegateCondition bool: Describes if this is negate condition or not
Selector string: Name of selector in RequestHeader or RequestBody to be matched
Transforms List<string>: List of transforms

RulesEngineMatchValue []string: Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
RulesEngineMatchVariable string: Match Variable
RulesEngineOperator string: Describes operator to apply to the match condition.
NegateCondition bool: Describes if this is negate condition or not
Selector string: Name of selector in RequestHeader or RequestBody to be matched
Transforms []string: List of transforms

rulesEngineMatchValue List<String>: Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
rulesEngineMatchVariable String: Match Variable
rulesEngineOperator String: Describes operator to apply to the match condition.
negateCondition Boolean: Describes if this is negate condition or not
selector String: Name of selector in RequestHeader or RequestBody to be matched
transforms List<String>: List of transforms

rulesEngineMatchValue string[]: Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
rulesEngineMatchVariable string: Match Variable
rulesEngineOperator string: Describes operator to apply to the match condition.
negateCondition boolean: Describes if this is negate condition or not
selector string: Name of selector in RequestHeader or RequestBody to be matched
transforms string[]: List of transforms

rules_engine_match_value Sequence[str]: Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
rules_engine_match_variable str: Match Variable
rules_engine_operator str: Describes operator to apply to the match condition.
negate_condition bool: Describes if this is negate condition or not
selector str: Name of selector in RequestHeader or RequestBody to be matched
transforms Sequence[str]: List of transforms

rulesEngineMatchValue List<String>: Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
rulesEngineMatchVariable String: Match Variable
rulesEngineOperator String: Describes operator to apply to the match condition.
negateCondition Boolean: Describes if this is negate condition or not
selector String: Name of selector in RequestHeader or RequestBody to be matched
transforms List<String>: List of transforms

RulesEngineRuleResponse

Action Pulumi.AzureNative.Network.Inputs.RulesEngineActionResponse: Actions to perform on the request and response if all of the match conditions are met.
Name string: A name to refer to this specific rule.
Priority int: A priority assigned to this rule.
MatchConditions List<Pulumi.AzureNative.Network.Inputs.RulesEngineMatchConditionResponse>: A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
MatchProcessingBehavior string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

Action RulesEngineActionResponse: Actions to perform on the request and response if all of the match conditions are met.
Name string: A name to refer to this specific rule.
Priority int: A priority assigned to this rule.
MatchConditions []RulesEngineMatchConditionResponse: A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
MatchProcessingBehavior string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

action RulesEngineActionResponse: Actions to perform on the request and response if all of the match conditions are met.
name String: A name to refer to this specific rule.
priority Integer: A priority assigned to this rule.
matchConditions List<RulesEngineMatchConditionResponse>: A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
matchProcessingBehavior String: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

action RulesEngineActionResponse: Actions to perform on the request and response if all of the match conditions are met.
name string: A name to refer to this specific rule.
priority number: A priority assigned to this rule.
matchConditions RulesEngineMatchConditionResponse[]: A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
matchProcessingBehavior string: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

action RulesEngineActionResponse: Actions to perform on the request and response if all of the match conditions are met.
name str: A name to refer to this specific rule.
priority int: A priority assigned to this rule.
match_conditions Sequence[RulesEngineMatchConditionResponse]: A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
match_processing_behavior str: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

action Property Map: Actions to perform on the request and response if all of the match conditions are met.
name String: A name to refer to this specific rule.
priority Number: A priority assigned to this rule.
matchConditions List<Property Map>: A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.
matchProcessingBehavior String: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

SubResourceResponse

Id string: Resource ID.

Id string: Resource ID.

id String: Resource ID.

id string: Resource ID.

id str: Resource ID.

id String: Resource ID.

Package Details

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

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.network.getRulesEngine

On this page

On this page

Using getRulesEngine

getRulesEngine Result

Supporting Types

CacheConfigurationResponse

ForwardingConfigurationResponse

HeaderActionResponse

RedirectConfigurationResponse

RulesEngineActionResponse

RulesEngineMatchConditionResponse

RulesEngineRuleResponse

SubResourceResponse

Package Details

On this page

On this page