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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
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 di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True

string

Versione API client.

Risposte

Nome Tipo Descrizione
200 OK

WebApplicationFirewallPolicy

OK. La richiesta ha avuto esito positivo.

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

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

Definizioni

Nome Descrizione
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. Impostazione predefinita Abilitata se non specificata.

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 da applicare al selettore quando si specificano gli elementi della 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 soddisfatta una soglia del punteggio del set di regole gestite.

ManagedRuleSetList

Definisce l'elenco dei set di regole gestite per il criterio.

MatchCondition

Definire una condizione di corrispondenza.

MatchVariable

Richiedere una variabile da confrontare con.

Operator

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

PolicyEnabledState

Descrive se il criterio è abilitato o disabilitato. Impostazione predefinita Abilitata se non specificata.

PolicyMode

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

PolicyRequestBodyCheck

Descrive se le regole gestite dai criteri controllano 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 del web application firewall.

SkuName

Nome del piano tariffario.

TransformType

Descrive le trasformazioni applicate prima della corrispondenza.

WebApplicationFirewallPolicy

Definisce i criteri del web application firewall.

ActionType

Definisce l'azione da eseguire sulla corrispondenza della regola.

Nome Tipo Descrizione
Allow

string

AnomalyScoring

string

Block

string

Log

string

Redirect

string

CustomRule

Definisce il contenuto di una regola dell'applicazione Web

Nome Tipo Descrizione
action

ActionType

Descrive l'azione da applicare quando la regola corrisponde.

enabledState

CustomRuleEnabledState

Descrive se la regola personalizzata è abilitata o disabilitata. Impostazione predefinita Abilitata se non specificata.

matchConditions

MatchCondition[]

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

rateLimitDurationInMinutes

integer

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

rateLimitThreshold

integer

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

ruleType

RuleType

Descrive il tipo di regola.

CustomRuleEnabledState

Descrive se la regola personalizzata è abilitata o disabilitata. Impostazione predefinita Abilitata se non specificata.

Nome Tipo Descrizione
Disabled

string

Enabled

string

CustomRuleList

Definisce il contenuto delle regole personalizzate

Nome Tipo Descrizione
rules

CustomRule[]

Elenco delle 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.

Nome Tipo Descrizione
code

string

Codice di errore.

message

string

Messaggio di errore che indica perché l'operazione non è riuscita.

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

Nome Tipo Descrizione
id

string

ID risorsa.

ManagedRuleEnabledState

Descrive se la regola gestita è abilitata o disabilitata.

Nome Tipo Descrizione
Disabled

string

Enabled

string

ManagedRuleExclusion

Escludere le variabili dalla valutazione delle regole gestite.

Nome Tipo Descrizione
matchVariable

ManagedRuleExclusionMatchVariable

Tipo di variabile da escludere.

selector

string

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

selectorMatchOperator

ManagedRuleExclusionSelectorMatchOperator

Operatore di confronto da applicare al selettore quando si specificano gli elementi della raccolta a cui si applica questa esclusione.

ManagedRuleExclusionMatchVariable

Tipo di variabile da escludere.

Nome Tipo Descrizione
QueryStringArgNames

string

RequestBodyJsonArgNames

string

RequestBodyPostArgNames

string

RequestCookieNames

string

RequestHeaderNames

string

ManagedRuleExclusionSelectorMatchOperator

Operatore di confronto da applicare al selettore quando si specificano gli elementi della raccolta a cui si applica questa esclusione.

Nome Tipo Descrizione
Contains

string

EndsWith

string

Equals

string

EqualsAny

string

StartsWith

string

ManagedRuleGroupOverride

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

Nome Tipo Descrizione
exclusions

ManagedRuleExclusion[]

Descrive le esclusioni applicate a tutte le regole del gruppo.

ruleGroupName

string

Descrive il gruppo di regole gestite da eseguire l'override.

rules

ManagedRuleOverride[]

Elenco di regole che verranno disabilitate. Se non specificato, tutte le regole del gruppo verranno disabilitate.

ManagedRuleOverride

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

Nome Tipo Descrizione
action

ActionType

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

enabledState

ManagedRuleEnabledState

Descrive se la regola gestita è abilitata o disabilitata. Impostazione predefinita disabilitata se non specificata.

exclusions

ManagedRuleExclusion[]

Descrive le esclusioni applicate a questa regola specifica.

