Policies - Get

Ambil kebijakan perlindungan dengan nama yang ditentukan dalam grup sumber daya.

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

Parameter URI

Name In Required Type Description
policyName
path True
  • string

Nama Kebijakan Web Application Firewall.

resourceGroupName
path True
  • string

Nama grup Sumber Daya dalam langganan Azure.

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

subscriptionId
path True
  • string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True
  • string

Versi API klien.

Respons

Name Type Description
200 OK

OK. Permintaan telah berhasil.

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

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 meniru akun pengguna Anda

Contoh

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

Definisi

ActionType

Menentukan tindakan yang akan diambil pada kecocokan aturan.

CustomRule

Menentukan konten aturan aplikasi web

CustomRuleEnabledState

Menjelaskan apakah aturan kustom dalam status diaktifkan atau dinonaktifkan. Default ke Diaktifkan jika tidak ditentukan.

CustomRuleList

Menentukan konten aturan kustom

ErrorResponse

Respons kesalahan menunjukkan layanan Front Door tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

FrontendEndpointLink

Menentukan ID Sumber Daya untuk Titik Akhir Frontend.

ManagedRuleEnabledState

Menjelaskan apakah aturan terkelola dalam status diaktifkan atau dinonaktifkan.

ManagedRuleExclusion

Mengecualikan variabel dari evaluasi aturan terkelola.

ManagedRuleExclusionMatchVariable

Jenis variabel yang akan dikecualikan.

ManagedRuleExclusionSelectorMatchOperator

Operator perbandingan untuk diterapkan ke pemilih saat menentukan elemen mana dalam koleksi tempat pengecualian ini berlaku.

ManagedRuleGroupOverride

Menentukan pengaturan penimpaan grup aturan terkelola.

ManagedRuleOverride

Menentukan pengaturan penimpaan grup aturan terkelola.

ManagedRuleSet

Menentukan seperangkat aturan terkelola.

ManagedRuleSetActionType

Menentukan tindakan yang harus diambil saat ambang skor kumpulan aturan terkelola terpenuhi.

ManagedRuleSetList

Menentukan daftar seperangkat aturan terkelola untuk kebijakan.

MatchCondition

Tentukan kondisi kecocokan.

MatchVariable

Minta variabel untuk dibandingkan dengan.

Operator

Jenis perbandingan yang digunakan untuk pencocokan dengan nilai variabel.

PolicyEnabledState

Menjelaskan apakah kebijakan dalam status diaktifkan atau dinonaktifkan. Default ke Diaktifkan jika tidak ditentukan.

PolicyMode

Menjelaskan apakah dalam mode deteksi atau mode pencegahan pada tingkat kebijakan.

PolicyRequestBodyCheck

Menjelaskan apakah aturan terkelola kebijakan akan memeriksa konten isi permintaan.

PolicyResourceState

Status sumber daya kebijakan.

PolicySettings

Menentukan pengaturan konfigurasi WebApplicationFirewallPolicy tingkat atas.

RoutingRuleLink

Menentukan ID Sumber Daya untuk Aturan Perutean.

RuleType

Menjelaskan jenis aturan.

SecurityPolicyLink

Menentukan ID Sumber Daya untuk Kebijakan Keamanan.

Sku

Tingkat harga kebijakan firewall aplikasi web.

SkuName

Nama tingkat harga.

WebApplicationFirewallPolicy

Menentukan kebijakan firewall aplikasi web.

ActionType

Menentukan tindakan yang akan diambil pada kecocokan aturan.

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

CustomRule

Menentukan konten aturan aplikasi web

Name Type Description
action

Menjelaskan tindakan apa yang akan diterapkan saat aturan cocok.

enabledState

Menjelaskan apakah aturan kustom dalam status diaktifkan atau dinonaktifkan. Default ke Diaktifkan jika tidak ditentukan.

matchConditions

Daftar kondisi kecocokan.

name
  • string

Menjelaskan nama aturan.

priority
  • integer

Menjelaskan prioritas aturan. Aturan dengan nilai yang lebih rendah akan dievaluasi sebelum aturan dengan nilai yang lebih tinggi.

