Policies - Get

Pobieranie zasad ochrony z określoną nazwą w grupie zasobów.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
policyName
path True

string

Nazwa zasad Web Application Firewall.

resourceGroupName
path True

string

Nazwa grupy zasobów w ramach subskrypcji platformy Azure.

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

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True

string

Wersja interfejsu API klienta.

Odpowiedzi

Nazwa Typ Opis
200 OK

WebApplicationFirewallPolicy

OK. Żądanie zakończyło się pomyślnie.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

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"
  }
}

Definicje

Nazwa Opis
ActionType

Definiuje akcję do wykonania przy dopasowaniu reguły.

CustomRule

Definiuje zawartość reguły aplikacji internetowej

CustomRuleEnabledState

Opisuje, czy reguła niestandardowa jest w stanie włączonym lub wyłączonym. Wartość domyślna to Włączone, jeśli nie zostanie określona.

CustomRuleList

Definiuje zawartość reguł niestandardowych

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa Front Door nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

FrontendEndpointLink

Definiuje identyfikator zasobu dla punktu końcowego frontonu.

ManagedRuleEnabledState

Opisuje, czy reguła zarządzana jest w stanie włączonym lub wyłączonym.

ManagedRuleExclusion

Wyklucz zmienne z oceny reguły zarządzanej.

ManagedRuleExclusionMatchVariable

Typ zmiennej, który ma zostać wykluczony.

ManagedRuleExclusionSelectorMatchOperator

Operator porównania, który ma zastosowanie do selektora podczas określania elementów w kolekcji, do których ma zastosowanie to wykluczenie.

ManagedRuleGroupOverride

Definiuje ustawienie zastąpienia zarządzanej grupy reguł.

ManagedRuleOverride

Definiuje ustawienie zastąpienia zarządzanej grupy reguł.

ManagedRuleSet

Definiuje zarządzany zestaw reguł.

ManagedRuleSetActionType

Definiuje akcję do wykonania po osiągnięciu progu oceny zestawu reguł zarządzanych.

ManagedRuleSetList

Definiuje listę zarządzanych zestawów reguł dla zasad.

MatchCondition

Zdefiniuj warunek dopasowania.

MatchVariable

Zażądaj zmiennej do porównania.

Operator

Typ porównania używany do dopasowywania do wartości zmiennej.

PolicyEnabledState

Opisuje, czy zasady są w stanie włączonym lub wyłączonym. Wartość domyślna to Włączone, jeśli nie zostanie określona.

PolicyMode

Opisuje, czy jest w trybie wykrywania lub w trybie zapobiegania na poziomie zasad.

PolicyRequestBodyCheck

Opisuje, czy reguły zarządzane przez zasady będą sprawdzać zawartość treści żądania.

PolicyResourceState

Stan zasobu zasad.

PolicySettings

Definiuje ustawienia konfiguracji webapplicationFirewallPolicy najwyższego poziomu.

RoutingRuleLink

Definiuje identyfikator zasobu dla reguły routingu.

RuleType

Opisuje typ reguły.

SecurityPolicyLink

Definiuje identyfikator zasobu dla zasad zabezpieczeń.

Sku

Warstwa cenowa zasad zapory aplikacji internetowej.

SkuName

Nazwa warstwy cenowej.

TransformType

Opisuje przekształcenia zastosowane przed dopasowaniem.

WebApplicationFirewallPolicy

Definiuje zasady zapory aplikacji internetowej.

ActionType

Definiuje akcję do wykonania przy dopasowaniu reguły.

Nazwa Typ Opis
Allow

string

AnomalyScoring

string

Block

string

Log

string

Redirect

string

CustomRule

Definiuje zawartość reguły aplikacji internetowej

Nazwa Typ Opis
action

ActionType

Opisuje akcję, która ma zostać zastosowana, gdy reguła jest zgodna.

enabledState

CustomRuleEnabledState

Opisuje, czy reguła niestandardowa jest w stanie włączonym lub wyłączonym. Wartość domyślna to Włączone, jeśli nie zostanie określona.

matchConditions

MatchCondition[]

Lista warunków dopasowania.

name

string

Opisuje nazwę reguły.

priority

integer

Opisuje priorytet reguły. Reguły o niższej wartości zostaną ocenione przed regułami o wyższej wartości.

rateLimitDurationInMinutes

integer

Przedział czasu resetowania liczby limitów szybkości. Wartość domyślna to 1 minuta.

rateLimitThreshold

integer

Liczba dozwolonych żądań na klienta w przedziale czasu.

ruleType

RuleType

Opisuje typ reguły.

CustomRuleEnabledState

