Policies - Get

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

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
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 Typ Beschreibung
200 OK

WebApplicationFirewallPolicy

OK. Die Anforderung wurde erfolgreich durchgeführt.

Other Status Codes

ErrorResponse

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 Beschreibung
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=2022-05-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

Name Beschreibung
ActionType

Definiert die Aktion, die bei regelrelevanter Übereinstimmung ausgeführt werden soll.

CustomRule

Definiert den Inhalt einer Webanwendungsregel

CustomRuleEnabledState

Beschreibt, ob sich die benutzerdefinierte Regel im aktivierten oder deaktivierten Zustand befindet. Die Standardwerte sind aktiviert, wenn nicht angegeben.

CustomRuleList

Definiert den Inhalt benutzerdefinierter Regeln

ErrorResponse

Die 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 Front-End-Endpunkt.

ManagedRuleEnabledState

Beschreibt, ob sich die verwaltete Regel im aktivierten oder deaktivierten Zustand befindet.

ManagedRuleExclusion

Ausschließen von Variablen aus der Auswertung verwalteter Regeln.

ManagedRuleExclusionMatchVariable

Der auszuschließende Variablentyp.

ManagedRuleExclusionSelectorMatchOperator

Vergleichsoperator, der auf den Selektor angewendet werden soll, wenn angegeben wird, für welche Elemente in der Auflistung dieser Ausschluss gilt.

ManagedRuleGroupOverride

Definiert eine Einstellung für die Außerkraftsetzung einer verwalteten Regelgruppe.

ManagedRuleOverride

Definiert eine Einstellung für die Außerkraftsetzung einer verwalteten Regelgruppe.

ManagedRuleSet

Definiert einen verwalteten Regelsatz.

ManagedRuleSetActionType

Definiert die Aktion, die ausgeführt werden soll, wenn ein Schwellenwert für die Bewertung eines verwalteten Regelsatzes erreicht wird.

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 für den Abgleich mit dem Variablenwert verwendet werden soll.

PolicyEnabledState

Beschreibt, ob sich die Richtlinie im aktivierten oder deaktivierten Zustand befindet. Die Standardwerte sind aktiviert, wenn nicht angegeben.

PolicyMode

Beschreibt, ob es sich im Erkennungsmodus oder Im Präventionsmodus auf Richtlinienebene befindet.

PolicyRequestBodyCheck

Beschreibt, ob richtlinienverwaltete Regeln den Inhalt des Anforderungstexts überprüfen.

PolicyResourceState

Ressourcen status der Richtlinie.

PolicySettings

Definiert die Konfigurationseinstellungen für WebApplicationFirewallPolicy auf oberster Ebene.

RoutingRuleLink

Definiert die Ressourcen-ID für eine Routingregel.

RuleType

Beschreibt den Regeltyp.

SecurityPolicyLink

Definiert die Ressourcen-ID für eine Sicherheitsrichtlinie.

Sku

Der Tarif der Firewallrichtlinie für Webanwendungen.

SkuName

Name des Tarifs.

TransformType

Beschreibt, welche Transformationen vor dem Abgleich angewendet werden.

WebApplicationFirewallPolicy

Definiert die Firewallrichtlinie für Webanwendungen.

ActionType

Definiert die Aktion, die bei regelrelevanter Übereinstimmung ausgeführt werden soll.

Name Typ Beschreibung
Allow

string

AnomalyScoring

string

Block

string

Log

string

Redirect

string

CustomRule

Definiert den Inhalt einer Webanwendungsregel

Name Typ Beschreibung
action

ActionType

Beschreibt, welche Aktion angewendet werden soll, wenn die Regel übereinstimmt.

enabledState

CustomRuleEnabledState

Beschreibt, ob sich die benutzerdefinierte Regel im aktivierten oder deaktivierten Zustand befindet. Die Standardwerte sind aktiviert, wenn nicht angegeben.

matchConditions

MatchCondition[]

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 für das Zurücksetzen der Ratenlimitanzahl. Standardwert ist 1 Minute.

rateLimitThreshold

integer

Anzahl der zulässigen Anforderungen pro Client innerhalb des Zeitfensters.

ruleType

RuleType

Beschreibt den Regeltyp.

CustomRuleEnabledState

Beschreibt, ob sich die benutzerdefinierte Regel im aktivierten oder deaktivierten Zustand befindet. Die Standardwerte sind aktiviert, wenn nicht angegeben.

