Policies - Get

Lekérheti a megadott nevű védelmi szabályzatot egy erőforráscsoporton belül.

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

URI-paraméterek

Name In Required Type Description
policyName
path True
  • string

A Web Application Firewall Házirend neve.

resourceGroupName
path True
  • string

Az Azure-előfizetésben található erőforráscsoport neve.

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

subscriptionId
path True
  • string

Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják az Microsoft Azure-előfizetést. Az előfizetés-azonosító minden szolgáltatáshívás URI-jának részét képezi.

api-version
query True
  • string

Ügyfél API-verziója.

Válaszok

Name Type Description
200 OK

OK gombra. A kérés sikeres volt.

Other Status Codes

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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 felhasználói fiók megszemélyesítése

Példák

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

Definíciók

ActionType

Meghatározza a szabályegyeztetés során végrehajtandó műveletet.

CustomRule

Webalkalmazás-szabály tartalmának meghatározása

CustomRuleEnabledState

Azt ismerteti, hogy az egyéni szabály engedélyezve vagy letiltva van-e. Alapértelmezés szerint engedélyezve van, ha nincs megadva.

CustomRuleList

Egyéni szabályok tartalmának meghatározása

ErrorResponse

A hibaüzenet azt jelzi, hogy a Front Door szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenetben adták meg.

FrontendEndpointLink

Meghatározza az előtérbeli végpont erőforrás-azonosítóját.

ManagedRuleEnabledState

Azt ismerteti, hogy a felügyelt szabály engedélyezett vagy letiltott állapotban van-e.

ManagedRuleExclusion

Változók kizárása a felügyelt szabályok kiértékeléséből.

ManagedRuleExclusionMatchVariable

A kizárandó változótípus.

ManagedRuleExclusionSelectorMatchOperator

Összehasonlító operátor, amelyre a választóra alkalmazni kell, amikor megadja, hogy a gyűjtemény mely elemeire vonatkozik ez a kizárás.

ManagedRuleGroupOverride

Definiál egy felügyelt szabálycsoport felülbírálási beállítását.

ManagedRuleOverride

Definiál egy felügyelt szabálycsoport felülbírálási beállítását.

ManagedRuleSet

Definiál egy felügyelt szabálykészletet.

ManagedRuleSetActionType

Meghatározza, hogy milyen műveletet kell elvégezni egy felügyelt szabálykészlet pontszámküszöbének elérésekor.

ManagedRuleSetList

Meghatározza a szabályzathoz tartozó felügyelt szabálykészletek listáját.

MatchCondition

Egyezés feltételének meghatározása.

MatchVariable

Összehasonlítani kívánt változó kérése.

Operator

A változó értékével való egyeztetéshez használandó összehasonlítási típus.

PolicyEnabledState

Azt ismerteti, hogy a szabályzat engedélyezve vagy letiltva van-e. Alapértelmezés szerint engedélyezve van, ha nincs megadva.

PolicyMode

Ismerteti, hogy észlelési vagy megelőzési módban van-e szabályzatszinten.

PolicyRequestBodyCheck

Azt ismerteti, hogy a szabályzat által felügyelt szabályok ellenőrzik-e a kérelem törzsének tartalmát.

PolicyResourceState

A szabályzat erőforrás-állapota.

PolicySettings

Meghatározza a WebApplicationFirewallPolicy legfelső szintű konfigurációs beállításait.

RoutingRuleLink

Meghatározza az útválasztási szabály erőforrás-azonosítóját.

RuleType

A szabály típusát ismerteti.

SecurityPolicyLink

Meghatározza egy biztonsági szabályzat erőforrás-azonosítóját.

Sku

A webalkalmazás tűzfalszabályzatának tarifacsomagja.

SkuName

A tarifacsomag neve.

WebApplicationFirewallPolicy

Webalkalmazási tűzfalszabályzatot definiál.

ActionType

Meghatározza a szabályegyeztetés során végrehajtandó műveletet.

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

CustomRule

Webalkalmazás-szabály tartalmának meghatározása

Name Type Description
action

Ismerteti, hogy milyen műveletet kell alkalmazni a szabály egyezése esetén.

enabledState

Azt ismerteti, hogy az egyéni szabály engedélyezve vagy letiltva van-e. Alapértelmezés szerint engedélyezve van, ha nincs megadva.

