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

Microsoft.Network firewallPolicies/firewallPolicyDrafts 2023-11-01

Bicep 资源定义

可以使用目标操作部署 firewallPolicies/firewallPolicyDrafts 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/firewallPolicies/firewallPolicyDrafts 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Network/firewallPolicies/firewallPolicyDrafts@2023-11-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'default'
  properties: {
    basePolicy: {
      id: 'string'
    }
    dnsSettings: {
      enableProxy: bool
      requireProxyForNetworkRules: bool
      servers: [
        'string'
      ]
    }
    explicitProxy: {
      enableExplicitProxy: bool
      enablePacFile: bool
      httpPort: int
      httpsPort: int
      pacFile: 'string'
      pacFilePort: int
    }
    insights: {
      isEnabled: bool
      logAnalyticsResources: {
        defaultWorkspaceId: {
          id: 'string'
        }
        workspaces: [
          {
            region: 'string'
            workspaceId: {
              id: 'string'
            }
          }
        ]
      }
      retentionDays: int
    }
    intrusionDetection: {
      configuration: {
        bypassTrafficSettings: [
          {
            description: 'string'
            destinationAddresses: [
              'string'
            ]
            destinationIpGroups: [
              'string'
            ]
            destinationPorts: [
              'string'
            ]
            name: 'string'
            protocol: 'string'
            sourceAddresses: [
              'string'
            ]
            sourceIpGroups: [
              'string'
            ]
          }
        ]
        privateRanges: [
          'string'
        ]
        signatureOverrides: [
          {
            id: 'string'
            mode: 'string'
          }
        ]
      }
      mode: 'string'
      profile: 'string'
    }
    snat: {
      autoLearnPrivateRanges: 'string'
      privateRanges: [
        'string'
      ]
    }
    sql: {
      allowSqlRedirect: bool
    }
    threatIntelMode: 'string'
    threatIntelWhitelist: {
      fqdns: [
        'string'
      ]
      ipAddresses: [
        'string'
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

DnsSettings

名字 描述 价值
enableProxy 在附加到防火墙策略的防火墙上启用 DNS 代理。 bool
requireProxyForNetworkRules 当设置为 true 时,支持网络规则中的 FQDN。 bool
服务器 自定义 DNS 服务器列表。 string[]

ExplicitProxy

名字 描述 价值
enableExplicitProxy 设置为 true 时,将启用显式代理模式。 bool
enablePacFile 如果设置为 true,则需要提供 pac 文件端口和 URL。 bool
httpPort 显式代理 http 协议的端口号不能大于 64000。 int

约束:
最小值 = 0
最大值 = 64000
httpsPort 显式代理 https 协议的端口号不能大于 64000。 int

约束:
最小值 = 0
最大值 = 64000
pacFile PAC 文件的 SAS URL。 字符串
pacFilePort 要为 PAC 文件提供服务的防火墙的端口号。 int

约束:
最小值 = 0
最大值 = 64000

FirewallPolicyDraftProperties

名字 描述 价值
basePolicy 继承规则的父防火墙策略。 SubResource
dnsSettings DNS 代理设置定义。 DnsSettings
explicitProxy 显式代理设置定义。 ExplicitProxy
见解 有关防火墙策略的见解。 FirewallPolicyInsights
intrusionDetection 入侵检测的配置。 FirewallPolicyIntrusionDetection
snat 流量不会为 SNAT 的专用 IP 地址/IP 范围。 FirewallPolicySnat
sql SQL 设置定义。 FirewallPolicySQL
threatIntelMode 威胁智能的操作模式。 “Alert”
“拒绝”
“关闭”
threatIntelWhitelist 防火墙策略的 ThreatIntel 允许列表。 FirewallPolicyThreatIntelWhitelist

FirewallPolicyInsights

名字 描述 价值
isEnabled 一个标志,用于指示是否对策略启用了见解。 bool
logAnalyticsResources 配置防火墙策略见解所需的工作区。 FirewallPolicyLogAnalyticsResources
retentionDays 应在策略上启用见解的天数。 int

FirewallPolicyIntrusionDetection

名字 描述 价值
配置 入侵检测配置属性。 FirewallPolicyIntrusionDetectionConfiguration
模式 入侵检测常规状态。 附加到父策略时,防火墙的有效 IDPS 模式是两者更严格的模式。 “Alert”
“拒绝”
“关闭”
轮廓 IDPS 配置文件名称。 附加到父策略时,防火墙的有效配置文件是父策略的配置文件名称。 “Advanced”
“Basic”
“Extended”
“Standard”

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications

名字 描述 价值
描述 绕过流量规则的说明。 字符串
destinationAddresses 此规则的目标 IP 地址或范围列表。 string[]
destinationIpGroups 此规则的目标 IpGroup 列表。 string[]
destinationPorts 目标端口或范围的列表。 string[]
名字 绕过流量规则的名称。 字符串
协议 规则绕过协议。 “ANY”
“ICMP”
“TCP”
“UDP”
sourceAddresses 此规则的源 IP 地址或范围列表。 string[]
sourceIpGroups 此规则的源 IpGroup 列表。 string[]

FirewallPolicyIntrusionDetectionConfiguration

名字 描述 价值
bypassTrafficSettings 要绕过的流量的规则列表。 FirewallPolicyIntrusionDetectionBypassTrafficSpecifications[]
privateRanges IDPS 专用 IP 地址范围用于标识流量方向(例如入站、出站等)。 默认情况下,仅 IANA RFC 1918 定义的范围被视为专用 IP 地址。 若要修改默认范围,请使用此属性指定专用 IP 地址范围 string[]
signatureOverrides 特定签名状态的列表。 FirewallPolicyIntrusionDetectionSignatureSpecification[]

FirewallPolicyIntrusionDetectionSignatureSpecification

名字 描述 价值
id 签名 ID。 字符串
模式 签名状态。 “Alert”
“拒绝”
“关闭”

FirewallPolicyLogAnalyticsResources

名字 描述 价值
defaultWorkspaceId 防火墙策略见解的默认工作区 ID。 SubResource
workspaces 防火墙策略见解的工作区列表。 FirewallPolicyLogAnalyticsWorkspace[]

FirewallPolicyLogAnalyticsWorkspace

名字 描述 价值
地区 要配置工作区的区域。 字符串
workspaceId 防火墙策略见解的工作区 ID。 SubResource

FirewallPolicySnat

名字 描述 价值
autoLearnPrivateRanges 用于自动学习专用范围的操作模式不是 SNAT “Disabled”
“Enabled”
privateRanges 非 SNAT 的专用 IP 地址/IP 地址范围列表。 string[]

FirewallPolicySQL

名字 描述 价值
allowSqlRedirect 指示是否启用了 SQL 重定向流量筛选的标志。 启用标志不需要使用端口 11000-11999 的规则。 bool

FirewallPolicyThreatIntelWhitelist

名字 描述 价值
fqdns ThreatIntel 允许列表的 FQDN 列表。 string[]
ipAddresses ThreatIntel 允许列表的 IP 地址列表。 string[]

Microsoft.Network/firewallPolicies/firewallPolicyDrafts

名字 描述 价值
位置 资源位置。 字符串
名字 资源名称 “default”(必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:firewallPolicies
性能 防火墙策略的属性。 FirewallPolicyDraftProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字 描述 价值

SubResource

名字 描述 价值
id 资源 ID。 字符串

ARM 模板资源定义

可以使用目标操作部署 firewallPolicies/firewallPolicyDrafts 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/firewallPolicies/firewallPolicyDrafts 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Network/firewallPolicies/firewallPolicyDrafts",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "basePolicy": {
      "id": "string"
    },
    "dnsSettings": {
      "enableProxy": "bool",
      "requireProxyForNetworkRules": "bool",
      "servers": [ "string" ]
    },
    "explicitProxy": {
      "enableExplicitProxy": "bool",
      "enablePacFile": "bool",
      "httpPort": "int",
      "httpsPort": "int",
      "pacFile": "string",
      "pacFilePort": "int"
    },
    "insights": {
      "isEnabled": "bool",
      "logAnalyticsResources": {
        "defaultWorkspaceId": {
          "id": "string"
        },
        "workspaces": [
          {
            "region": "string",
            "workspaceId": {
              "id": "string"
            }
          }
        ]
      },
      "retentionDays": "int"
    },
    "intrusionDetection": {
      "configuration": {
        "bypassTrafficSettings": [
          {
            "description": "string",
            "destinationAddresses": [ "string" ],
            "destinationIpGroups": [ "string" ],
            "destinationPorts": [ "string" ],
            "name": "string",
            "protocol": "string",
            "sourceAddresses": [ "string" ],
            "sourceIpGroups": [ "string" ]
          }
        ],
        "privateRanges": [ "string" ],
        "signatureOverrides": [
          {
            "id": "string",
            "mode": "string"
          }
        ]
      },
      "mode": "string",
      "profile": "string"
    },
    "snat": {
      "autoLearnPrivateRanges": "string",
      "privateRanges": [ "string" ]
    },
    "sql": {
      "allowSqlRedirect": "bool"
    },
    "threatIntelMode": "string",
    "threatIntelWhitelist": {
      "fqdns": [ "string" ],
      "ipAddresses": [ "string" ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

DnsSettings

名字 描述 价值
enableProxy 在附加到防火墙策略的防火墙上启用 DNS 代理。 bool
requireProxyForNetworkRules 当设置为 true 时,支持网络规则中的 FQDN。 bool
服务器 自定义 DNS 服务器列表。 string[]

ExplicitProxy

名字 描述 价值
enableExplicitProxy 设置为 true 时,将启用显式代理模式。 bool
enablePacFile 如果设置为 true,则需要提供 pac 文件端口和 URL。 bool
httpPort 显式代理 http 协议的端口号不能大于 64000。 int

约束:
最小值 = 0
最大值 = 64000
httpsPort 显式代理 https 协议的端口号不能大于 64000。 int

约束:
最小值 = 0
最大值 = 64000
pacFile PAC 文件的 SAS URL。 字符串
pacFilePort 要为 PAC 文件提供服务的防火墙的端口号。 int

约束:
最小值 = 0
最大值 = 64000

FirewallPolicyDraftProperties

名字 描述 价值
basePolicy 继承规则的父防火墙策略。 SubResource
dnsSettings DNS 代理设置定义。 DnsSettings
explicitProxy 显式代理设置定义。 ExplicitProxy
见解 有关防火墙策略的见解。 FirewallPolicyInsights
intrusionDetection 入侵检测的配置。 FirewallPolicyIntrusionDetection
snat 流量不会为 SNAT 的专用 IP 地址/IP 范围。 FirewallPolicySnat
sql SQL 设置定义。 FirewallPolicySQL
threatIntelMode 威胁智能的操作模式。 “Alert”
“拒绝”
“关闭”
threatIntelWhitelist 防火墙策略的 ThreatIntel 允许列表。 FirewallPolicyThreatIntelWhitelist

FirewallPolicyInsights

名字 描述 价值
isEnabled 一个标志,用于指示是否对策略启用了见解。 bool
logAnalyticsResources 配置防火墙策略见解所需的工作区。 FirewallPolicyLogAnalyticsResources
retentionDays 应在策略上启用见解的天数。 int

FirewallPolicyIntrusionDetection

名字 描述 价值
配置 入侵检测配置属性。 FirewallPolicyIntrusionDetectionConfiguration
模式 入侵检测常规状态。 附加到父策略时,防火墙的有效 IDPS 模式是两者更严格的模式。 “Alert”
“拒绝”
“关闭”
轮廓 IDPS 配置文件名称。 附加到父策略时,防火墙的有效配置文件是父策略的配置文件名称。 “Advanced”
“Basic”
“Extended”
“Standard”

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications

名字 描述 价值
描述 绕过流量规则的说明。 字符串
destinationAddresses 此规则的目标 IP 地址或范围列表。 string[]
destinationIpGroups 此规则的目标 IpGroup 列表。 string[]
destinationPorts 目标端口或范围的列表。 string[]
名字 绕过流量规则的名称。 字符串
协议 规则绕过协议。 “ANY”
“ICMP”
“TCP”
“UDP”
sourceAddresses 此规则的源 IP 地址或范围列表。 string[]
sourceIpGroups 此规则的源 IpGroup 列表。 string[]

FirewallPolicyIntrusionDetectionConfiguration

名字 描述 价值
bypassTrafficSettings 要绕过的流量的规则列表。 FirewallPolicyIntrusionDetectionBypassTrafficSpecifications[]
privateRanges IDPS 专用 IP 地址范围用于标识流量方向(例如入站、出站等)。 默认情况下,仅 IANA RFC 1918 定义的范围被视为专用 IP 地址。 若要修改默认范围,请使用此属性指定专用 IP 地址范围 string[]
signatureOverrides 特定签名状态的列表。 FirewallPolicyIntrusionDetectionSignatureSpecification[]

FirewallPolicyIntrusionDetectionSignatureSpecification

名字 描述 价值
id 签名 ID。 字符串
模式 签名状态。 “Alert”
“拒绝”
“关闭”

FirewallPolicyLogAnalyticsResources

名字 描述 价值
defaultWorkspaceId 防火墙策略见解的默认工作区 ID。 SubResource
workspaces 防火墙策略见解的工作区列表。 FirewallPolicyLogAnalyticsWorkspace[]

FirewallPolicyLogAnalyticsWorkspace

名字 描述 价值
地区 要配置工作区的区域。 字符串
workspaceId 防火墙策略见解的工作区 ID。 SubResource

FirewallPolicySnat

名字 描述 价值
autoLearnPrivateRanges 用于自动学习专用范围的操作模式不是 SNAT “Disabled”
“Enabled”
privateRanges 非 SNAT 的专用 IP 地址/IP 地址范围列表。 string[]

FirewallPolicySQL

名字 描述 价值
allowSqlRedirect 指示是否启用了 SQL 重定向流量筛选的标志。 启用标志不需要使用端口 11000-11999 的规则。 bool

FirewallPolicyThreatIntelWhitelist

名字 描述 价值
fqdns ThreatIntel 允许列表的 FQDN 列表。 string[]
ipAddresses ThreatIntel 允许列表的 IP 地址列表。 string[]

Microsoft.Network/firewallPolicies/firewallPolicyDrafts

名字 描述 价值
apiVersion API 版本 '2023-11-01'
位置 资源位置。 字符串
名字 资源名称 “default”(必需)
性能 防火墙策略的属性。 FirewallPolicyDraftProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Network/firewallPolicies/firewallPolicyDrafts”

ResourceTags

名字 描述 价值

SubResource

名字 描述 价值
id 资源 ID。 字符串

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署 firewallPolicies/firewallPolicyDrafts 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/firewallPolicies/firewallPolicyDrafts 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/firewallPolicies/firewallPolicyDrafts@2023-11-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      basePolicy = {
        id = "string"
      }
      dnsSettings = {
        enableProxy = bool
        requireProxyForNetworkRules = bool
        servers = [
          "string"
        ]
      }
      explicitProxy = {
        enableExplicitProxy = bool
        enablePacFile = bool
        httpPort = int
        httpsPort = int
        pacFile = "string"
        pacFilePort = int
      }
      insights = {
        isEnabled = bool
        logAnalyticsResources = {
          defaultWorkspaceId = {
            id = "string"
          }
          workspaces = [
            {
              region = "string"
              workspaceId = {
                id = "string"
              }
            }
          ]
        }
        retentionDays = int
      }
      intrusionDetection = {
        configuration = {
          bypassTrafficSettings = [
            {
              description = "string"
              destinationAddresses = [
                "string"
              ]
              destinationIpGroups = [
                "string"
              ]
              destinationPorts = [
                "string"
              ]
              name = "string"
              protocol = "string"
              sourceAddresses = [
                "string"
              ]
              sourceIpGroups = [
                "string"
              ]
            }
          ]
          privateRanges = [
            "string"
          ]
          signatureOverrides = [
            {
              id = "string"
              mode = "string"
            }
          ]
        }
        mode = "string"
        profile = "string"
      }
      snat = {
        autoLearnPrivateRanges = "string"
        privateRanges = [
          "string"
        ]
      }
      sql = {
        allowSqlRedirect = bool
      }
      threatIntelMode = "string"
      threatIntelWhitelist = {
        fqdns = [
          "string"
        ]
        ipAddresses = [
          "string"
        ]
      }
    }
  })
}

属性值

DnsSettings

名字 描述 价值
enableProxy 在附加到防火墙策略的防火墙上启用 DNS 代理。 bool
requireProxyForNetworkRules 当设置为 true 时,支持网络规则中的 FQDN。 bool
服务器 自定义 DNS 服务器列表。 string[]

ExplicitProxy

名字 描述 价值
enableExplicitProxy 设置为 true 时,将启用显式代理模式。 bool
enablePacFile 如果设置为 true,则需要提供 pac 文件端口和 URL。 bool
httpPort 显式代理 http 协议的端口号不能大于 64000。 int

约束:
最小值 = 0
最大值 = 64000
httpsPort 显式代理 https 协议的端口号不能大于 64000。 int

约束:
最小值 = 0
最大值 = 64000
pacFile PAC 文件的 SAS URL。 字符串
pacFilePort 要为 PAC 文件提供服务的防火墙的端口号。 int

约束:
最小值 = 0
最大值 = 64000

FirewallPolicyDraftProperties

名字 描述 价值
basePolicy 继承规则的父防火墙策略。 SubResource
dnsSettings DNS 代理设置定义。 DnsSettings
explicitProxy 显式代理设置定义。 ExplicitProxy
见解 有关防火墙策略的见解。 FirewallPolicyInsights
intrusionDetection 入侵检测的配置。 FirewallPolicyIntrusionDetection
snat 流量不会为 SNAT 的专用 IP 地址/IP 范围。 FirewallPolicySnat
sql SQL 设置定义。 FirewallPolicySQL
threatIntelMode 威胁智能的操作模式。 “Alert”
“拒绝”
“关闭”
threatIntelWhitelist 防火墙策略的 ThreatIntel 允许列表。 FirewallPolicyThreatIntelWhitelist

FirewallPolicyInsights

名字 描述 价值
isEnabled 一个标志,用于指示是否对策略启用了见解。 bool
logAnalyticsResources 配置防火墙策略见解所需的工作区。 FirewallPolicyLogAnalyticsResources
retentionDays 应在策略上启用见解的天数。 int

FirewallPolicyIntrusionDetection

名字 描述 价值
配置 入侵检测配置属性。 FirewallPolicyIntrusionDetectionConfiguration
模式 入侵检测常规状态。 附加到父策略时,防火墙的有效 IDPS 模式是两者更严格的模式。 “Alert”
“拒绝”
“关闭”
轮廓 IDPS 配置文件名称。 附加到父策略时,防火墙的有效配置文件是父策略的配置文件名称。 “Advanced”
“Basic”
“Extended”
“Standard”

FirewallPolicyIntrusionDetectionBypassTrafficSpecifications

名字 描述 价值
描述 绕过流量规则的说明。 字符串
destinationAddresses 此规则的目标 IP 地址或范围列表。 string[]
destinationIpGroups 此规则的目标 IpGroup 列表。 string[]
destinationPorts 目标端口或范围的列表。 string[]
名字 绕过流量规则的名称。 字符串
协议 规则绕过协议。 “ANY”
“ICMP”
“TCP”
“UDP”
sourceAddresses 此规则的源 IP 地址或范围列表。 string[]
sourceIpGroups 此规则的源 IpGroup 列表。 string[]

FirewallPolicyIntrusionDetectionConfiguration

名字 描述 价值
bypassTrafficSettings 要绕过的流量的规则列表。 FirewallPolicyIntrusionDetectionBypassTrafficSpecifications[]
privateRanges IDPS 专用 IP 地址范围用于标识流量方向(例如入站、出站等)。 默认情况下,仅 IANA RFC 1918 定义的范围被视为专用 IP 地址。 若要修改默认范围,请使用此属性指定专用 IP 地址范围 string[]
signatureOverrides 特定签名状态的列表。 FirewallPolicyIntrusionDetectionSignatureSpecification[]

FirewallPolicyIntrusionDetectionSignatureSpecification

名字 描述 价值
id 签名 ID。 字符串
模式 签名状态。 “Alert”
“拒绝”
“关闭”

FirewallPolicyLogAnalyticsResources

名字 描述 价值
defaultWorkspaceId 防火墙策略见解的默认工作区 ID。 SubResource
workspaces 防火墙策略见解的工作区列表。 FirewallPolicyLogAnalyticsWorkspace[]

FirewallPolicyLogAnalyticsWorkspace

名字 描述 价值
地区 要配置工作区的区域。 字符串
workspaceId 防火墙策略见解的工作区 ID。 SubResource

FirewallPolicySnat

名字 描述 价值
autoLearnPrivateRanges 用于自动学习专用范围的操作模式不是 SNAT “Disabled”
“Enabled”
privateRanges 非 SNAT 的专用 IP 地址/IP 地址范围列表。 string[]

FirewallPolicySQL

名字 描述 价值
allowSqlRedirect 指示是否启用了 SQL 重定向流量筛选的标志。 启用标志不需要使用端口 11000-11999 的规则。 bool

FirewallPolicyThreatIntelWhitelist

名字 描述 价值
fqdns ThreatIntel 允许列表的 FQDN 列表。 string[]
ipAddresses ThreatIntel 允许列表的 IP 地址列表。 string[]

Microsoft.Network/firewallPolicies/firewallPolicyDrafts

名字 描述 价值
位置 资源位置。 字符串
名字 资源名称 “default”(必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:firewallPolicies
性能 防火墙策略的属性。 FirewallPolicyDraftProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Network/firewallPolicies/firewallPolicyDrafts@2023-11-01”

ResourceTags

名字 描述 价值

SubResource

名字 描述 价值
id 资源 ID。 字符串