Share via

WebApplicationFirewallCustomRule Class

  • Reference

Defines contents of a web application rule.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.network._serialization.Model
WebApplicationFirewallCustomRule

Constructor

WebApplicationFirewallCustomRule(*, priority: int, rule_type: str | _models.WebApplicationFirewallRuleType, match_conditions: List[_models.MatchCondition], action: str | _models.WebApplicationFirewallAction, name: str | None = None, state: str | _models.WebApplicationFirewallState | None = None, rate_limit_duration: str | _models.ApplicationGatewayFirewallRateLimitDuration | None = None, rate_limit_threshold: int | None = None, group_by_user_session: List[_models.GroupByUserSession] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The name of the resource that is unique within a policy. This name can be used to access the resource.
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", and "JSChallenge".

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", and "JSChallenge".