Policies - Get

Rufen Sie die Schutzrichtlinie mit dem angegebenen Namen in einer Ressourcengruppe ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}?api-version=2020-11-01

URI-Parameter

Name In Required Type Description
policyName
path True
  • string

Der Name der Web Application Firewall Richtlinie.

resourceGroupName
path True
  • string

Name der Ressourcengruppe innerhalb des Azure-Abonnements.

Regex pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$

subscriptionId
path True
  • string

Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True
  • string

Client-API-Version.

Antworten

Name Type Description
200 OK

OK. Die Anforderung ist erfolgreich.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

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 Identitätswechsel Ihres Benutzerkontos

Beispiele

Get Policy

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1?api-version=2020-11-01

Sample Response

{
  "name": "Policy1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1",
  "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "location": "WestUs",
  "properties": {
    "resourceState": "Enabled",
    "provisioningState": "Succeeded",
    "policySettings": {
      "enabledState": "Enabled",
      "mode": "Prevention",
      "redirectUrl": "http://www.bing.com",
      "customBlockResponseStatusCode": 499,
      "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==",
      "requestBodyCheck": "Disabled"
    },
    "customRules": {
      "rules": [
        {
          "name": "Rule1",
          "priority": 1,
          "enabledState": "Enabled",
          "ruleType": "RateLimitRule",
          "rateLimitDurationInMinutes": 0,
          "rateLimitThreshold": 1000,
          "matchConditions": [
            {
              "matchVariable": "RemoteAddr",
              "selector": null,
              "operator": "IPMatch",
              "negateCondition": false,
              "matchValue": [
                "192.168.1.0/24",
                "10.0.0.0/24"
              ],
              "transforms": []
            }
          ],
          "action": "Block"
        },
        {
          "name": "Rule2",
          "priority": 2,
          "enabledState": "Enabled",
          "ruleType": "MatchRule",
          "rateLimitDurationInMinutes": 0,
          "rateLimitThreshold": 0,
          "matchConditions": [
            {
              "matchVariable": "RemoteAddr",
              "selector": null,
              "operator": "GeoMatch",
              "negateCondition": false,
              "matchValue": [
                "CH"
              ]
            },
            {
              "matchVariable": "RequestHeader",
              "selector": "UserAgent",
              "operator": "Contains",
              "negateCondition": false,
              "matchValue": [
                "windows"
              ],
              "transforms": [
                "Lowercase"
              ]
            }
          ],
          "action": "Block"
        }
      ]
    },
    "managedRules": {
      "managedRuleSets": [
        {
          "ruleSetType": "DefaultRuleSet",
          "ruleSetVersion": "1.0",
          "ruleSetAction": "Block",
          "exclusions": [
            {
              "matchVariable": "RequestHeaderNames",
              "selectorMatchOperator": "Equals",
              "selector": "User-Agent"
            }
          ],
          "ruleGroupOverrides": [
            {
              "ruleGroupName": "SQLI",
              "exclusions": [],
              "rules": [
                {
                  "ruleId": "942100",
                  "enabledState": "Enabled",
                  "action": "Redirect",
                  "exclusions": []
                },
                {
                  "ruleId": "942110",
                  "enabledState": "Disabled"
                }
              ]
            }
          ]
        }
      ]
    },
    "frontendEndpointLinks": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontdoors/fd1/frontendendpoints/fd1-azurefd-net"
      }
    ],
    "securityPolicyLinks": []
  },
  "sku": {
    "name": "Classic_AzureFrontDoor"
  }
}

Definitionen

ActionType

Definiert die Aktion, die für regelgleich ausgeführt werden soll.

CustomRule

Definiert Inhalte einer Webanwendungsregel

CustomRuleEnabledState

Beschreibt, ob die benutzerdefinierte Regel aktiviert oder deaktiviert ist. Standardeinstellung für "Aktiviert", falls nicht angegeben.

CustomRuleList

Definiert Inhalte benutzerdefinierter Regeln

ErrorResponse

Fehlerantwort gibt an, dass der Front Door-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

FrontendEndpointLink

Definiert die Ressourcen-ID für einen Frontend-Endpunkt.

ManagedRuleEnabledState

Beschreibt, ob die verwaltete Regel aktiviert oder deaktiviert ist.

ManagedRuleExclusion

Ausschließen von Variablen aus verwalteter Regelbewertung.

ManagedRuleExclusionMatchVariable

