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

Firewall Policies - List All

获取订阅中的所有防火墙策略。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/firewallPolicies?api-version=2023-11-01

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

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

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

FirewallPolicyListResult

成功。 该操作返回 FirewallPolicy 资源的列表。

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

List all Firewall Policies for a given subscription

示例请求

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/firewallPolicies?api-version=2023-11-01

示例响应

{
  "value": [
    {
      "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",
        "ruleCollectionGroups": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1"
          }
        ],
        "firewalls": [],
        "snat": {
          "privateRanges": [
            "IANAPrivateRanges"
          ]
        },
        "sql": {
          "allowSqlRedirect": true
        },
        "dnsSettings": {
          "servers": [
            "30.3.4.5"
          ],
          "enableProxy": true,
          "requireProxyForNetworkRules": false
        },
        "sku": {
          "tier": "Standard"
        }
      }
    }
  ]
}

定义

名称 说明
AutoLearnPrivateRangesMode

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

AzureFirewallThreatIntelMode

威胁 Intel 的操作模式。

CloudError

服务的错误响应。

CloudErrorBody

服务的错误响应。

DnsSettings

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

ExplicitProxy

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

FirewallPolicy

FirewallPolicy 资源。

FirewallPolicyCertificateAuthority

TLS 的受信任根证书属性。

FirewallPolicyInsights

防火墙策略见解。

FirewallPolicyIntrusionDetection

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

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications

入侵检测绕过流量规范。

FirewallPolicyIntrusionDetectionConfiguration

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

FirewallPolicyIntrusionDetectionProfileType

IDPS 配置文件名称。 附加到父策略时,防火墙的有效配置文件是父策略的配置文件名称。

FirewallPolicyIntrusionDetectionProtocol

规则绕过协议。

FirewallPolicyIntrusionDetectionSignatureSpecification

入侵检测签名规范状态。

FirewallPolicyIntrusionDetectionStateType

入侵检测常规状态。 附加到父策略时,防火墙的有效 IDPS 模式是两者更严格的模式。

FirewallPolicyListResult

ListFirewallPolicies API 服务调用的响应。

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

名称 类型 说明
Disabled

string

Enabled

string

AzureFirewallThreatIntelMode

威胁 Intel 的操作模式。

名称 类型 说明
Alert

string

Deny

string

Off

string

CloudError

服务的错误响应。

名称 类型 说明
error

CloudErrorBody

云错误正文。

CloudErrorBody

服务的错误响应。

名称 类型 说明
code

string

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

details

CloudErrorBody[]

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

message

string

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

target

string

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

DnsSettings

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

名称 类型 说明
enableProxy

boolean

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

requireProxyForNetworkRules

boolean

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

servers

string[]

自定义 DNS 服务器列表。

ExplicitProxy

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

名称 类型 说明
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 资源。

名称 类型 说明
etag

string

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

id

string

资源 ID。

identity

ManagedServiceIdentity

防火墙策略的标识。

location

string

资源位置。

name

string

资源名称。

properties.basePolicy

SubResource

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

properties.childPolicies

SubResource[]

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

properties.dnsSettings

DnsSettings

DNS 代理设置定义。

properties.explicitProxy

ExplicitProxy

显式代理设置定义。

properties.firewalls

SubResource[]

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

properties.insights

FirewallPolicyInsights

有关防火墙策略的见解。

properties.intrusionDetection

FirewallPolicyIntrusionDetection

入侵检测的配置。

properties.provisioningState

ProvisioningState

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

properties.ruleCollectionGroups

SubResource[]

对 FirewallPolicyRuleCollectionGroups 的引用列表。

properties.size

string

一个只读字符串,表示 FirewallPolicyPropertiesFormat 的大小(以 MB 为单位)。 (例如 0.5MB)

properties.sku

FirewallPolicySku

防火墙策略 SKU。

properties.snat

FirewallPolicySNAT

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

properties.sql

FirewallPolicySQL

SQL 设置定义。

properties.threatIntelMode

AzureFirewallThreatIntelMode

威胁智能的操作模式。

properties.threatIntelWhitelist

FirewallPolicyThreatIntelWhitelist

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

properties.transportSecurity

FirewallPolicyTransportSecurity

TLS 配置定义。

tags

object

资源标记。

type

string

资源类型。

FirewallPolicyCertificateAuthority

TLS 的受信任根证书属性。

名称 类型 说明
keyVaultSecretId

string

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

name

string

CA 证书的名称。