Name Typ Beschreibung
Disabled

string

Enabled

string

CustomRuleList

Definiert den Inhalt benutzerdefinierter Regeln

Name Typ Beschreibung
rules

CustomRule[]

Liste der Regeln

ErrorResponse

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

Name Typ Beschreibung
code

string

Fehlercode

message

string

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

Definiert die Ressourcen-ID für einen Front-End-Endpunkt.

Name Typ Beschreibung
id

string

Ressourcen-ID

ManagedRuleEnabledState

Beschreibt, ob sich die verwaltete Regel im aktivierten oder deaktivierten Zustand befindet.

Name Typ Beschreibung
Disabled

string

Enabled

string

ManagedRuleExclusion

Ausschließen von Variablen aus der Auswertung verwalteter Regeln.

Name Typ Beschreibung
matchVariable

ManagedRuleExclusionMatchVariable

Der auszuschließende Variablentyp.

selector

string

Selektorwert, für den Elemente in der Auflistung dieser Ausschluss gilt.

selectorMatchOperator

ManagedRuleExclusionSelectorMatchOperator

Vergleichsoperator, der auf den Selektor angewendet werden soll, wenn angegeben wird, für welche Elemente in der Auflistung dieser Ausschluss gilt.

ManagedRuleExclusionMatchVariable

Der auszuschließende Variablentyp.

Name Typ Beschreibung
QueryStringArgNames

string

RequestBodyJsonArgNames

string

RequestBodyPostArgNames

string

RequestCookieNames

string

RequestHeaderNames

string

ManagedRuleExclusionSelectorMatchOperator

Vergleichsoperator, der auf den Selektor angewendet werden soll, wenn angegeben wird, für welche Elemente in der Auflistung dieser Ausschluss gilt.

Name Typ Beschreibung
Contains

string

EndsWith

string

Equals

string

EqualsAny

string

StartsWith

string

ManagedRuleGroupOverride

Definiert eine Einstellung für die Außerkraftsetzung einer verwalteten Regelgruppe.

Name Typ Beschreibung
exclusions

ManagedRuleExclusion[]

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

ruleGroupName

string

Beschreibt die verwaltete Regelgruppe, die überschrieben werden soll.

rules

ManagedRuleOverride[]

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

ManagedRuleOverride

Definiert eine Einstellung für die Außerkraftsetzung einer verwalteten Regelgruppe.

Name Typ Beschreibung
action

ActionType

Beschreibt die Überschreibungsaktion, die angewendet werden soll, wenn die Regel übereinstimmt.

enabledState

ManagedRuleEnabledState

Beschreibt, ob sich die verwaltete Regel im aktivierten oder deaktivierten Zustand befindet. Die Standardwerte sind deaktiviert, wenn nicht angegeben.

exclusions

ManagedRuleExclusion[]

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 Typ Beschreibung
exclusions

ManagedRuleExclusion[]

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

ruleGroupOverrides

ManagedRuleGroupOverride[]

Definiert die Regelgruppenüberschreibungen, die auf den Regelsatz angewendet werden sollen.

ruleSetAction

ManagedRuleSetActionType

ruleSetAction
Definiert die Regelsatzaktion.

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 die Bewertung eines verwalteten Regelsatzes erreicht wird.

Name Typ Beschreibung
Block

string

Log

string

Redirect

string

ManagedRuleSetList

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

Name Typ Beschreibung
managedRuleSets

ManagedRuleSet[]

Liste der Regelsätze.

MatchCondition

Definieren Sie eine Übereinstimmungsbedingung.

Name Typ Beschreibung
matchValue

string[]

Liste der möglichen Übereinstimmungswerte.

matchVariable

MatchVariable

Anforderungsvariable, mit der verglichen werden soll.

negateCondition

boolean

Beschreibt, ob das Ergebnis dieser Bedingung negiert werden soll.

operator

Operator

Vergleichstyp, der für den Abgleich mit dem Variablenwert verwendet werden soll.

selector

string

Übereinstimmung mit einem bestimmten Schlüssel aus den Variablen QueryString, PostArgs, RequestHeader oder Cookies. Der Standardwert lautet null.

transforms

TransformType[]

Liste der Transformationen.

MatchVariable

Anforderungsvariable, mit der verglichen werden soll.

Name Typ Beschreibung
Cookies