Der variable Typ, der ausgeschlossen werden soll.

ManagedRuleExclusionSelectorMatchOperator

Vergleichsoperator, der auf den Auswahlgeber angewendet werden soll, wenn angegeben wird, welche Elemente in der Auflistung dieses Ausschlusses gelten.

ManagedRuleGroupOverride

Definiert eine Einstellung für verwaltete Regelgruppenüberschreibung.

ManagedRuleOverride

Definiert eine Einstellung für verwaltete Regelgruppenüberschreibung.

ManagedRuleSet

Definiert einen verwalteten Regelsatz.

ManagedRuleSetActionType

Definiert die Aktion, die ausgeführt werden soll, wenn ein Schwellenwert für verwaltete Regelsatzbewertung erfüllt ist.

ManagedRuleSetList

Definiert die Liste der verwalteten Regelsätze für die Richtlinie.

MatchCondition

Definieren Sie eine Übereinstimmungsbedingung.

MatchVariable

Anforderungsvariable, mit der verglichen werden soll.

Operator

Vergleichstyp, der zum Übereinstimmen mit dem Variablenwert verwendet werden soll.

PolicyEnabledState

Beschreibt, ob die Richtlinie aktiviert oder deaktiviert ist. Standardeinstellung für "Aktiviert", falls nicht angegeben.

PolicyMode

Beschreibt, ob es sich im Erkennungsmodus oder im Verhinderungsmodus auf Richtlinienebene befindet.

PolicyRequestBodyCheck

Beschreibt, ob verwaltete Richtlinienregeln den Anforderungstextinhalt überprüfen.

PolicyResourceState

Ressourcenstatus der Richtlinie.

PolicySettings

Definiert Die Konfigurationseinstellungen der obersten Ebene von WebApplicationFirewallPolicy.

RoutingRuleLink

Definiert die Ressourcen-ID für eine Routingregel.

RuleType

Beschreibt den Regeltyp.

SecurityPolicyLink

Definiert die Ressourcen-ID für eine Sicherheitsrichtlinie.

Sku

Die Preisstufe der Webanwendungs-Firewallrichtlinie.

SkuName

Name der Preisstufe.

WebApplicationFirewallPolicy

Definiert die Firewallrichtlinie für Webanwendungen.

ActionType

Definiert die Aktion, die für regelgleich ausgeführt werden soll.

Name Type Description
Allow
  • string
Block
  • string
Log
  • string
Redirect
  • string

CustomRule

Definiert Inhalte einer Webanwendungsregel

Name Type Description
action

Beschreibt, welche Aktion angewendet werden soll, wenn Regel übereinstimmungen.

enabledState

Beschreibt, ob die benutzerdefinierte Regel aktiviert oder deaktiviert ist. Standardeinstellung für "Aktiviert", falls nicht angegeben.

matchConditions

Liste der Übereinstimmungsbedingungen

name
  • string

Beschreibt den Namen der Regel.

priority
  • integer

Beschreibt die Priorität der Regel. Regeln mit einem niedrigeren Wert werden vor Regeln mit einem höheren Wert ausgewertet.

rateLimitDurationInMinutes
  • integer

Zeitfenster zum Zurücksetzen der Ratelimitanzahl. Standard ist 1 Minute.

rateLimitThreshold
  • integer

Anzahl zulässiger Anforderungen pro Client innerhalb des Zeitfensters.

ruleType

Beschreibt den Regeltyp.

CustomRuleEnabledState

Beschreibt, ob die benutzerdefinierte Regel aktiviert oder deaktiviert ist. Standardeinstellung für "Aktiviert", falls nicht angegeben.

Name Type Description
Disabled
  • string
Enabled
  • string

CustomRuleList

Definiert Inhalte benutzerdefinierter Regeln

Name Type Description
rules

Liste der Regeln

ErrorResponse

Fehlerantwort gibt an, dass der Front Door-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name Type Description
code
  • string

Fehlercode

message
  • string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Definiert die Ressourcen-ID für einen Frontend-Endpunkt.

Name Type Description
id
  • string

Ressourcen-ID

ManagedRuleEnabledState

Beschreibt, ob die verwaltete Regel aktiviert oder deaktiviert ist.

Name Type Description
Disabled
  • string
Enabled
  • string

ManagedRuleExclusion

Ausschließen von Variablen aus verwalteter Regelbewertung.

Name Type Description
matchVariable

