Share via

CustomRule interface

Package:
@azure/arm-frontdoor

Defines contents of a web application rule

Properties

action

Describes what action to be applied when rule matches.
enabledState

Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.
groupBy

Describes the list of variables to group the rate limit requests
matchConditions

List of match conditions.
name

Describes the name of the rule.
priority

Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.
rateLimitDurationInMinutes

Time window for resetting the rate limit count. Default is 1 minute.
rateLimitThreshold

Number of allowed requests per client within the time window.
ruleType

Describes type of rule.

Property Details

action

Describes what action to be applied when rule matches.

action: string

Property Value

string

enabledState

Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.

enabledState?: string

Property Value

string

groupBy

Describes the list of variables to group the rate limit requests

groupBy?: GroupByVariable[]

Property Value

GroupByVariable[]

matchConditions

List of match conditions.

matchConditions: MatchCondition[]

Property Value

MatchCondition[]

name

Describes the name of the rule.

name?: string

Property Value

string

priority

Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.

priority: number

Property Value

number

rateLimitDurationInMinutes

Time window for resetting the rate limit count. Default is 1 minute.

rateLimitDurationInMinutes?: number

Property Value

number

rateLimitThreshold

Number of allowed requests per client within the time window.

rateLimitThreshold?: number

Property Value

number

ruleType

Describes type of rule.

ruleType: string

Property Value

string