Managed Rule Sets - List
Lists all available managed rule sets.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets?api-version=2022-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client API version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success. The operation returns a list of all available web application firewall managed rule sets. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
List Policies ManagedRuleSets in a Resource Group
Sample request
Sample response
{
"value": [
{
"name": "DefaultRuleSet_1.0",
"id": "/subscriptions/subid/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets",
"type": "Microsoft.Network/frontdoorwebapplicationfirewallmanagedrulesets",
"properties": {
"provisioningState": "Succeeded",
"ruleSetId": "8125d145-ddc5-4d90-9bc3-24c5f2de69a2",
"ruleSetType": "DefaultRuleSet",
"ruleSetVersion": "1.0",
"ruleGroups": [
{
"ruleGroupName": "SQLI",
"description": "SQL injection",
"rules": [
{
"ruleId": "942100",
"description": "SQL Injection Attack Detected via libinjection",
"defaultState": "Enabled",
"defaultAction": "Block"
},
{
"ruleId": "942110",
"description": "SQL Injection Attack: Common Injection Testing Detected",
"defaultState": "Enabled",
"defaultAction": "Block"
}
]
},
{
"ruleGroupName": "XSS",
"description": "Cross-site scripting",
"rules": [
{
"ruleId": "941100",
"description": "XSS Attack Detected via libinjection",
"defaultState": "Enabled",
"defaultAction": "Block"
},
{
"ruleId": "941101",
"description": "XSS Attack Detected via libinjection",
"defaultState": "Enabled",
"defaultAction": "Block"
},
{
"ruleId": "941110",
"description": "XSS Filter - Category 1: Script Tag Vector",
"defaultState": "Enabled",
"defaultAction": "Block"
}
]
}
]
}
}
]
}
Definitions
Name | Description |
---|---|
Action |
Defines the action to take on rule match. |
Error |
Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message. |
Managed |
Describes a managed rule definition. |
Managed |
Describes if the managed rule is in enabled or disabled state. |
Managed |
Describes a managed rule group. |
Managed |
Describes the a managed rule set definition. |
Managed |
List of managed rule set definitions available for use in a policy. |
ActionType
Defines the action to take on rule match.
Name | Type | Description |
---|---|---|
Allow |
string |
|
AnomalyScoring |
string |
|
Block |
string |
|
Log |
string |
|
Redirect |
string |
ErrorResponse
Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
message |
string |
Error message indicating why the operation failed. |
ManagedRuleDefinition
Describes a managed rule definition.
Name | Type | Description |
---|---|---|
defaultAction |
Describes the default action to be applied when the managed rule matches. |
|
defaultState |
Describes the default state for the managed rule. |
|
description |
string |
Describes the functionality of the managed rule. |
ruleId |
string |
Identifier for the managed rule. |
ManagedRuleEnabledState
Describes if the managed rule is in enabled or disabled state.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ManagedRuleGroupDefinition
Describes a managed rule group.
Name | Type | Description |
---|---|---|
description |
string |
Description of the managed rule group. |
ruleGroupName |
string |
Name of the managed rule group. |
rules |
List of rules within the managed rule group. |
ManagedRuleSetDefinition
Describes the a managed rule set definition.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |
location |
string |
Resource location. |
name |
string |
Resource name. |
properties.provisioningState |
string |
Provisioning state of the managed rule set. |
properties.ruleGroups |
Rule groups of the managed rule set. |
|
properties.ruleSetId |
string |
Id of the managed rule set. |
properties.ruleSetType |
string |
Type of the managed rule set. |
properties.ruleSetVersion |
string |
Version of the managed rule set type. |
tags |
object |
Resource tags. |
type |
string |
Resource type. |
ManagedRuleSetDefinitionList
List of managed rule set definitions available for use in a policy.
Name | Type | Description |
---|---|---|
nextLink |
string |
URL to retrieve next set of managed rule set definitions. |
value |
List of managed rule set definitions. |