WebApplicationFirewallCustomRule Class

Defines contents of a web application rule.

Constructor

WebApplicationFirewallCustomRule(*args: Any, **kwargs: Any)

Variables

Name	Description
name	str The name of the resource that is unique within a policy. This name can be used to access the resource.
etag	str A unique read-only string that changes whenever the resource is updated.
priority	int Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. Required.
state	str or WebApplicationFirewallState Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: "Disabled" and "Enabled".
rate_limit_duration	str or ApplicationGatewayFirewallRateLimitDuration Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule. Known values are: "OneMin" and "FiveMins".
rate_limit_threshold	int Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1.
rule_type	str or WebApplicationFirewallRuleType The rule type. Required. Known values are: "MatchRule", "RateLimitRule", and "Invalid".
match_conditions	list[MatchCondition] List of match conditions. Required.
group_by_user_session	list[GroupByUserSession] List of user session identifier group by clauses.
action	str or WebApplicationFirewallAction Type of Actions. Required. Known values are: "Allow", "Block", "Log", "JSChallenge", and "CAPTCHA".

Attributes

action

"Allow", "Block", "Log", "JSChallenge", and "CAPTCHA".

action: str | _models.WebApplicationFirewallAction

etag

A unique read-only string that changes whenever the resource is updated.

etag: str | None

group_by_user_session

List of user session identifier group by clauses.

group_by_user_session: list['_models.GroupByUserSession'] | None

match_conditions

List of match conditions. Required.

match_conditions: list['_models.MatchCondition']

name

The name of the resource that is unique within a policy. This name can be used to access the resource.

name: str | None

priority

Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. Required.

priority: int

rate_limit_duration

Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule. Known values are: "OneMin" and "FiveMins".

rate_limit_duration: str | _models.ApplicationGatewayFirewallRateLimitDuration | None

rate_limit_threshold

Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1.

rate_limit_threshold: int | None

rule_type

"MatchRule", "RateLimitRule", and "Invalid".

rule_type: str | _models.WebApplicationFirewallRuleType

state

Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: "Disabled" and "Enabled".

state: str | _models.WebApplicationFirewallState | None