rateLimitDurationInMinutes
  • integer

Jendela waktu untuk mengatur ulang jumlah batas laju. Defaultnya adalah 1 menit.

rateLimitThreshold
  • integer

Jumlah permintaan yang diizinkan per klien dalam jendela waktu.

ruleType

Menjelaskan jenis aturan.

CustomRuleEnabledState

Menjelaskan apakah aturan kustom dalam status diaktifkan atau dinonaktifkan. Default ke Diaktifkan jika tidak ditentukan.

Name Type Description
Disabled
  • string
Enabled
  • string

CustomRuleList

Menentukan konten aturan kustom

Name Type Description
rules

Daftar aturan

ErrorResponse

Respons kesalahan menunjukkan layanan Front Door tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Name Type Description
code
  • string

Kode Kesalahan.

message
  • string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.

Menentukan ID Sumber Daya untuk Titik Akhir Frontend.

Name Type Description
id
  • string

ID Sumber Daya.

ManagedRuleEnabledState

Menjelaskan apakah aturan terkelola dalam status diaktifkan atau dinonaktifkan.

Name Type Description
Disabled
  • string
Enabled
  • string

ManagedRuleExclusion

Mengecualikan variabel dari evaluasi aturan terkelola.

Name Type Description
matchVariable

Jenis variabel yang akan dikecualikan.

selector
  • string

Nilai pemilih tempat elemen dalam koleksi pengecualian ini berlaku.

selectorMatchOperator

Operator perbandingan untuk diterapkan ke pemilih saat menentukan elemen mana dalam koleksi tempat pengecualian ini berlaku.

ManagedRuleExclusionMatchVariable

Jenis variabel yang akan dikecualikan.

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

ManagedRuleExclusionSelectorMatchOperator

Operator perbandingan untuk diterapkan ke pemilih saat menentukan elemen mana dalam koleksi tempat pengecualian ini berlaku.

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

ManagedRuleGroupOverride

Menentukan pengaturan penimpaan grup aturan terkelola.

Name Type Description
exclusions

Menjelaskan pengecualian yang diterapkan ke semua aturan dalam grup.

ruleGroupName
  • string

Menjelaskan grup aturan terkelola untuk diambil alih.

rules

Daftar aturan yang akan dinonaktifkan. Jika tidak ada yang ditentukan, semua aturan dalam grup akan dinonaktifkan.

ManagedRuleOverride

Menentukan pengaturan penimpaan grup aturan terkelola.

Name Type Description
action

Menjelaskan tindakan penimpaan yang akan diterapkan saat aturan cocok.

enabledState

Menjelaskan apakah aturan terkelola dalam status diaktifkan atau dinonaktifkan. Default ke Dinonaktifkan jika tidak ditentukan.

exclusions

Menjelaskan pengecualian yang diterapkan ke aturan khusus ini.

ruleId
  • string

Pengidentifikasi untuk aturan terkelola.

ManagedRuleSet

Menentukan seperangkat aturan terkelola.

Name Type Description
exclusions

Menjelaskan pengecualian yang diterapkan ke semua aturan dalam set.

ruleGroupOverrides

Menentukan penimpaan grup aturan untuk diterapkan ke seperangkat aturan.

ruleSetAction

Menentukan tindakan yang harus diambil saat ambang skor kumpulan aturan terkelola terpenuhi.

ruleSetType
  • string

Menentukan jenis seperangkat aturan yang akan digunakan.

ruleSetVersion
  • string

Menentukan versi seperangkat aturan yang akan digunakan.

ManagedRuleSetActionType

Menentukan tindakan yang harus diambil saat ambang skor kumpulan aturan terkelola terpenuhi.

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

ManagedRuleSetList

Menentukan daftar seperangkat aturan terkelola untuk kebijakan.

Name Type Description
managedRuleSets

Daftar seperangkat aturan.

MatchCondition

Tentukan kondisi kecocokan.

Name Type Description
matchValue
  • string[]

Daftar kemungkinan nilai kecocokan.

matchVariable

