Policies - Get

Recupere a política de proteção com o nome especificado em um grupo de recursos.

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

Parâmetros de URI

Name In Required Type Description
policyName
path True
  • string

O nome da Política de Firewall de Aplicativo Web.

resourceGroupName
path True
  • string

Nome do grupo de recursos na assinatura do Azure.

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

subscriptionId
path True
  • string

As credenciais de assinatura que identificam exclusivamente a assinatura Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão de API do cliente.

Respostas

Name Type Description
200 OK

OK. A solicitação foi bem-sucedida.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

ActionType

Define a ação a ser tomada na correspondência de regras.

CustomRule

Define o conteúdo de uma regra de aplicativo Web

CustomRuleEnabledState

Descreve se a regra personalizada está habilitada ou desabilitada. O padrão será Habilitado se não for especificado.

CustomRuleList

Define o conteúdo de regras personalizadas

ErrorResponse

A resposta de erro indica que o serviço Front Door não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

FrontendEndpointLink

Define a ID do recurso para um ponto de extremidade de front-end.

ManagedRuleEnabledState

Descreve se a regra gerenciada está habilitada ou desabilitada.

ManagedRuleExclusion

Exclua variáveis da avaliação de regra gerenciada.

ManagedRuleExclusionMatchVariable

O tipo de variável a ser excluído.

ManagedRuleExclusionSelectorMatchOperator

Operador de comparação a ser aplicado ao seletor ao especificar a quais elementos na coleção essa exclusão se aplica.

ManagedRuleGroupOverride

Define uma configuração de substituição de grupo de regras gerenciada.

ManagedRuleOverride

Define uma configuração de substituição de grupo de regras gerenciada.

ManagedRuleSet

Define um conjunto de regras gerenciadas.

ManagedRuleSetActionType

Define a ação a ser executada quando um limite de pontuação do conjunto de regras gerenciada é atingido.

ManagedRuleSetList

Define a lista de conjuntos de regras gerenciadas para a política.

MatchCondition

Defina uma condição de correspondência.

MatchVariable

Variável de solicitação com a qual comparar.

Operator

Tipo de comparação a ser usado para correspondência com o valor da variável.

PolicyEnabledState

Descreve se a política está habilitada ou desabilitada. O padrão será Habilitado se não for especificado.

PolicyMode

Descreve se ele está no modo de detecção ou no modo de prevenção no nível da política.

PolicyRequestBodyCheck

Descreve se as regras gerenciadas por política inspecionarão o conteúdo do corpo da solicitação.

PolicyResourceState

Status do recurso da política.

PolicySettings

Define as configurações do WebApplicationFirewallPolicy de nível superior.

RoutingRuleLink

Define a ID do recurso para uma regra de roteamento.

RuleType

Descreve o tipo de regra.

SecurityPolicyLink

Define a ID do recurso para uma política de segurança.

Sku

O tipo de preço da política de firewall do aplicativo Web.

SkuName

Nome do tipo de preço.

WebApplicationFirewallPolicy

Define a política de firewall do aplicativo Web.

ActionType

Define a ação a ser tomada na correspondência de regras.

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

CustomRule

Define o conteúdo de uma regra de aplicativo Web

Name Type Description
action

Descreve qual ação a ser aplicada quando a regra corresponde.

enabledState

Descreve se a regra personalizada está habilitada ou desabilitada. O padrão será Habilitado se não for especificado.

matchConditions

Lista de condições de correspondência.

name
  • string

Descreve o nome da regra.

priority
  • integer

Descreve a prioridade da regra. As regras com um valor inferior serão avaliadas antes das regras com um valor mais alto.

rateLimitDurationInMinutes
  • integer

Janela de tempo para redefinir a contagem de limite de taxa. O padrão é 1 minuto.

rateLimitThreshold
  • integer

Número de solicitações permitidas por cliente dentro da janela de tempo.

ruleType

Descreve o tipo de regra.

CustomRuleEnabledState

Descreve se a regra personalizada está habilitada ou desabilitada. O padrão será Habilitado se não for especificado.

Name Type Description
Disabled
  • string
Enabled
  • string

CustomRuleList

Define o conteúdo de regras personalizadas

Name Type Description
rules

Lista de regras

ErrorResponse

A resposta de erro indica que o serviço Front Door não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Mensagem de erro indicando por que a operação falhou.

Define a ID do recurso para um ponto de extremidade de front-end.

Name Type Description
id
  • string

ID do recurso.

ManagedRuleEnabledState

Descreve se a regra gerenciada está habilitada ou desabilitada.

Name Type Description
Disabled
  • string
Enabled
  • string

ManagedRuleExclusion

Exclua variáveis da avaliação de regra gerenciada.

Name Type Description
matchVariable

O tipo de variável a ser excluído.

selector
  • string

Valor do seletor ao qual os elementos na coleção a que essa exclusão se aplica.

selectorMatchOperator

Operador de comparação a ser aplicado ao seletor ao especificar a quais elementos na coleção essa exclusão se aplica.

ManagedRuleExclusionMatchVariable

O tipo de variável a ser excluído.

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

ManagedRuleExclusionSelectorMatchOperator

Operador de comparação a ser aplicado ao seletor ao especificar a quais elementos na coleção essa exclusão se aplica.

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

