CustomRule Class

Defines the common attributes for a custom rule that can be included in a waf policy.

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

Constructor

CustomRule(*, name: str, priority: int, match_conditions: List[_models.MatchCondition], action: str | _models.ActionType, enabled_state: str | _models.CustomRuleEnabledState | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str Defines the name of the custom rule. Required.
enabled_state	str or CustomRuleEnabledState Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: "Disabled" and "Enabled".
priority	int Defines in what order this rule be evaluated in the overall list of custom rules. Required.
match_conditions	list[MatchCondition] List of match conditions. Required.
action	str or ActionType Describes what action to be applied when rule matches. Required. Known values are: "Allow", "Block", "Log", and "Redirect".

Variables

Name	Description
name	str Defines the name of the custom rule. Required.
enabled_state	str or CustomRuleEnabledState Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values are: "Disabled" and "Enabled".
priority	int Defines in what order this rule be evaluated in the overall list of custom rules. Required.
match_conditions	list[MatchCondition] List of match conditions. Required.
action	str or ActionType Describes what action to be applied when rule matches. Required. Known values are: "Allow", "Block", "Log", and "Redirect".