string

PostArgs

string

QueryString

string

RemoteAddr

string

RequestBody

string

RequestHeader

string

RequestMethod

string

RequestUri

string

SocketAddr

string

Operator

Vergleichstyp, der für den Abgleich mit dem Variablenwert verwendet werden soll.

Name Typ Beschreibung
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 sich die Richtlinie im aktivierten oder deaktivierten Zustand befindet. Die Standardwerte sind aktiviert, wenn nicht angegeben.

Name Typ Beschreibung
Disabled

string

Enabled

string

PolicyMode

Beschreibt, ob es sich im Erkennungsmodus oder Im Präventionsmodus auf Richtlinienebene befindet.

Name Typ Beschreibung
Detection

string

Prevention

string

PolicyRequestBodyCheck

Beschreibt, ob richtlinienverwaltete Regeln den Inhalt des Anforderungstexts überprüfen.

Name Typ Beschreibung
Disabled

string

Enabled

string

PolicyResourceState

Ressourcen status der Richtlinie.

Name Typ Beschreibung
Creating

string

Deleting

string

Disabled

string

Disabling

string

Enabled

string

Enabling

string

PolicySettings

Definiert die Konfigurationseinstellungen für WebApplicationFirewallPolicy auf oberster Ebene.

Name Typ Beschreibung
customBlockResponseBody

string

Wenn der Aktionstyp block ist, kann der Kunde den Antworttext überschreiben. Der Text muss in der Base64-Codierung angegeben werden.

customBlockResponseStatusCode

integer

Wenn der Aktionstyp block ist, kann der Kunde die Antwort status Code außer Kraft setzen.

enabledState

PolicyEnabledState

Beschreibt, ob sich die Richtlinie im aktivierten oder deaktivierten Zustand befindet. Die Standardwerte sind aktiviert, wenn nicht angegeben.

mode

PolicyMode

Beschreibt, ob es sich im Erkennungsmodus oder Im Präventionsmodus auf Richtlinienebene befindet.

redirectUrl

string

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

requestBodyCheck

PolicyRequestBodyCheck

Beschreibt, ob richtlinienverwaltete Regeln den Inhalt des Anforderungstexts überprüfen.

Definiert die Ressourcen-ID für eine Routingregel.

Name Typ Beschreibung
id

string

Ressourcen-ID

RuleType

Beschreibt den Regeltyp.

Name Typ Beschreibung
MatchRule

string

RateLimitRule

string

Definiert die Ressourcen-ID für eine Sicherheitsrichtlinie.

Name Typ Beschreibung
id

string

Ressourcen-ID

Sku

Der Tarif der Firewallrichtlinie für Webanwendungen.

Name Typ Beschreibung
name

SkuName

Name des Tarifs.

SkuName

Name des Tarifs.

Name Typ Beschreibung
Classic_AzureFrontDoor

string

Premium_AzureFrontDoor

string

Standard_AzureFrontDoor

string

TransformType

Beschreibt, welche Transformationen vor dem Abgleich angewendet werden.

Name Typ Beschreibung
Lowercase

string

RemoveNulls

string

Trim

string

Uppercase

string

UrlDecode

string

UrlEncode

string

WebApplicationFirewallPolicy

Definiert die Firewallrichtlinie für Webanwendungen.

Name Typ Beschreibung
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

CustomRuleList

Beschreibt benutzerdefinierte Regeln innerhalb der Richtlinie.

properties.frontendEndpointLinks

FrontendEndpointLink[]

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

properties.managedRules

ManagedRuleSetList

Beschreibt verwaltete Regeln innerhalb der Richtlinie.

properties.policySettings

PolicySettings

Beschreibt die Einstellungen für die Richtlinie.

properties.provisioningState

string

Bereitstellungsstatus der Richtlinie.

properties.resourceState

PolicyResourceState

Ressourcen status der Richtlinie.

properties.routingRuleLinks

RoutingRuleLink[]

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

properties.securityPolicyLinks

SecurityPolicyLink[]

Beschreibt die dieser Web Application Firewall Richtlinie zugeordnete Sicherheitsrichtlinie.

sku

Sku

Der Tarif der Firewallrichtlinie für Webanwendungen. Wird standardmäßig Classic_AzureFrontDoor, wenn nicht angegeben.

tags

object

Ressourcentags.

type

string

Der Ressourcentyp.