Bagikan melalui


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=2024-02-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
policyName
path True

string

Nama Kebijakan Web Application Firewall.

resourceGroupName
path True

string

Nama grup Sumber Daya dalam langganan Azure.

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

subscriptionId
path True

string

Info masuk 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

Nama Jenis Deskripsi
200 OK

WebApplicationFirewallPolicy

OK. Permintaan telah berhasil.

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

Get Policy

Permintaan sampel

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1?api-version=2024-02-01

Respon sampel

{
  "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",
      "logScrubbing": null
    },
    "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

Nama Deskripsi
scrubbingRuleEntryMatchOperator

Ketika matchVariable adalah koleksi, operasikan pada pemilih untuk menentukan elemen mana dalam koleksi tempat aturan ini berlaku.

scrubbingRuleEntryState

Mendefinisikan status aturan scrubbing log. Nilai default diaktifkan.

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.

GroupByVariable

Menjelaskan variabel yang tersedia untuk mengelompokkan permintaan batas tarif

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 ambil alih grup aturan terkelola.

ManagedRuleOverride

Menentukan pengaturan ambil alih 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 tersebut.

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.

scrubbingRuleEntryMatchVariable

Variabel yang akan digosok dari log.

SecurityPolicyLink

Menentukan ID Sumber Daya untuk Kebijakan Keamanan.

Sku

Tingkat harga kebijakan firewall aplikasi web.

SkuName

Nama tingkat harga.

TransformType

Menjelaskan transformasi apa yang diterapkan sebelum mencocokkan.

VariableName

Menjelaskan variabel yang didukung untuk grup menurut

WebApplicationFirewallPolicy

Mendefinisikan kebijakan firewall aplikasi web.

WebApplicationFirewallScrubbingRules

Mendefinisikan konten aturan scrubbing log.

WebApplicationFirewallScrubbingState

Status konfigurasi scrubbing log. Nilai default diaktifkan.

scrubbingRuleEntryMatchOperator

Ketika matchVariable adalah koleksi, operasikan pada pemilih untuk menentukan elemen mana dalam koleksi tempat aturan ini berlaku.

Nama Jenis Deskripsi
Equals

string

EqualsAny

string

scrubbingRuleEntryState

Mendefinisikan status aturan scrubbing log. Nilai default diaktifkan.

Nama Jenis Deskripsi
Disabled

string

Enabled

string

ActionType

Menentukan tindakan yang akan diambil pada kecocokan aturan.

Nama Jenis Deskripsi
Allow

string

AnomalyScoring

string

Block

string

JSChallenge

string

Log

string

Redirect

string

CustomRule

Menentukan konten aturan aplikasi web

Nama Jenis Deskripsi
action

ActionType

Menjelaskan tindakan apa yang akan diterapkan saat aturan cocok.

enabledState

CustomRuleEnabledState

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

groupBy

GroupByVariable[]

Menjelaskan daftar variabel untuk mengelompokkan permintaan batas tarif

matchConditions

MatchCondition[]

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

RuleType

Menjelaskan jenis aturan.

CustomRuleEnabledState

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

Nama Jenis Deskripsi
Disabled

string

Enabled

string

CustomRuleList

Menentukan konten aturan kustom

Nama Jenis Deskripsi
rules

CustomRule[]

Daftar aturan

ErrorResponse

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

Nama Jenis Deskripsi
code

string

Kode Kesalahan.

message

string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.

Menentukan ID Sumber Daya untuk Titik Akhir Frontend.

Nama Jenis Deskripsi
id

string

ID Sumber Daya.

GroupByVariable

Menjelaskan variabel yang tersedia untuk mengelompokkan permintaan batas tarif

Nama Jenis Deskripsi
variableName

VariableName

Menjelaskan variabel yang didukung untuk grup menurut

ManagedRuleEnabledState

Menjelaskan apakah aturan terkelola dalam status diaktifkan atau dinonaktifkan.