ruleId

string

Identificatore per la regola gestita.

ManagedRuleSet

Definisce un set di regole gestite.

Nome Tipo Descrizione
exclusions

ManagedRuleExclusion[]

Descrive le esclusioni applicate a tutte le regole nel set.

ruleGroupOverrides

ManagedRuleGroupOverride[]

Definisce gli overridi del gruppo di regole da applicare al set di regole.

ruleSetAction

ManagedRuleSetActionType

ruleSetAction
Definisce l'azione del set di regole.

ruleSetType

string

Definisce il tipo di set di regole da usare.

ruleSetVersion

string

Definisce la versione del set di regole da usare.

ManagedRuleSetActionType

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

Nome Tipo Descrizione
Block

string

Log

string

Redirect

string

ManagedRuleSetList

Definisce l'elenco dei set di regole gestite per il criterio.

Nome Tipo Descrizione
managedRuleSets

ManagedRuleSet[]

Elenco dei set di regole.

MatchCondition

Definire una condizione di corrispondenza.

Nome Tipo Descrizione
matchValue

string[]

Elenco dei valori di corrispondenza possibili.

matchVariable

MatchVariable

Richiedere una variabile da confrontare con.

negateCondition

boolean

Descrive se il risultato di questa condizione deve essere negato.

operator

Operator

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

selector

string

Corrisponde a una chiave specifica dalle variabili QueryString, PostArgs, RequestHeader o Cookies. Il valore predefinito è null.

transforms

TransformType[]

Elenco di trasformazioni.

MatchVariable

Richiedere una variabile da confrontare con.

Nome Tipo Descrizione
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.

Nome Tipo Descrizione
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 è abilitato o disabilitato. Impostazione predefinita Abilitata se non specificata.

Nome Tipo Descrizione
Disabled

string

Enabled

string

PolicyMode

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

Nome Tipo Descrizione
Detection

string

Prevention

string

PolicyRequestBodyCheck

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

Nome Tipo Descrizione
Disabled

string

Enabled

string

PolicyResourceState

Stato della risorsa del criterio.

Nome Tipo Descrizione
Creating

string

Deleting

string

Disabled

string

Disabling

string

Enabled

string

Enabling

string

PolicySettings

Definisce le impostazioni di configurazione WebApplicationFirewallPolicy di primo livello.

Nome Tipo Descrizione
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

PolicyEnabledState

Descrive se il criterio è abilitato o disabilitato. Impostazione predefinita Abilitata se non specificata.

mode

PolicyMode

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

redirectUrl

string

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

requestBodyCheck

PolicyRequestBodyCheck

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

Definisce l'ID risorsa per una regola di routing.

Nome Tipo Descrizione
id

string

ID risorsa.

RuleType

Descrive il tipo di regola.

Nome Tipo Descrizione
MatchRule

string

RateLimitRule

string

Definisce l'ID risorsa per un criterio di sicurezza.

Nome Tipo Descrizione
id

string

ID risorsa.

Sku

Piano tariffario dei criteri del web application firewall.

Nome Tipo Descrizione
name

SkuName

Nome del piano tariffario.

SkuName

Nome del piano tariffario.

Nome Tipo Descrizione
Classic_AzureFrontDoor

string

Premium_AzureFrontDoor

string

Standard_AzureFrontDoor

string

TransformType

Descrive le trasformazioni applicate prima della corrispondenza.

Nome Tipo Descrizione
Lowercase

string

RemoveNulls

string

Trim

string

Uppercase

string

UrlDecode

string

UrlEncode

string

WebApplicationFirewallPolicy

Definisce i criteri del web application firewall.

Nome Tipo Descrizione
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

CustomRuleList

Descrive le regole personalizzate all'interno dei criteri.

properties.frontendEndpointLinks

FrontendEndpointLink[]

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

properties.managedRules

ManagedRuleSetList

Descrive le regole gestite all'interno dei criteri.

properties.policySettings

PolicySettings

Descrive le impostazioni per il criterio.

properties.provisioningState

string

Stato di provisioning dei criteri.

properties.resourceState

PolicyResourceState

Stato della risorsa del criterio.

properties.routingRuleLinks

RoutingRuleLink[]

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

properties.securityPolicyLinks

SecurityPolicyLink[]

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

sku

Sku

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

tags

object

Tag di risorse.

type

string

Tipo di risorsa.