Minta variabel untuk dibandingkan dengan.

negateCondition
  • boolean

Menjelaskan apakah hasil kondisi ini harus dinegasikan.

operator

Jenis perbandingan yang digunakan untuk pencocokan dengan nilai variabel.

selector
  • string

Cocokkan dengan kunci tertentu dari variabel QueryString, PostArgs, RequestHeader, atau Cookies. Defaultnya adalah null.

transforms
  • string[]

Daftar transformasi.

MatchVariable

Minta variabel untuk dibandingkan dengan.

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

Operator

Jenis perbandingan yang digunakan untuk pencocokan dengan nilai variabel.

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

Menjelaskan apakah kebijakan dalam status diaktifkan atau dinonaktifkan. Default ke Diaktifkan jika tidak ditentukan.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyMode

Menjelaskan apakah dalam mode deteksi atau mode pencegahan pada tingkat kebijakan.

Name Type Description
Detection
  • string
Prevention
  • string

PolicyRequestBodyCheck

Menjelaskan apakah aturan terkelola kebijakan akan memeriksa konten isi permintaan.

Name Type Description
Disabled
  • string
Enabled
  • string

PolicyResourceState

Status sumber daya kebijakan.

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

PolicySettings

Menentukan pengaturan konfigurasi WebApplicationFirewallPolicy tingkat atas.

Name Type Description
customBlockResponseBody
  • string

Jika jenis tindakan diblokir, pelanggan dapat mengambil alih isi respons. Isi harus ditentukan dalam pengodean base64.

customBlockResponseStatusCode
  • integer

Jika jenis tindakan diblokir, pelanggan dapat mengambil alih kode status respons.

enabledState

Menjelaskan apakah kebijakan dalam status diaktifkan atau dinonaktifkan. Default ke Diaktifkan jika tidak ditentukan.

mode

Menjelaskan apakah dalam mode deteksi atau mode pencegahan pada tingkat kebijakan.

redirectUrl
  • string

Jika jenis tindakan dialihkan, bidang ini mewakili URL pengalihan untuk klien.

requestBodyCheck

Menjelaskan apakah aturan terkelola kebijakan akan memeriksa konten isi permintaan.

Menentukan ID Sumber Daya untuk Aturan Perutean.

Name Type Description
id
  • string

ID Sumber Daya.

RuleType

Menjelaskan jenis aturan.

Name Type Description
MatchRule
  • string
RateLimitRule
  • string

Menentukan ID Sumber Daya untuk Kebijakan Keamanan.

Name Type Description
id
  • string

ID Sumber Daya.

Sku

Tingkat harga kebijakan firewall aplikasi web.

Name Type Description
name

Nama tingkat harga.

SkuName

Nama tingkat harga.

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

WebApplicationFirewallPolicy

Menentukan kebijakan firewall aplikasi web.

Name Type Description
etag
  • string

Mendapatkan string baca-saja unik yang berubah setiap kali sumber daya diperbarui.

id
  • string

ID Sumber Daya.

location
  • string

Lokasi sumber daya.

name
  • string

Nama sumber daya.

properties.customRules

Menjelaskan aturan kustom di dalam kebijakan.

properties.frontendEndpointLinks

Menjelaskan Titik Akhir Frontend yang terkait dengan kebijakan Web Application Firewall ini.

properties.managedRules

Menjelaskan aturan terkelola di dalam kebijakan.

properties.policySettings

Menjelaskan pengaturan untuk kebijakan.

properties.provisioningState
  • string

Status penyediaan kebijakan.

properties.resourceState

Status sumber daya kebijakan.

properties.routingRuleLinks

Menjelaskan Aturan Perutean yang terkait dengan kebijakan Web Application Firewall ini.

properties.securityPolicyLinks

Menjelaskan Kebijakan Keamanan yang terkait dengan kebijakan Web Application Firewall ini.

sku

Tingkat harga kebijakan firewall aplikasi web. Default ke Classic_AzureFrontDoor jika tidak ditentukan.

tags
  • object

Tag sumber daya.

type
  • string

Jenis sumber daya