Nama Jenis Deskripsi
Disabled

string

Enabled

string

ManagedRuleExclusion

Mengecualikan variabel dari evaluasi aturan terkelola.

Nama Jenis Deskripsi
matchVariable

ManagedRuleExclusionMatchVariable

Jenis variabel yang akan dikecualikan.

selector

string

Nilai pemilih tempat elemen dalam koleksi pengecualian ini berlaku.

selectorMatchOperator

ManagedRuleExclusionSelectorMatchOperator

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

ManagedRuleExclusionMatchVariable

Jenis variabel yang akan dikecualikan.

Nama Jenis Deskripsi
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.

Nama Jenis Deskripsi
Contains

string

EndsWith

string

Equals

string

EqualsAny

string

StartsWith

string

ManagedRuleGroupOverride

Menentukan pengaturan ambil alih grup aturan terkelola.

Nama Jenis Deskripsi
exclusions

ManagedRuleExclusion[]

Menjelaskan pengecualian yang diterapkan ke semua aturan dalam grup.

ruleGroupName

string

Menjelaskan grup aturan terkelola untuk diambil alih.

rules

ManagedRuleOverride[]

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

ManagedRuleOverride

Menentukan pengaturan ambil alih grup aturan terkelola.

Nama Jenis Deskripsi
action

ActionType

Menjelaskan tindakan penimpaan yang akan diterapkan saat aturan cocok.

enabledState

ManagedRuleEnabledState

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

exclusions

ManagedRuleExclusion[]

Menjelaskan pengecualian yang diterapkan ke aturan khusus ini.

ruleId

string

Pengidentifikasi untuk aturan terkelola.

ManagedRuleSet

Menentukan seperangkat aturan terkelola.

Nama Jenis Deskripsi
exclusions

ManagedRuleExclusion[]

Menjelaskan pengecualian yang diterapkan ke semua aturan dalam set.

ruleGroupOverrides

ManagedRuleGroupOverride[]

Menentukan penimpaan grup aturan untuk diterapkan ke seperangkat aturan.

ruleSetAction

ManagedRuleSetActionType

ruleSetAction
Menentukan tindakan seperangkat aturan.

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.

Nama Jenis Deskripsi
Block

string

Log

string

Redirect

string

ManagedRuleSetList

Menentukan daftar seperangkat aturan terkelola untuk kebijakan tersebut.

Nama Jenis Deskripsi
managedRuleSets

ManagedRuleSet[]

Daftar seperangkat aturan.

MatchCondition

Tentukan kondisi kecocokan.

Nama Jenis Deskripsi
matchValue

string[]

Daftar kemungkinan nilai kecocokan.

matchVariable

MatchVariable

Minta variabel untuk dibandingkan dengan.

negateCondition

boolean

Menjelaskan apakah hasil dari kondisi ini harus dinegasikan.

operator

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

TransformType[]

Daftar transformasi.

MatchVariable

Minta variabel untuk dibandingkan dengan.

Nama Jenis Deskripsi
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.

Nama Jenis Deskripsi
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.

Nama Jenis Deskripsi
Disabled

string

Enabled

string

PolicyMode

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

Nama Jenis Deskripsi
Detection

string

Prevention

string

PolicyRequestBodyCheck

Menjelaskan apakah aturan terkelola kebijakan akan memeriksa konten isi permintaan.

Nama Jenis Deskripsi
Disabled

string

Enabled

string

PolicyResourceState

Status sumber daya kebijakan.

Nama Jenis Deskripsi
Creating

string

Deleting

string

Disabled

string

Disabling

string

Enabled

string

Enabling

string

PolicySettings

Menentukan pengaturan konfigurasi WebApplicationFirewallPolicy tingkat atas.

Nama Jenis Deskripsi
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

PolicyEnabledState

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

javascriptChallengeExpirationInMinutes

integer

Menentukan masa pakai validitas cookie tantangan JavaScript dalam hitungan menit. Pengaturan ini hanya berlaku untuk Premium_AzureFrontDoor. Nilai harus berupa bilangan bulat antara 5 dan 1440 dengan nilai default adalah 30.

logScrubbing.scrubbingRules

WebApplicationFirewallScrubbingRules[]

Daftar aturan scrubbing log yang diterapkan ke log Web Application Firewall.

logScrubbing.state

WebApplicationFirewallScrubbingState

Status konfigurasi scrubbing log. Nilai default diaktifkan.

mode

PolicyMode

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

PolicyRequestBodyCheck

Menjelaskan apakah aturan terkelola kebijakan akan memeriksa konten isi permintaan.

Menentukan ID Sumber Daya untuk Aturan Perutean.

Nama Jenis Deskripsi
id

string

ID Sumber Daya.

RuleType

Menjelaskan jenis aturan.

Nama Jenis Deskripsi
MatchRule

string

RateLimitRule

string

scrubbingRuleEntryMatchVariable

Variabel yang akan digosok dari log.

Nama Jenis Deskripsi
QueryStringArgNames

string

RequestBodyJsonArgNames

string

RequestBodyPostArgNames

string

RequestCookieNames

string

RequestHeaderNames

string

RequestIPAddress

string

RequestUri

string

Menentukan ID Sumber Daya untuk Kebijakan Keamanan.

Nama Jenis Deskripsi
id

string

ID Sumber Daya.

Sku

Tingkat harga kebijakan firewall aplikasi web.

Nama Jenis Deskripsi
name

SkuName

Nama tingkat harga.

SkuName

Nama tingkat harga.

Nama Jenis Deskripsi
Classic_AzureFrontDoor

string

Premium_AzureFrontDoor

string

Standard_AzureFrontDoor

string

TransformType

Menjelaskan transformasi apa yang diterapkan sebelum mencocokkan.

Nama Jenis Deskripsi
Lowercase

string

RemoveNulls

string

Trim

string

Uppercase

string

UrlDecode

string

UrlEncode

string

VariableName

Menjelaskan variabel yang didukung untuk grup menurut

Nama Jenis Deskripsi
GeoLocation

string

None

string

SocketAddr

string

WebApplicationFirewallPolicy

Mendefinisikan kebijakan firewall aplikasi web.

Nama Jenis Deskripsi
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

CustomRuleList

Menjelaskan aturan kustom di dalam kebijakan.

properties.frontendEndpointLinks

FrontendEndpointLink[]

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

properties.managedRules

ManagedRuleSetList

Menjelaskan aturan terkelola di dalam kebijakan.

properties.policySettings

PolicySettings

Menjelaskan pengaturan untuk kebijakan.

properties.provisioningState

string

Status penyediaan kebijakan.

properties.resourceState

PolicyResourceState

Status sumber daya kebijakan.

properties.routingRuleLinks

RoutingRuleLink[]

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

properties.securityPolicyLinks

SecurityPolicyLink[]

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

sku

Sku

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

tags

object

Tag sumber daya.

type

string

Jenis sumber daya

WebApplicationFirewallScrubbingRules

Mendefinisikan konten aturan scrubbing log.

Nama Jenis Deskripsi
matchVariable

scrubbingRuleEntryMatchVariable

Variabel yang akan digosok dari log.

selector

string

Ketika matchVariable adalah koleksi, operator yang digunakan untuk menentukan elemen mana dalam koleksi tempat aturan ini berlaku.

selectorMatchOperator

scrubbingRuleEntryMatchOperator

Ketika matchVariable adalah koleksi, operasikan pada pemilih untuk menentukan elemen mana dalam koleksi tempat aturan ini berlaku.

state

scrubbingRuleEntryState

Mendefinisikan status aturan scrubbing log. Nilai default diaktifkan.

WebApplicationFirewallScrubbingState

Status konfigurasi scrubbing log. Nilai default diaktifkan.

Nama Jenis Deskripsi
Disabled

string

Enabled

string