FirewallPolicyInsights

防火墙策略见解。

名称 类型 说明
isEnabled

boolean

一个标志,用于指示是否对策略启用了见解。

logAnalyticsResources

FirewallPolicyLogAnalyticsResources

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

retentionDays

integer

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

FirewallPolicyIntrusionDetection

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

名称 类型 说明
configuration

FirewallPolicyIntrusionDetectionConfiguration

入侵检测配置属性。

mode

FirewallPolicyIntrusionDetectionStateType

入侵检测常规状态。 附加到父策略时,防火墙的有效 IDPS 模式是两者更严格的模式。

profile

FirewallPolicyIntrusionDetectionProfileType

IDPS 配置文件名称。 附加到父策略时,防火墙的有效配置文件是父策略的配置文件名称。

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications

入侵检测绕过流量规范。

名称 类型 说明
description

string

绕过流量规则的说明。

destinationAddresses

string[]

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

destinationIpGroups

string[]

此规则的目标 IpGroup 列表。

destinationPorts

string[]

目标端口或范围的列表。

name

string

绕过流量规则的名称。

protocol

FirewallPolicyIntrusionDetectionProtocol

规则绕过协议。

sourceAddresses

string[]

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

sourceIpGroups

string[]

此规则的源 IpGroup 列表。

FirewallPolicyIntrusionDetectionConfiguration

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

名称 类型 说明
bypassTrafficSettings

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications[]

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

privateRanges

string[]

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

signatureOverrides

FirewallPolicyIntrusionDetectionSignatureSpecification[]

特定签名状态的列表。

FirewallPolicyIntrusionDetectionProfileType

IDPS 配置文件名称。 附加到父策略时,防火墙的有效配置文件是父策略的配置文件名称。

名称 类型 说明
Advanced

string

Basic

string

Extended

string

Standard

string

FirewallPolicyIntrusionDetectionProtocol

规则绕过协议。

名称 类型 说明
ANY

string

ICMP

string

TCP

string

UDP

string

FirewallPolicyIntrusionDetectionSignatureSpecification

入侵检测签名规范状态。

名称 类型 说明
id

string

签名 ID。

mode

FirewallPolicyIntrusionDetectionStateType

签名状态。

FirewallPolicyIntrusionDetectionStateType

入侵检测常规状态。 附加到父策略时,防火墙的有效 IDPS 模式是两者更严格的模式。

名称 类型 说明
Alert

string

Deny

string

Off

string

FirewallPolicyListResult

ListFirewallPolicies API 服务调用的响应。

名称 类型 说明
nextLink

string

用于获取下一组结果的 URL。

value

FirewallPolicy[]

资源组中的防火墙策略列表。

FirewallPolicyLogAnalyticsResources

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

名称 类型 说明
defaultWorkspaceId

SubResource

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

workspaces

FirewallPolicyLogAnalyticsWorkspace[]

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

FirewallPolicyLogAnalyticsWorkspace

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

名称 类型 说明
region

string

要配置工作区的区域。

workspaceId

SubResource

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

FirewallPolicySku

防火墙策略的 SKU。

名称 类型 说明
tier

FirewallPolicySkuTier

防火墙策略的层。

FirewallPolicySkuTier

防火墙策略的层。

名称 类型 说明
Basic

string

Premium

string

Standard

string

FirewallPolicySNAT

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

名称 类型 说明
autoLearnPrivateRanges

AutoLearnPrivateRangesMode

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

privateRanges

string[]

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

FirewallPolicySQL

防火墙策略中的 SQL 设置。

名称 类型 说明
allowSqlRedirect

boolean

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

FirewallPolicyThreatIntelWhitelist

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

名称 类型 说明
fqdns

string[]

ThreatIntel 允许列表的 FQDN 列表。

ipAddresses

string[]

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

FirewallPolicyTransportSecurity

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

名称 类型 说明
certificateAuthority

FirewallPolicyCertificateAuthority

用于中间 CA 生成的 CA。

ManagedServiceIdentity

资源的标识。

名称 类型 说明
principalId

string

系统分配标识的主体 ID。 此属性仅针对系统分配的标识提供。

tenantId

string

系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。

type

ResourceIdentityType

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

userAssignedIdentities

UserAssignedIdentities

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

ProvisioningState

当前预配状态。

名称 类型 说明
Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

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

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

SubResource

对另一个子资源的引用。

名称 类型 说明
id

string

资源 ID。

UserAssignedIdentities

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

名称 类型 说明