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=2020-11-01

Parametry identyfikatora URI

Name In Required Type Description
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ą Microsoft Azure subskrypcji. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True
  • string

Wersja interfejsu API klienta.

Odpowiedzi

Name Type Description
200 OK

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

Other Status Codes

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

Zabezpieczenia

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

Definicje

ActionType

Definiuje akcję do wykonania zgodnie z regułą.

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

Żądaj zmiennej do porównania.

Operator

Typ porównania używany do dopasowywania z 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 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.

WebApplicationFirewallPolicy

Definiuje zasady zapory aplikacji internetowej.

ActionType

Definiuje akcję do wykonania zgodnie z regułą.

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

CustomRule

Definiuje zawartość reguły aplikacji internetowej

Name Type Description
action

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

enabledState

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

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

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.

Name Type Description
Disabled
  • string
Enabled
  • string

CustomRuleList

Definiuje zawartość reguł niestandardowych

Name Type Description
rules

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.

Name Type Description
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.

Name Type Description
id
  • string

Identyfikator zasobu.

ManagedRuleEnabledState

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

Name Type Description
Disabled
  • string
Enabled
  • string

ManagedRuleExclusion

Wyklucz zmienne z oceny reguły zarządzanej.

Name Type Description
matchVariable

Typ zmiennej, który ma zostać wykluczony.

selector
  • string

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

selectorMatchOperator

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.

Name Type Description
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.

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

ManagedRuleGroupOverride

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

Name Type Description
exclusions

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

ruleGroupName
  • string

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

rules

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ł.

Name Type Description
action

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

enabledState

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

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

ruleId
  • string

Identyfikator reguły zarządzanej.

ManagedRuleSet

Definiuje zarządzany zestaw reguł.

Name Type Description
exclusions

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

ruleGroupOverrides

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

ruleSetAction

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

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.

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

ManagedRuleSetList

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

Name Type Description
managedRuleSets

Lista zestawów reguł.

MatchCondition

Zdefiniuj warunek dopasowania.

Name Type Description
matchValue
  • string[]

Lista możliwych wartości dopasowania.

matchVariable

Żądaj zmiennej do porównania.

negateCondition
  • boolean

Opisuje, czy wynik tego warunku powinien być negowany.

operator

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

selector
  • string

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

transforms
  • string[]

Lista przekształceń.

MatchVariable

Żądaj zmiennej do porównania.

Name Type Description
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 z wartością zmiennej.

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

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

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyMode

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

Name Type Description
Detection
  • string
Prevention
  • string

PolicyRequestBodyCheck

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

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyResourceState

Stan zasobu zasad.

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

PolicySettings

Definiuje ustawienia konfiguracji webApplicationFirewallPolicy najwyższego poziomu.

Name Type Description
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

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

mode

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

redirectUrl
  • string

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

requestBodyCheck

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

Definiuje identyfikator zasobu dla reguły routingu.

Name Type Description
id
  • string

Identyfikator zasobu.

RuleType

Opisuje typ reguły.

Name Type Description
MatchRule
  • string
RateLimitRule
  • string

Definiuje identyfikator zasobu dla zasad zabezpieczeń.

Name Type Description
id
  • string

Identyfikator zasobu.

Sku

Warstwa cenowa zasad zapory aplikacji internetowej.

Name Type Description
name

Nazwa warstwy cenowej.

SkuName

Nazwa warstwy cenowej.

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

WebApplicationFirewallPolicy

Definiuje zasady zapory aplikacji internetowej.

Name Type Description
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

Opisuje reguły niestandardowe wewnątrz zasad.

properties.frontendEndpointLinks

Opisuje punkty końcowe frontonu skojarzone z tą zasadą Web Application Firewall.

properties.managedRules

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

properties.policySettings

Opisuje ustawienia zasad.

properties.provisioningState
  • string

Stan aprowizacji zasad.

properties.resourceState

Stan zasobu zasad.

properties.routingRuleLinks

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

properties.securityPolicyLinks

Opisuje zasady zabezpieczeń skojarzone z zasadami Web Application Firewall.

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.