Der variable Typ, der ausgeschlossen werden soll.

selector
  • string

Selector-Wert für die Elemente in der Auflistung, auf die dieser Ausschluss angewendet wird.

selectorMatchOperator

Vergleichsoperator, der auf den Auswahlgeber angewendet werden soll, wenn angegeben wird, welche Elemente in der Auflistung dieses Ausschlusses gelten.

ManagedRuleExclusionMatchVariable

Der variable Typ, der ausgeschlossen werden soll.

Name Type Description
QueryStringArgNames
  • string
RequestBodyJsonArgNames
  • string
RequestBodyPostArgNames
  • string
RequestCookieNames
  • string
RequestHeaderNames
  • string

ManagedRuleExclusionSelectorMatchOperator

Vergleichsoperator, der auf den Auswahlgeber angewendet werden soll, wenn angegeben wird, welche Elemente in der Auflistung dieses Ausschlusses gelten.

Name Type Description
Contains
  • string
EndsWith
  • string
Equals
  • string
EqualsAny
  • string
StartsWith
  • string

ManagedRuleGroupOverride

Definiert eine Einstellung für verwaltete Regelgruppenüberschreibung.

Name Type Description
exclusions

Beschreibt die Ausschlüsse, die auf alle Regeln in der Gruppe angewendet werden.

ruleGroupName
  • string

Beschreibt die verwaltete Regelgruppe zum Außerkraftsetzen.

rules

Liste der Regeln, die deaktiviert werden. Wenn keine angegeben ist, werden alle Regeln in der Gruppe deaktiviert.

ManagedRuleOverride

Definiert eine Einstellung für verwaltete Regelgruppenüberschreibung.

Name Type Description
action

Beschreibt die Außerkraftsetzungsaktion, die angewendet werden soll, wenn Regelüberstimmungen übereinstimmen.

enabledState

Beschreibt, ob die verwaltete Regel aktiviert oder deaktiviert ist. Standardeinstellung für "Deaktiviert", falls nicht angegeben.

exclusions

Beschreibt die Ausschlüsse, die auf diese bestimmte Regel angewendet werden.

ruleId
  • string

Bezeichner für die verwaltete Regel.

ManagedRuleSet

Definiert einen verwalteten Regelsatz.

Name Type Description
exclusions

Beschreibt die Ausschlüsse, die auf alle Regeln im Satz angewendet werden.

ruleGroupOverrides

Definiert die Regelgruppe überschrieben, die auf den Regelsatz angewendet werden soll.

ruleSetAction

Definiert die Aktion, die ausgeführt werden soll, wenn ein Schwellenwert für verwaltete Regelsatzbewertung erfüllt ist.

ruleSetType
  • string

Definiert den zu verwendenden Regelsatztyp.

ruleSetVersion
  • string

Definiert die zu verwendende Version des Regelsatzes.

ManagedRuleSetActionType

Definiert die Aktion, die ausgeführt werden soll, wenn ein Schwellenwert für verwaltete Regelsatzbewertung erfüllt ist.

Name Type Description
Block
  • string
Log
  • string
Redirect
  • string

ManagedRuleSetList

Definiert die Liste der verwalteten Regelsätze für die Richtlinie.

Name Type Description
managedRuleSets

Liste der Regelsätze.

MatchCondition

Definieren Sie eine Übereinstimmungsbedingung.

Name Type Description
matchValue
  • string[]

Liste der möglichen Übereinstimmungswerte.

matchVariable

Anforderungsvariable, mit der verglichen werden soll.

negateCondition
  • boolean

Beschreibt, ob das Ergebnis dieser Bedingung negiert werden soll.

operator

Vergleichstyp, der zum Übereinstimmen mit dem Variablenwert verwendet werden soll.

selector
  • string

Stimmen Sie mit einem bestimmten Schlüssel aus der QueryString-, PostArgs-, RequestHeader- oder Cookies-Variablen überein. Der Standardwert lautet null.

transforms
  • string[]

Liste der Transformationen.

MatchVariable

Anforderungsvariable, mit der verglichen werden soll.

Name Type Description
Cookies
  • string
PostArgs
  • string
QueryString
  • string
RemoteAddr
  • string
RequestBody
  • string
RequestHeader
  • string
RequestMethod
  • string
RequestUri
  • string
SocketAddr
  • string

Operator

Vergleichstyp, der zum Übereinstimmen mit dem Variablenwert verwendet werden soll.