Opisuje, czy reguła niestandardowa jest w stanie włączonym lub wyłączonym. Wartość domyślna to Włączone, jeśli nie zostanie określona.

Nazwa Typ Opis
Disabled

string

Enabled

string

CustomRuleList

Definiuje zawartość reguł niestandardowych

Nazwa Typ Opis
rules

CustomRule[]

Lista reguł

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa Front Door nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa Typ Opis
code

string

Kod błędu.

message

string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

Definiuje identyfikator zasobu dla punktu końcowego frontonu.

Nazwa Typ Opis
id

string

Identyfikator zasobu.

ManagedRuleEnabledState

Opisuje, czy reguła zarządzana jest w stanie włączonym lub wyłączonym.

Nazwa Typ Opis
Disabled

string

Enabled

string

ManagedRuleExclusion

Wyklucz zmienne z oceny reguły zarządzanej.

Nazwa Typ Opis
matchVariable

ManagedRuleExclusionMatchVariable

Typ zmiennej, który ma zostać wykluczony.

selector

string

Wartość selektora, do których mają zastosowanie elementy w kolekcji.

selectorMatchOperator

ManagedRuleExclusionSelectorMatchOperator

Operator porównania, który ma zastosowanie do selektora podczas określania elementów w kolekcji, do których ma zastosowanie to wykluczenie.

ManagedRuleExclusionMatchVariable

Typ zmiennej, który ma zostać wykluczony.

Nazwa Typ Opis
QueryStringArgNames

string

RequestBodyJsonArgNames

string

RequestBodyPostArgNames

string

RequestCookieNames

string

RequestHeaderNames

string

ManagedRuleExclusionSelectorMatchOperator

Operator porównania, który ma zastosowanie do selektora podczas określania elementów w kolekcji, do których ma zastosowanie to wykluczenie.

Nazwa Typ Opis
Contains

string

EndsWith

string

Equals

string

EqualsAny

string

StartsWith

string

ManagedRuleGroupOverride

Definiuje ustawienie zastąpienia zarządzanej grupy reguł.

Nazwa Typ Opis
exclusions

ManagedRuleExclusion[]

Opisuje wykluczenia, które są stosowane do wszystkich reguł w grupie.

ruleGroupName

string

Opisuje zarządzaną grupę reguł do zastąpienia.

rules

ManagedRuleOverride[]

Lista reguł, które zostaną wyłączone. Jeśli żadna z nich nie zostanie określona, wszystkie reguły w grupie zostaną wyłączone.

ManagedRuleOverride

Definiuje ustawienie zastąpienia zarządzanej grupy reguł.

Nazwa Typ Opis
action

ActionType

Opisuje akcję przesłonięcia, która ma być stosowana, gdy reguła jest zgodna.

enabledState

ManagedRuleEnabledState

Opisuje, czy reguła zarządzana jest w stanie włączonym lub wyłączonym. Wartość domyślna to Wyłączone, jeśli nie zostanie określona.

exclusions

ManagedRuleExclusion[]

Opisuje wykluczenia, które są stosowane do tej konkretnej reguły.

ruleId

string

Identyfikator reguły zarządzanej.

ManagedRuleSet

Definiuje zarządzany zestaw reguł.

Nazwa Typ Opis
exclusions

ManagedRuleExclusion[]

Opisuje wykluczenia, które są stosowane do wszystkich reguł w zestawie.

ruleGroupOverrides

ManagedRuleGroupOverride[]

Definiuje przesłonięcia grupy reguł, które mają być stosowane do zestawu reguł.

ruleSetAction

ManagedRuleSetActionType

ruleSetAction
Definiuje akcję zestawu reguł.

ruleSetType

string

Definiuje typ zestawu reguł do użycia.

ruleSetVersion

string

Definiuje wersję zestawu reguł do użycia.

ManagedRuleSetActionType

Definiuje akcję do wykonania po osiągnięciu progu oceny zestawu reguł zarządzanych.

Nazwa Typ Opis
Block

string

Log

string

Redirect

string

ManagedRuleSetList

Definiuje listę zarządzanych zestawów reguł dla zasad.

Nazwa Typ Opis
managedRuleSets

ManagedRuleSet[]

Lista zestawów reguł.

MatchCondition

Zdefiniuj warunek dopasowania.

Nazwa Typ Opis
matchValue

string[]

Lista możliwych wartości dopasowania.

matchVariable

MatchVariable

Zażądaj zmiennej do porównania.

negateCondition

boolean

Opisuje, czy wynik tego warunku powinien zostać zanegowany.

operator

Operator

Typ porównania używany do dopasowywania do wartości zmiennej.

selector

string

Dopasuj do określonego klucza ze zmiennych QueryString, PostArgs, RequestHeader lub Cookies. Wartość domyślna to null.