matchConditions

Az egyezés feltételeinek listája.

name
  • string

A szabály nevét írja le.

priority
  • integer

A szabály prioritását ismerteti. Az alacsonyabb értékű szabályok kiértékelése a magasabb értékkel rendelkező szabályok előtt történik.

rateLimitDurationInMinutes
  • integer

A sebességkorlátok számának alaphelyzetbe állításához szükséges időkeret. Az alapértelmezett érték 1 perc.

rateLimitThreshold
  • integer

Az engedélyezett kérelmek száma ügyfélenként az időkereten belül.

ruleType

A szabály típusát ismerteti.

CustomRuleEnabledState

Azt ismerteti, hogy az egyéni szabály engedélyezve vagy letiltva van-e. Alapértelmezés szerint engedélyezve van, ha nincs megadva.

Name Type Description
Disabled
  • string
Enabled
  • string

CustomRuleList

Egyéni szabályok tartalmának meghatározása

Name Type Description
rules

Szabályok listája

ErrorResponse

A hibaüzenet azt jelzi, hogy a Front Door szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenetben adták meg.

Name Type Description
code
  • string

Hibakód.

message
  • string

Hibaüzenet, amely jelzi, hogy a művelet miért hiúsult meg.

Meghatározza az előtérbeli végpont erőforrás-azonosítóját.

Name Type Description
id
  • string

Erőforrás-azonosító.

ManagedRuleEnabledState

Azt ismerteti, hogy a felügyelt szabály engedélyezett vagy letiltott állapotban van-e.

Name Type Description
Disabled
  • string
Enabled
  • string

ManagedRuleExclusion

Változók kizárása a felügyelt szabályok kiértékeléséből.

Name Type Description
matchVariable

A kizárandó változótípus.

selector
  • string

A gyűjtemény azon elemeinek választóértéke, amelyekre ez a kizárás vonatkozik.

selectorMatchOperator

Összehasonlító operátor, amelyre a választóra alkalmazni kell, amikor megadja, hogy a gyűjtemény mely elemeire vonatkozik ez a kizárás.

ManagedRuleExclusionMatchVariable

A kizárandó változótípus.

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

ManagedRuleExclusionSelectorMatchOperator

Összehasonlító operátor, amelyre a választóra alkalmazni kell, amikor megadja, hogy a gyűjtemény mely elemeire vonatkozik ez a kizárás.

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

ManagedRuleGroupOverride

Definiál egy felügyelt szabálycsoport felülbírálási beállítását.

Name Type Description
exclusions

A csoport összes szabályára alkalmazott kizárásokat ismerteti.

ruleGroupName
  • string

A felülbírálandó felügyelt szabálycsoport ismertetése.

rules

A letiltott szabályok listája. Ha nincs megadva, a csoport összes szabálya le lesz tiltva.

ManagedRuleOverride

Definiál egy felügyelt szabálycsoport felülbírálási beállítását.

Name Type Description
action

A szabály egyezésekor alkalmazandó felülbírálási műveletet ismerteti.

enabledState

Azt ismerteti, hogy a felügyelt szabály engedélyezett vagy letiltott állapotban van-e. Alapértelmezés szerint letiltva, ha nincs megadva.

exclusions

Az adott szabályra alkalmazott kizárásokat ismerteti.

ruleId
  • string

A felügyelt szabály azonosítója.

ManagedRuleSet

Definiál egy felügyelt szabálykészletet.

Name Type Description
exclusions

A halmaz összes szabályára alkalmazott kizárásokat ismerteti.

ruleGroupOverrides

Meghatározza a szabálykészletre alkalmazandó szabálycsoport-felülbírálásokat.

ruleSetAction

Meghatározza, hogy milyen műveletet kell elvégezni egy felügyelt szabálykészlet pontszámküszöbének elérésekor.

ruleSetType
  • string

Meghatározza a használni kívánt szabálykészlet típusát.

ruleSetVersion
  • string

Meghatározza a használni kívánt szabályverziót.

ManagedRuleSetActionType

Meghatározza, hogy milyen műveletet kell elvégezni egy felügyelt szabálykészlet pontszámküszöbének elérésekor.

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

ManagedRuleSetList

Meghatározza a szabályzathoz tartozó felügyelt szabálykészletek listáját.

Name Type Description
managedRuleSets