ManagedRuleGroupOverride

Define uma configuração de substituição de grupo de regras gerenciada.

Name Type Description
exclusions

Descreve as exclusões aplicadas a todas as regras do grupo.

ruleGroupName
  • string

Descreve o grupo de regras gerenciadas a ser substituído.

rules

Lista de regras que serão desabilitadas. Se nenhuma especificada, todas as regras no grupo serão desabilitadas.

ManagedRuleOverride

Define uma configuração de substituição de grupo de regras gerenciada.

Name Type Description
action

Descreve a ação de substituição a ser aplicada quando a regra corresponde.

enabledState

Descreve se a regra gerenciada está habilitada ou desabilitada. O padrão será Desabilitado se não for especificado.

exclusions

Descreve as exclusões aplicadas a essa regra específica.

ruleId
  • string

Identificador para a regra gerenciada.

ManagedRuleSet

Define um conjunto de regras gerenciadas.

Name Type Description
exclusions

Descreve as exclusões aplicadas a todas as regras no conjunto.

ruleGroupOverrides

Define as substituições do grupo de regras a serem aplicadas ao conjunto de regras.

ruleSetAction

Define a ação a ser executada quando um limite de pontuação do conjunto de regras gerenciada é atingido.

ruleSetType
  • string

Define o tipo de conjunto de regras a ser usado.

ruleSetVersion
  • string

Define a versão do conjunto de regras a ser usado.

ManagedRuleSetActionType

Define a ação a ser executada quando um limite de pontuação do conjunto de regras gerenciada é atingido.

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

ManagedRuleSetList

Define a lista de conjuntos de regras gerenciadas para a política.

Name Type Description
managedRuleSets

Lista de conjuntos de regras.

MatchCondition

Defina uma condição de correspondência.

Name Type Description
matchValue
  • string[]

Lista de possíveis valores de correspondência.

matchVariable

Variável de solicitação com a qual comparar.

negateCondition
  • boolean

Descreve se o resultado dessa condição deve ser negado.

operator

Tipo de comparação a ser usado para correspondência com o valor da variável.

selector
  • string

Corresponda a uma chave específica das variáveis QueryString, PostArgs, RequestHeader ou Cookies. O padrão é nulo.

transforms
  • string[]

Lista de transformações.

MatchVariable

Variável de solicitação com a qual comparar.

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

Operator

Tipo de comparação a ser usado para correspondência com o valor da variável.

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

Descreve se a política está habilitada ou desabilitada. O padrão será Habilitado se não for especificado.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyMode

Descreve se ele está no modo de detecção ou no modo de prevenção no nível da política.

Name Type Description
Detection
  • string
Prevention
  • string

PolicyRequestBodyCheck

Descreve se as regras gerenciadas por política inspecionarão o conteúdo do corpo da solicitação.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyResourceState

Status do recurso da política.

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

PolicySettings

Define as configurações do WebApplicationFirewallPolicy de nível superior.

Name Type Description
customBlockResponseBody
  • string

Se o tipo de ação for bloqueado, o cliente poderá substituir o corpo da resposta. O corpo deve ser especificado na codificação base64.

customBlockResponseStatusCode
  • integer

Se o tipo de ação for bloqueado, o cliente poderá substituir o código de status de resposta.

enabledState

Descreve se a política está habilitada ou desabilitada. O padrão será Habilitado se não for especificado.

mode

Descreve se ele está no modo de detecção ou no modo de prevenção no nível da política.

redirectUrl
  • string

Se o tipo de ação for redirecionado, esse campo representará a URL de redirecionamento para o cliente.

requestBodyCheck

Descreve se as regras gerenciadas por política inspecionarão o conteúdo do corpo da solicitação.

Define a ID do recurso para uma regra de roteamento.

Name Type Description
id
  • string

ID do recurso.

RuleType

Descreve o tipo de regra.

Name Type Description
MatchRule
  • string
RateLimitRule
  • string

Define a ID do recurso para uma política de segurança.

Name Type Description
id
  • string

ID do recurso.

Sku

O tipo de preço da política de firewall do aplicativo Web.

Name Type Description
name

Nome do tipo de preço.

SkuName

Nome do tipo de preço.

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

WebApplicationFirewallPolicy

Define a política de firewall do aplicativo Web.

Name Type Description
etag
  • string

Obtém uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.

id
  • string

ID do recurso.

location
  • string

Local do recurso.

name
  • string

Nome do recurso.

properties.customRules

Descreve regras personalizadas dentro da política.

properties.frontendEndpointLinks

Descreve os pontos de extremidade de front-end associados a essa política de Firewall de Aplicativo Web.

properties.managedRules

Descreve as regras gerenciadas dentro da política.

properties.policySettings

Descreve as configurações da política.

properties.provisioningState
  • string

Estado de provisionamento da política.

properties.resourceState

Status do recurso da política.

properties.routingRuleLinks

Descreve as regras de roteamento associadas a essa política de Firewall de Aplicativo Web.

properties.securityPolicyLinks

Descreve a Política de Segurança associada a essa política de Firewall de Aplicativo Web.

sku

O tipo de preço da política de firewall do aplicativo Web. O padrão é Classic_AzureFrontDoor se não for especificado.

tags
  • object

Marcas de recurso.

type
  • string

Tipo de recurso.