transforms

TransformType[]

Lista przekształceń.

MatchVariable

Zażądaj zmiennej do porównania.

Nazwa Typ Opis
Cookies

string

PostArgs

string

QueryString

string

RemoteAddr

string

RequestBody

string

RequestHeader

string

RequestMethod

string

RequestUri

string

SocketAddr

string

Operator

Typ porównania używany do dopasowywania do wartości zmiennej.

Nazwa Typ Opis
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

Opisuje, czy zasady są w stanie włączonym lub wyłączonym. Wartość domyślna to Włączone, jeśli nie zostanie określona.

Nazwa Typ Opis
Disabled

string

Enabled

string

PolicyMode

Opisuje, czy jest w trybie wykrywania lub w trybie zapobiegania na poziomie zasad.

Nazwa Typ Opis
Detection

string

Prevention

string

PolicyRequestBodyCheck

Opisuje, czy reguły zarządzane przez zasady będą sprawdzać zawartość treści żądania.

Nazwa Typ Opis
Disabled

string

Enabled

string

PolicyResourceState

Stan zasobu zasad.

Nazwa Typ Opis
Creating

string

Deleting

string

Disabled

string

Disabling

string

Enabled

string

Enabling

string

PolicySettings

Definiuje ustawienia konfiguracji webapplicationFirewallPolicy najwyższego poziomu.

Nazwa Typ Opis
customBlockResponseBody

string

Jeśli typ akcji jest zablokowany, klient może zastąpić treść odpowiedzi. Treść musi być określona w kodowaniu base64.

customBlockResponseStatusCode

integer

Jeśli typ akcji jest zablokowany, klient może zastąpić kod stanu odpowiedzi.

enabledState

PolicyEnabledState

Opisuje, czy zasady są w stanie włączonym lub wyłączonym. Wartość domyślna to Włączone, jeśli nie zostanie określona.

mode

PolicyMode

Opisuje, czy jest w trybie wykrywania lub w trybie zapobiegania na poziomie zasad.

redirectUrl

string

Jeśli typ akcji to przekierowanie, to pole reprezentuje adres URL przekierowania dla klienta.

requestBodyCheck

PolicyRequestBodyCheck

Opisuje, czy reguły zarządzane przez zasady będą sprawdzać zawartość treści żądania.

Definiuje identyfikator zasobu dla reguły routingu.

Nazwa Typ Opis
id

string

Identyfikator zasobu.

RuleType

Opisuje typ reguły.

Nazwa Typ Opis
MatchRule

string

RateLimitRule

string

Definiuje identyfikator zasobu dla zasad zabezpieczeń.

Nazwa Typ Opis
id

string

Identyfikator zasobu.

Sku

Warstwa cenowa zasad zapory aplikacji internetowej.

Nazwa Typ Opis
name

SkuName

Nazwa warstwy cenowej.

SkuName

Nazwa warstwy cenowej.

Nazwa Typ Opis
Classic_AzureFrontDoor

string

Premium_AzureFrontDoor

string

Standard_AzureFrontDoor

string

TransformType

Opisuje przekształcenia zastosowane przed dopasowaniem.

Nazwa Typ Opis
Lowercase

string

RemoveNulls

string

Trim

string

Uppercase

string

UrlDecode

string

UrlEncode

string

WebApplicationFirewallPolicy

Definiuje zasady zapory aplikacji internetowej.

Nazwa Typ Opis
etag

string

Pobiera unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.

id

string

Identyfikator zasobu.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.customRules

CustomRuleList

Opisuje reguły niestandardowe wewnątrz zasad.

properties.frontendEndpointLinks

FrontendEndpointLink[]

W tym artykule opisano punkty końcowe frontonu skojarzone z tym Web Application Firewall zasadami.

properties.managedRules

ManagedRuleSetList

Opisuje reguły zarządzane wewnątrz zasad.

properties.policySettings

PolicySettings

Opisuje ustawienia zasad.

properties.provisioningState

string

Stan aprowizacji zasad.

properties.resourceState

PolicyResourceState

Stan zasobu zasad.

properties.routingRuleLinks

RoutingRuleLink[]

Opisuje reguły routingu skojarzone z tym zasadami Web Application Firewall.

properties.securityPolicyLinks

SecurityPolicyLink[]

Opisuje zasady zabezpieczeń skojarzone z tym zasadami Web Application Firewall.

sku

Sku

Warstwa cenowa zasad zapory aplikacji internetowej. Wartość domyślna to Classic_AzureFrontDoor, jeśli nie zostanie określona.

tags

object

Tagi zasobów.

type

string

Typ zasobu.