Policies - Get

Recuperare i criteri di protezione con il nome specificato all'interno di un gruppo di risorse.

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

Parametri dell'URI

Name In Required Type Description
policyName
path True
  • string

Nome del criterio di Web application firewall.

resourceGroupName
path True
  • string

Nome del gruppo di risorse all'interno della sottoscrizione di Azure.

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

subscriptionId
path True
  • string

Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True
  • string

Versione API client.

Risposte

Name Type Description
200 OK

OK. La richiesta ha avuto esito positivo.

Other Status Codes

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

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

Definizioni

ActionType

Definisce l'azione da eseguire sulla corrispondenza della regola.

CustomRule

Definisce il contenuto di una regola dell'applicazione Web

CustomRuleEnabledState

Descrive se la regola personalizzata è abilitata o disabilitata. Il valore predefinito è Abilitato se non specificato.

CustomRuleList

Definisce il contenuto delle regole personalizzate

ErrorResponse

Risposta errore indica che il servizio Frontdoor non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

FrontendEndpointLink

Definisce l'ID risorsa per un endpoint front-end.

ManagedRuleEnabledState

Descrive se la regola gestita è abilitata o disabilitata.

ManagedRuleExclusion

Escludere le variabili dalla valutazione delle regole gestite.

ManagedRuleExclusionMatchVariable

Tipo di variabile da escludere.

ManagedRuleExclusionSelectorMatchOperator

Operatore di confronto a cui applicare il selettore quando si specificano gli elementi nella raccolta a cui si applica questa esclusione.

ManagedRuleGroupOverride

Definisce un'impostazione di override del gruppo di regole gestite.

ManagedRuleOverride

Definisce un'impostazione di override del gruppo di regole gestite.

ManagedRuleSet

Definisce un set di regole gestite.

ManagedRuleSetActionType

Definisce l'azione da eseguire quando viene raggiunta la soglia del punteggio del set di regole gestite.

ManagedRuleSetList

Definisce l'elenco dei set di regole gestite per i criteri.

MatchCondition

Definire una condizione di corrispondenza.

MatchVariable

Richiedere una variabile da confrontare.

Operator

Tipo di confronto da usare per la corrispondenza con il valore della variabile.

PolicyEnabledState

Descrive se il criterio è in stato abilitato o disabilitato. Il valore predefinito è Abilitato se non specificato.

PolicyMode

Descrive se è in modalità di rilevamento o modalità di prevenzione a livello di criteri.

PolicyRequestBodyCheck

Descrive se le regole gestite dai criteri esaminano il contenuto del corpo della richiesta.

PolicyResourceState

Stato della risorsa del criterio.

PolicySettings

Definisce le impostazioni di configurazione webApplicationFirewallPolicy di primo livello.

RoutingRuleLink

Definisce l'ID risorsa per una regola di routing.

RuleType

Descrive il tipo di regola.

SecurityPolicyLink

Definisce l'ID risorsa per un criterio di sicurezza.

Sku

Piano tariffario dei criteri web application firewall.

SkuName

Nome del piano tariffario.

WebApplicationFirewallPolicy

Definisce i criteri web application firewall.

ActionType

Definisce l'azione da eseguire sulla corrispondenza della regola.

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

CustomRule

Definisce il contenuto di una regola dell'applicazione Web

Name Type Description
action

Descrive l'azione da applicare quando la regola corrisponde.

enabledState

Descrive se la regola personalizzata è abilitata o disabilitata. Il valore predefinito è Abilitato se non specificato.

matchConditions

Elenco di condizioni di corrispondenza.

name
  • string

Descrive il nome della regola.

priority
  • integer

Descrive la priorità della regola. Le regole con un valore inferiore verranno valutate prima delle regole con un valore più alto.

rateLimitDurationInMinutes
  • integer

Intervallo di tempo per la reimpostazione del conteggio dei limiti di frequenza. Il valore predefinito è 1 minuto.

rateLimitThreshold
  • integer

Numero di richieste consentite per client entro l'intervallo di tempo.

ruleType

Descrive il tipo di regola.

CustomRuleEnabledState

Descrive se la regola personalizzata è abilitata o disabilitata. Il valore predefinito è Abilitato se non specificato.

Name Type Description
Disabled
  • string
Enabled
  • string

CustomRuleList

Definisce il contenuto delle regole personalizzate

Name Type Description
rules

Elenco di regole

ErrorResponse

Risposta errore indica che il servizio Frontdoor non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Name Type Description
code
  • string

Codice di errore.

message
  • string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

Definisce l'ID risorsa per un endpoint front-end.

Name Type Description
id
  • string

ID risorsa.

ManagedRuleEnabledState

Descrive se la regola gestita è abilitata o disabilitata.

Name Type Description
Disabled
  • string
Enabled
  • string

ManagedRuleExclusion

Escludere le variabili dalla valutazione delle regole gestite.

Name Type Description
matchVariable

Tipo di variabile da escludere.

selector
  • string

Valore del selettore a cui si applicano gli elementi della raccolta a cui si applica questa esclusione.

selectorMatchOperator

Operatore di confronto a cui applicare il selettore quando si specificano gli elementi nella raccolta a cui si applica questa esclusione.

ManagedRuleExclusionMatchVariable

Tipo di variabile da escludere.

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

ManagedRuleExclusionSelectorMatchOperator

Operatore di confronto a cui applicare il selettore quando si specificano gli elementi nella raccolta a cui si applica questa esclusione.

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