Name Type Description
Any
  • string
BeginsWith
  • string
Contains
  • string
EndsWith
  • string
Equal
  • string
GeoMatch
  • string
GreaterThan
  • string
GreaterThanOrEqual
  • string
IPMatch
  • string
LessThan
  • string
LessThanOrEqual
  • string
RegEx
  • string

PolicyEnabledState

Beschreibt, ob die Richtlinie aktiviert oder deaktiviert ist. Standardeinstellung für "Aktiviert", falls nicht angegeben.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyMode

Beschreibt, ob es sich im Erkennungsmodus oder im Verhinderungsmodus auf Richtlinienebene befindet.

Name Type Description
Detection
  • string
Prevention
  • string

PolicyRequestBodyCheck

Beschreibt, ob verwaltete Richtlinienregeln den Anforderungstextinhalt überprüfen.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyResourceState

Ressourcenstatus der Richtlinie.

Name Type Description
Creating
  • string
Deleting
  • string
Disabled
  • string
Disabling
  • string
Enabled
  • string
Enabling
  • string

PolicySettings

Definiert Die Konfigurationseinstellungen der obersten Ebene von WebApplicationFirewallPolicy.

Name Type Description
customBlockResponseBody
  • string

Wenn der Aktionstyp blockiert ist, kann der Kunde den Antworttext außer Kraft setzen. Der Text muss in der Base64-Codierung angegeben werden.

customBlockResponseStatusCode
  • integer

Wenn der Aktionstyp blockiert ist, kann der Kunde den Antwortstatuscode außer Kraft setzen.

enabledState

Beschreibt, ob die Richtlinie aktiviert oder deaktiviert ist. Standardeinstellung für "Aktiviert", falls nicht angegeben.

mode

Beschreibt, ob es sich im Erkennungsmodus oder im Verhinderungsmodus auf Richtlinienebene befindet.

redirectUrl
  • string

Wenn der Aktionstyp umgeleitet wird, stellt dieses Feld die Umleitungs-URL für den Client dar.

requestBodyCheck

Beschreibt, ob verwaltete Richtlinienregeln den Anforderungstextinhalt überprüfen.

Definiert die Ressourcen-ID für eine Routingregel.

Name Type Description
id
  • string

Ressourcen-ID

RuleType

Beschreibt den Regeltyp.

Name Type Description
MatchRule
  • string
RateLimitRule
  • string

Definiert die Ressourcen-ID für eine Sicherheitsrichtlinie.

Name Type Description
id
  • string

Ressourcen-ID

Sku

Die Preisstufe der Webanwendungs-Firewallrichtlinie.

Name Type Description
name

Name der Preisstufe.

SkuName

Name der Preisstufe.

Name Type Description
Classic_AzureFrontDoor
  • string
Premium_AzureFrontDoor
  • string
Standard_AzureFrontDoor
  • string

WebApplicationFirewallPolicy

Definiert die Firewallrichtlinie für Webanwendungen.

Name Type Description
etag
  • string

Ruft eine eindeutige schreibgeschützte Zeichenfolge ab, die sich ändert, wenn die Ressource aktualisiert wird.

id
  • string

Ressourcen-ID

location
  • string

Ressourcenspeicherort

name
  • string

Name der Ressource.

properties.customRules

Beschreibt benutzerdefinierte Regeln innerhalb der Richtlinie.

properties.frontendEndpointLinks

Beschreibt Frontend-Endpunkte, die dieser Web Application Firewall Richtlinie zugeordnet sind.

properties.managedRules

Beschreibt verwaltete Regeln innerhalb der Richtlinie.

properties.policySettings

Beschreibt Einstellungen für die Richtlinie.

properties.provisioningState
  • string

Bereitstellungsstatus der Richtlinie.

properties.resourceState

Ressourcenstatus der Richtlinie.

properties.routingRuleLinks

Beschreibt Routingregeln, die dieser Web Application Firewall Richtlinie zugeordnet sind.

properties.securityPolicyLinks

Beschreibt die Sicherheitsrichtlinie, die dieser Web Application Firewall Richtlinie zugeordnet ist.

sku

Die Preisstufe der Webanwendungs-Firewallrichtlinie. Standardeinstellung für Classic_AzureFrontDoor, falls nicht angegeben.

tags
  • object

Ressourcentags.

type
  • string

Der Ressourcentyp.