Share via

RateLimitRule Class

  • Reference

Defines a rate limiting rule that can be included in a waf policy.

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

Inheritance
azure.mgmt.cdn.models._models_py3.CustomRule
RateLimitRule

Constructor

RateLimitRule(*, name: str, priority: int, match_conditions: List[_models.MatchCondition], action: str | _models.ActionType, rate_limit_threshold: int, rate_limit_duration_in_minutes: int, 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".
rate_limit_threshold
int

Defines rate limit threshold. Required.
rate_limit_duration_in_minutes
int

Defines rate limit duration. Default is 1 minute. Required.

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".
rate_limit_threshold
int

Defines rate limit threshold. Required.
rate_limit_duration_in_minutes
int

Defines rate limit duration. Default is 1 minute. Required.