ManagedRuleGroupOverride

Definisce un'impostazione di override del gruppo di regole gestite.

Name Type Description
exclusions

Descrive le esclusioni applicate a tutte le regole del gruppo.

ruleGroupName
  • string

Descrive il gruppo di regole gestite da sostituire.

rules

Elenco di regole che verranno disabilitate. Se non è specificato alcun valore, tutte le regole nel gruppo verranno disabilitate.

ManagedRuleOverride

Definisce un'impostazione di override del gruppo di regole gestite.

Name Type Description
action

Descrive l'azione di override da applicare quando la regola corrisponde.

enabledState

Descrive se la regola gestita è abilitata o disabilitata. Il valore predefinito è Disabilitato se non specificato.

exclusions

Descrive le esclusioni applicate a questa regola specifica.

ruleId
  • string

Identificatore della regola gestita.

ManagedRuleSet

Definisce un set di regole gestite.

Name Type Description
exclusions

Descrive le esclusioni applicate a tutte le regole nel set.

ruleGroupOverrides

Definisce le sostituzioni del gruppo di regole da applicare al set di regole.

ruleSetAction

Definisce l'azione da eseguire quando viene raggiunta la soglia del punteggio del set di regole gestite.

ruleSetType
  • string

Definisce il tipo di set di regole da utilizzare.

ruleSetVersion
  • string

Definisce la versione del set di regole da usare.

ManagedRuleSetActionType

Definisce l'azione da eseguire quando viene raggiunta la soglia del punteggio del set di regole gestite.

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

ManagedRuleSetList

Definisce l'elenco dei set di regole gestite per i criteri.

Name Type Description
managedRuleSets

Elenco di set di regole.

MatchCondition

Definire una condizione di corrispondenza.

Name Type Description
matchValue
  • string[]

Elenco dei valori di corrispondenza possibili.

matchVariable

Richiedere una variabile da confrontare.

negateCondition
  • boolean

Descrive se il risultato di questa condizione deve essere negato.

operator

Tipo di confronto da usare per la corrispondenza con il valore della variabile.

selector
  • string

Trova la corrispondenza con una chiave specifica dalle variabili QueryString, PostArgs, RequestHeader o Cookies. Il valore predefinito è null.

transforms
  • string[]

Elenco di trasformazioni.

MatchVariable

Richiedere una variabile da confrontare.

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

Operator

Tipo di confronto da usare per la corrispondenza con il valore della variabile.

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

Descrive se il criterio è in stato abilitato o disabilitato. Il valore predefinito è Abilitato se non specificato.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyMode

Descrive se è in modalità di rilevamento o modalità di prevenzione a livello di criteri.

Name Type Description
Detection
  • string
Prevention
  • string

PolicyRequestBodyCheck

Descrive se le regole gestite dai criteri esaminano il contenuto del corpo della richiesta.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyResourceState

Stato della risorsa del criterio.

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

PolicySettings

Definisce le impostazioni di configurazione webApplicationFirewallPolicy di primo livello.

Name Type Description
customBlockResponseBody
  • string

Se il tipo di azione è bloccato, il cliente può eseguire l'override del corpo della risposta. Il corpo deve essere specificato nella codifica base64.

customBlockResponseStatusCode
  • integer

Se il tipo di azione è bloccato, il cliente può eseguire l'override del codice di stato della risposta.

enabledState

Descrive se il criterio è in stato abilitato o disabilitato. Il valore predefinito è Abilitato se non specificato.

mode

Descrive se è in modalità di rilevamento o modalità di prevenzione a livello di criteri.

redirectUrl
  • string

Se il tipo di azione è reindirizzato, questo campo rappresenta l'URL di reindirizzamento per il client.

requestBodyCheck

Descrive se le regole gestite dai criteri esaminano il contenuto del corpo della richiesta.

Definisce l'ID risorsa per una regola di routing.

Name Type Description
id
  • string

ID risorsa.

RuleType

Descrive il tipo di regola.

Name Type Description
MatchRule
  • string
RateLimitRule
  • string

Definisce l'ID risorsa per un criterio di sicurezza.

Name Type Description
id
  • string

ID risorsa.

Sku

Piano tariffario dei criteri web application firewall.

Name Type Description
name

Nome del piano tariffario.

SkuName

Nome del piano tariffario.

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

WebApplicationFirewallPolicy

Definisce i criteri web application firewall.

Name Type Description
etag
  • string

Ottiene una stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.

id
  • string

ID risorsa.

location
  • string

Percorso della risorsa.

name
  • string

Nome risorsa.

properties.customRules

Descrive le regole personalizzate all'interno dei criteri.

properties.frontendEndpointLinks

Descrive gli endpoint front-end associati a questo criterio di Web application firewall.

properties.managedRules

Descrive le regole gestite all'interno dei criteri.

properties.policySettings

Descrive le impostazioni per i criteri.

properties.provisioningState
  • string

Stato di provisioning dei criteri.

properties.resourceState

Stato della risorsa del criterio.

properties.routingRuleLinks

Descrive le regole di routing associate a questo criterio di Web application firewall.

properties.securityPolicyLinks

Descrive i criteri di sicurezza associati a questo criterio di Web application firewall.

sku

Piano tariffario dei criteri web application firewall. Il valore predefinito è Classic_AzureFrontDoor se non specificato.

tags
  • object

Tag delle risorse.

type
  • string

Tipo di risorsa.