PolicySettings Class

Defines contents of a web application firewall global configuration.

Inheritance
azure.mgmt.network._serialization.Model
PolicySettings

Constructor

PolicySettings(*, state: str | _models.WebApplicationFirewallEnabledState | None = None, mode: str | _models.WebApplicationFirewallMode | None = None, request_body_check: bool | None = None, request_body_inspect_limit_in_kb: int | None = None, request_body_enforcement: bool = True, max_request_body_size_in_kb: int | None = None, file_upload_enforcement: bool = True, file_upload_limit_in_mb: int | None = None, custom_block_response_status_code: int | None = None, custom_block_response_body: str | None = None, log_scrubbing: _models.PolicySettingsLogScrubbing | None = None, js_challenge_cookie_expiration_in_mins: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
state

The state of the policy. Known values are: "Disabled" and "Enabled".

mode

The mode of the policy. Known values are: "Prevention" and "Detection".

request_body_check

Whether to allow WAF to check request Body.

request_body_inspect_limit_in_kb
int

Max inspection limit in KB for request body inspection for WAF.

request_body_enforcement

Whether allow WAF to enforce request body limits.

Default value: True
max_request_body_size_in_kb
int

Maximum request body size in Kb for WAF.

file_upload_enforcement

Whether allow WAF to enforce file upload limits.

Default value: True
file_upload_limit_in_mb
int

Maximum file upload size in Mb for WAF.

custom_block_response_status_code
int

If the action type is block, customer can override the response status code.

custom_block_response_body
str

If the action type is block, customer can override the response body. The body must be specified in base64 encoding.

log_scrubbing

To scrub sensitive log fields.

js_challenge_cookie_expiration_in_mins
int

Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes.

Variables

Name Description
state

The state of the policy. Known values are: "Disabled" and "Enabled".

mode

The mode of the policy. Known values are: "Prevention" and "Detection".

request_body_check

Whether to allow WAF to check request Body.

request_body_inspect_limit_in_kb
int

Max inspection limit in KB for request body inspection for WAF.

request_body_enforcement

Whether allow WAF to enforce request body limits.

max_request_body_size_in_kb
int

Maximum request body size in Kb for WAF.

file_upload_enforcement

Whether allow WAF to enforce file upload limits.

file_upload_limit_in_mb
int

Maximum file upload size in Mb for WAF.

custom_block_response_status_code
int

If the action type is block, customer can override the response status code.

custom_block_response_body
str

If the action type is block, customer can override the response body. The body must be specified in base64 encoding.

log_scrubbing

To scrub sensitive log fields.

js_challenge_cookie_expiration_in_mins
int

Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes.