你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Firewall Policies - Get

获取指定的防火墙策略。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}?api-version=2022-01-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}?api-version=2022-01-01&$expand={$expand}

URI 参数

Name In Required Type Description
firewallPolicyName
path True
  • string

防火墙策略的名称。

resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

客户端 API 版本。

$expand
query
  • string

展开引用的资源。

响应

Name Type Description
200 OK

请求成功。 该操作返回防火墙策略资源。

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get FirewallPolicy

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy?api-version=2022-01-01

Sample Response

{
  "name": "firewallPolicy",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy",
  "type": "Microsoft.Network/firewallPolicies",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "threatIntelMode": "Alert",
    "threatIntelWhitelist": {
      "ipAddresses": [
        "20.3.4.5"
      ],
      "fqdns": [
        "*.microsoft.com"
      ]
    },
    "ruleCollectionGroups": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1"
      }
    ],
    "insights": {
      "isEnabled": true,
      "retentionDays": 100,
      "logAnalyticsResources": {
        "workspaces": [
          {
            "region": "westus",
            "workspaceId": {
              "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1"
            }
          },
          {
            "region": "eastus",
            "workspaceId": {
              "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2"
            }
          }
        ],
        "defaultWorkspaceId": {
          "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace"
        }
      }
    },
    "firewalls": [],
    "snat": {
      "privateRanges": [
        "IANAPrivateRanges"
      ]
    },
    "sql": {
      "allowSqlRedirect": true
    },
    "dnsSettings": {
      "servers": [
        "30.3.4.5"
      ],
      "enableProxy": true,
      "requireProxyForNetworkRules": false
    },
    "explicitProxy": {
      "enableExplicitProxy": true,
      "httpPort": 8087,
      "httpsPort": 8087,
      "enablePacFile": true,
      "pacFilePort": 8087,
      "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D"
    },
    "sku": {
      "tier": "Premium"
    },
    "intrusionDetection": {
      "mode": "Alert",
      "configuration": {
        "signatureOverrides": [
          {
            "id": "2525004",
            "mode": "Deny"
          }
        ],
        "bypassTrafficSettings": [
          {
            "name": "bypassRule1",
            "description": "Rule 1",
            "protocol": "TCP",
            "sourceAddresses": [
              "1.2.3.4"
            ],
            "destinationAddresses": [
              "5.6.7.8"
            ],
            "destinationPorts": [
              "*"
            ]
          }
        ]
      }
    },
    "transportSecurity": {
      "certificateAuthority": {
        "name": "clientcert",
        "keyVaultSecretId": "https://kv/secret"
      }
    }
  }
}

定义

AutoLearnPrivateRangesMode

用于自动学习专用范围的操作模式不是 SNAT

AzureFirewallThreatIntelMode

威胁 Intel 的操作模式。

CloudError

服务的错误响应。

CloudErrorBody

服务的错误响应。

DnsSettings

防火墙策略中的 DNS 代理设置。

ExplicitProxy

防火墙策略中的显式代理设置。

FirewallPolicy

FirewallPolicy 资源。

FirewallPolicyCertificateAuthority

tls 的受信任的根证书属性。

FirewallPolicyInsights

防火墙策略见解。

FirewallPolicyIntrusionDetection

入侵检测模式和规则的配置。

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications

入侵检测绕过流量规范。

FirewallPolicyIntrusionDetectionConfiguration

用于配置入侵检测的操作。

FirewallPolicyIntrusionDetectionProtocol

规则绕过协议。

FirewallPolicyIntrusionDetectionSignatureSpecification

入侵检测签名规范状态。

FirewallPolicyIntrusionDetectionStateType

入侵检测常规状态。

FirewallPolicyLogAnalyticsResources

用于防火墙策略见解的 Log Analytics 资源。

FirewallPolicyLogAnalyticsWorkspace

用于防火墙策略见解的 Log Analytics 工作区。

FirewallPolicySku

防火墙策略的 SKU。

FirewallPolicySkuTier

防火墙策略层。

FirewallPolicySNAT

流量不会为 SNAT 的专用 IP 地址/IP 范围。

FirewallPolicySQL

防火墙策略中的 SQL 设置。

FirewallPolicyThreatIntelWhitelist

防火墙策略的 ThreatIntel 允许列表。

FirewallPolicyTransportSecurity

执行 TLS 终止 & 启动所需的配置。

ManagedServiceIdentity

资源的标识。

ProvisioningState

当前预配状态。

ResourceIdentityType

用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。

SubResource

对另一个子资源的引用。

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

AutoLearnPrivateRangesMode

用于自动学习专用范围的操作模式不是 SNAT

Name Type Description
Disabled
  • string
Enabled
  • string

AzureFirewallThreatIntelMode

威胁 Intel 的操作模式。

Name Type Description
Alert
  • string
Deny
  • string
Off
  • string

CloudError

服务的错误响应。

Name Type Description
error

云错误正文。

CloudErrorBody

服务的错误响应。

Name Type Description
code
  • string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

有关错误的其他详细信息的列表。

message
  • string

描述错误的消息,旨在适合在用户界面中显示。

target
  • string

特定错误的目标。 例如,错误属性的名称。

DnsSettings

防火墙策略中的 DNS 代理设置。

Name Type Description
enableProxy
  • boolean

在附加到防火墙策略的防火墙上启用 DNS 代理。

requireProxyForNetworkRules
  • boolean

当设置为 true 时,支持网络规则中的 FQDN。

servers
  • string[]

自定义 DNS 服务器列表。

ExplicitProxy

防火墙策略中的显式代理设置。

Name Type Description
enableExplicitProxy
  • boolean

设置为 true 时,将启用显式代理模式。

enablePacFile
  • boolean

设置为 true 时,需要提供 pac 文件端口和 URL。

httpPort
  • integer

显式代理 http 协议的端口号不能大于 64000。

httpsPort
  • integer

显式代理 https 协议的端口号不能大于 64000。

pacFile
  • string

PAC 文件的 SAS URL。

pacFilePort
  • integer

用于为 PAC 文件提供服务的防火墙的端口号。

FirewallPolicy

FirewallPolicy 资源。

Name Type Description
etag
  • string

每当更新资源时更改的唯一只读字符串。

id
  • string

资源 ID。

identity

防火墙策略的标识。

location
  • string

资源位置。

name
  • string

资源名称。

properties.basePolicy

继承规则的父防火墙策略。

properties.childPolicies

对子防火墙策略的引用列表。

properties.dnsSettings

DNS 代理设置定义。

properties.explicitProxy

显式代理设置定义。

properties.firewalls

此防火墙策略与此防火墙策略关联的 Azure 防火墙引用列表。

properties.insights

有关防火墙策略的见解。

properties.intrusionDetection

入侵检测的配置。

properties.provisioningState

防火墙策略资源的预配状态。

properties.ruleCollectionGroups

对 FirewallPolicyRuleCollectionGroups 的引用列表。

properties.sku

防火墙策略 SKU。

properties.snat

流量不会为 SNAT 的专用 IP 地址/IP 范围。

properties.sql

SQL 设置定义。

properties.threatIntelMode

威胁智能的操作模式。

properties.threatIntelWhitelist

防火墙策略的 ThreatIntel 允许列表。

properties.transportSecurity

TLS 配置定义。

tags
  • object

资源标记。

type
  • string

资源类型。

FirewallPolicyCertificateAuthority

tls 的受信任的根证书属性。

Name Type Description
keyVaultSecretId
  • string

(base-64 编码的未加密 pfx 的机密 ID) KeyVault 中存储的“机密”或“Certificate”对象。

name
  • string

CA 证书的名称。

FirewallPolicyInsights

防火墙策略见解。

Name Type Description
isEnabled
  • boolean

指示是否在策略上启用了见解的标志。

logAnalyticsResources

配置防火墙策略见解所需的工作区。

retentionDays
  • integer

应在策略上启用见解的天数。

FirewallPolicyIntrusionDetection

入侵检测模式和规则的配置。

Name Type Description
configuration

入侵检测配置属性。

mode

入侵检测常规状态。

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications

入侵检测绕过流量规范。

Name Type Description
description
  • string

绕过流量规则的说明。

destinationAddresses
  • string[]

此规则的目标 IP 地址或范围列表。

destinationIpGroups
  • string[]

此规则的目标 IpGroup 列表。

destinationPorts
  • string[]

目标端口或范围列表。

name
  • string

绕过流量规则的名称。

protocol

规则绕过协议。

sourceAddresses
  • string[]

此规则的源 IP 地址或范围列表。

sourceIpGroups
  • string[]

此规则的源 IpGroup 列表。

FirewallPolicyIntrusionDetectionConfiguration

用于配置入侵检测的操作。

Name Type Description
bypassTrafficSettings

要绕过的流量的规则列表。

privateRanges
  • string[]

IDPS 专用 IP 地址范围用于标识流量方向 (,例如入站、出站等) 。 默认情况下,只有 IANA RFC 1918 定义的范围会被视为专用 IP 地址。 若要修改默认范围,请使用此属性指定专用 IP 地址范围

signatureOverrides

特定签名状态的列表。

FirewallPolicyIntrusionDetectionProtocol

规则绕过协议。

Name Type Description
ANY
  • string
ICMP
  • string
TCP
  • string
UDP
  • string

FirewallPolicyIntrusionDetectionSignatureSpecification

入侵检测签名规范状态。

Name Type Description
id
  • string

签名 ID。

mode

签名状态。

FirewallPolicyIntrusionDetectionStateType

入侵检测常规状态。

Name Type Description
Alert
  • string
Deny
  • string
Off
  • string

FirewallPolicyLogAnalyticsResources

用于防火墙策略见解的 Log Analytics 资源。

Name Type Description
defaultWorkspaceId

防火墙策略见解的默认工作区 ID。

workspaces

防火墙策略见解的工作区列表。

FirewallPolicyLogAnalyticsWorkspace

用于防火墙策略见解的 Log Analytics 工作区。

Name Type Description
region
  • string

要配置工作区的区域。

workspaceId

防火墙策略见解的工作区 ID。

FirewallPolicySku

防火墙策略的 SKU。

Name Type Description
tier

防火墙策略层。

FirewallPolicySkuTier

防火墙策略层。

Name Type Description
Basic
  • string
Premium
  • string
Standard
  • string

FirewallPolicySNAT

流量不会为 SNAT 的专用 IP 地址/IP 范围。

Name Type Description
autoLearnPrivateRanges

用于自动学习专用范围的操作模式不是 SNAT

privateRanges
  • string[]

非 SNAT 的专用 IP 地址/IP 地址范围列表。

FirewallPolicySQL

防火墙策略中的 SQL 设置。

Name Type Description
allowSqlRedirect
  • boolean

指示是否启用了 SQL 重定向流量筛选的标志。 启用标志不需要使用端口 11000-11999 的规则。

FirewallPolicyThreatIntelWhitelist

防火墙策略的 ThreatIntel 允许列表。

Name Type Description
fqdns
  • string[]

ThreatIntel 允许列表的 FQDN 列表。

ipAddresses
  • string[]

ThreatIntel 允许列表的 IP 地址列表。

FirewallPolicyTransportSecurity

执行 TLS 终止 & 启动所需的配置。

Name Type Description
certificateAuthority

用于中间 CA 生成的 CA。

ManagedServiceIdentity

资源的标识。

Name Type Description
principalId
  • string

系统分配标识的主体 ID。 此属性仅适用于系统分配的标识。

tenantId
  • string

系统分配标识的租户 ID。 此属性仅适用于系统分配的标识。

type

用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。

userAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

ProvisioningState

当前预配状态。

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ResourceIdentityType

用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

SubResource

对另一个子资源的引用。

Name Type Description
id
  • string

资源 ID。

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

Name Type Description