Szabálykészletek listája.

MatchCondition

Egyezés feltételének meghatározása.

Name Type Description
matchValue
  • string[]

A lehetséges egyezésértékek listája.

matchVariable

Összehasonlítani kívánt változó kérése.

negateCondition
  • boolean

Azt ismerteti, hogy a feltétel eredményét negated kell-e.

operator

A változó értékével való egyeztetéshez használandó összehasonlítási típus.

selector
  • string

Egyezzen a QueryString, PostArgs, RequestHeader vagy Cookies változók adott kulcsával. Az alapértelmezett érték null.

transforms
  • string[]

Az átalakítások listája.

MatchVariable

Összehasonlítani kívánt változó kérése.

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

Operator

A változó értékével való egyeztetéshez használandó összehasonlítási típus.

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

Azt ismerteti, hogy a szabályzat engedélyezve vagy letiltva van-e. Alapértelmezés szerint engedélyezve van, ha nincs megadva.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyMode

Ismerteti, hogy észlelési vagy megelőzési módban van-e szabályzatszinten.

Name Type Description
Detection
  • string
Prevention
  • string

PolicyRequestBodyCheck

Azt ismerteti, hogy a szabályzat által felügyelt szabályok ellenőrzik-e a kérelem törzsének tartalmát.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyResourceState

A szabályzat erőforrás-állapota.

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

PolicySettings

Meghatározza a WebApplicationFirewallPolicy legfelső szintű konfigurációs beállításait.

Name Type Description
customBlockResponseBody
  • string

Ha a művelettípus blokkolva van, az ügyfél felülbírálhatja a válasz törzsét. A törzset base64 kódolásban kell megadni.

customBlockResponseStatusCode
  • integer

Ha a művelet típusa blokkolva van, az ügyfél felülbírálhatja a válasz állapotkódját.

enabledState

Azt ismerteti, hogy a szabályzat engedélyezve vagy letiltva van-e. Alapértelmezés szerint engedélyezve van, ha nincs megadva.

mode

Ismerteti, hogy észlelési vagy megelőzési módban van-e szabályzatszinten.

redirectUrl
  • string

Ha a művelet típusa átirányítás, ez a mező az ügyfél átirányítási URL-címét jelöli.

requestBodyCheck

Azt ismerteti, hogy a szabályzat által felügyelt szabályok ellenőrzik-e a kérelem törzsének tartalmát.

Meghatározza az útválasztási szabály erőforrás-azonosítóját.

Name Type Description
id
  • string

Erőforrás-azonosító.

RuleType

A szabály típusát ismerteti.

Name Type Description
MatchRule
  • string
RateLimitRule
  • string

Meghatározza egy biztonsági szabályzat erőforrás-azonosítóját.

Name Type Description
id
  • string

Erőforrás-azonosító.

Sku

A webalkalmazás tűzfalszabályzatának tarifacsomagja.

Name Type Description
name

A tarifacsomag neve.

SkuName

A tarifacsomag neve.

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

WebApplicationFirewallPolicy

Webalkalmazási tűzfalszabályzatot definiál.

Name Type Description
etag
  • string

Lekér egy egyedi írásvédett sztringet, amely az erőforrás frissítésekor változik.

id
  • string

Erőforrás-azonosító.

location
  • string

Erőforrás helye.

name
  • string

Erőforrás neve.

properties.customRules

A szabályzaton belüli egyéni szabályokat ismerteti.

properties.frontendEndpointLinks

A Web Application Firewall házirendhez társított előtérbeli végpontokat ismerteti.

properties.managedRules

A szabályzaton belüli felügyelt szabályokat ismerteti.

properties.policySettings

A szabályzat beállításait ismerteti.

properties.provisioningState
  • string

A szabályzat kiépítési állapota.

properties.resourceState

A szabályzat erőforrás-állapota.

properties.routingRuleLinks

A Web Application Firewall házirendhez társított útválasztási szabályokat ismerteti.

properties.securityPolicyLinks

A Web Application Firewall házirendhez társított biztonsági házirendet ismerteti.

sku

A webalkalmazási tűzfalszabályzat tarifacsomagja. Alapértelmezés szerint Classic_AzureFrontDoor, ha nincs megadva.

tags
  • object

Erőforráscímkék.

type
  • string

Erőforrástípus.