Microsoft.Network (stable:2025-03-01)

2025/04/25 • 7 new methods

Policies_List (new)
Description :  Lists all of the protection policies within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of WebApplicationFirewallPolicies within a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of WebApplicationFirewallPolicy objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_ListBySubscription (new)
Description :  Lists all of the protection policies within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of WebApplicationFirewallPolicies within a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of WebApplicationFirewallPolicy objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Policies_Get (new)
Description :  Retrieve protection policy with specified name within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the Web Application Firewall Policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_CreateOrUpdate (new)
Description :  Create or update policy with specified rule set name within a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the Web Application Firewall Policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: Policy to be created. ,
Required: True ,
}
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_Update (new)
Description :  Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the Web Application Firewall Policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: FrontdoorWebApplicationFirewallPolicy parameters to be patched. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_Delete (new)
Description :  Deletes Policy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the Web Application Firewall Policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
ManagedRuleSets_List (new)
Description :  Lists all available managed rule sets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of managed rule set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a managed rule set definition. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the managed rule set. ,
Required: False ,
}
string ,
ruleSetId:
{
Description: Id of the managed rule set. ,
Required: False ,
}
string ,
ruleSetType:
{
Description: Type of the managed rule set. ,
Required: False ,
}
string ,
ruleSetVersion:
{
Description: Version of the managed rule set type. ,
Required: False ,
}
string ,
ruleGroups:
{
Description: Rule groups of the managed rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Name of the managed rule group. ,
Required: False ,
}
string ,
description:
{
Description: Description of the managed rule group. ,
Required: False ,
}
string ,
rules:
{
Description: List of rules within the managed rule group. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: False ,
}
string ,
defaultState:
{
Description: Describes the default state for the managed rule. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
defaultAction:
{
Description: Describes the default action to be applied when the managed rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the functionality of the managed rule. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve next set of managed rule set definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}