通过

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

Microsoft.Network applicationGateways 2022-11-01

  • 项目

Bicep 资源定义

applicationGateways 资源类型可以通过针对以下操作进行部署：

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

资源格式

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

resource symbolicname 'Microsoft.Network/applicationGateways@2022-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    authenticationCertificates: [
      {
        id: 'string'
        name: 'string'
        properties: {
          data: 'string'
        }
      }
    ]
    autoscaleConfiguration: {
      maxCapacity: int
      minCapacity: int
    }
    backendAddressPools: [
      {
        id: 'string'
        name: 'string'
        properties: {
          backendAddresses: [
            {
              fqdn: 'string'
              ipAddress: 'string'
            }
          ]
        }
      }
    ]
    backendHttpSettingsCollection: [
      {
        id: 'string'
        name: 'string'
        properties: {
          affinityCookieName: 'string'
          authenticationCertificates: [
            {
              id: 'string'
            }
          ]
          connectionDraining: {
            drainTimeoutInSec: int
            enabled: bool
          }
          cookieBasedAffinity: 'string'
          hostName: 'string'
          path: 'string'
          pickHostNameFromBackendAddress: bool
          port: int
          probe: {
            id: 'string'
          }
          probeEnabled: bool
          protocol: 'string'
          requestTimeout: int
          trustedRootCertificates: [
            {
              id: 'string'
            }
          ]
        }
      }
    ]
    backendSettingsCollection: [
      {
        id: 'string'
        name: 'string'
        properties: {
          hostName: 'string'
          pickHostNameFromBackendAddress: bool
          port: int
          probe: {
            id: 'string'
          }
          protocol: 'string'
          timeout: int
          trustedRootCertificates: [
            {
              id: 'string'
            }
          ]
        }
      }
    ]
    customErrorConfigurations: [
      {
        customErrorPageUrl: 'string'
        statusCode: 'string'
      }
    ]
    enableFips: bool
    enableHttp2: bool
    firewallPolicy: {
      id: 'string'
    }
    forceFirewallPolicyAssociation: bool
    frontendIPConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateIPAddress: 'string'
          privateIPAllocationMethod: 'string'
          privateLinkConfiguration: {
            id: 'string'
          }
          publicIPAddress: {
            id: 'string'
          }
          subnet: {
            id: 'string'
          }
        }
      }
    ]
    frontendPorts: [
      {
        id: 'string'
        name: 'string'
        properties: {
          port: int
        }
      }
    ]
    gatewayIPConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          subnet: {
            id: 'string'
          }
        }
      }
    ]
    globalConfiguration: {
      enableRequestBuffering: bool
      enableResponseBuffering: bool
    }
    httpListeners: [
      {
        id: 'string'
        name: 'string'
        properties: {
          customErrorConfigurations: [
            {
              customErrorPageUrl: 'string'
              statusCode: 'string'
            }
          ]
          firewallPolicy: {
            id: 'string'
          }
          frontendIPConfiguration: {
            id: 'string'
          }
          frontendPort: {
            id: 'string'
          }
          hostName: 'string'
          hostNames: [
            'string'
          ]
          protocol: 'string'
          requireServerNameIndication: bool
          sslCertificate: {
            id: 'string'
          }
          sslProfile: {
            id: 'string'
          }
        }
      }
    ]
    listeners: [
      {
        id: 'string'
        name: 'string'
        properties: {
          frontendIPConfiguration: {
            id: 'string'
          }
          frontendPort: {
            id: 'string'
          }
          protocol: 'string'
          sslCertificate: {
            id: 'string'
          }
          sslProfile: {
            id: 'string'
          }
        }
      }
    ]
    loadDistributionPolicies: [
      {
        id: 'string'
        name: 'string'
        properties: {
          loadDistributionAlgorithm: 'string'
          loadDistributionTargets: [
            {
              id: 'string'
              name: 'string'
              properties: {
                backendAddressPool: {
                  id: 'string'
                }
                weightPerServer: int
              }
            }
          ]
        }
      }
    ]
    privateLinkConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          ipConfigurations: [
            {
              id: 'string'
              name: 'string'
              properties: {
                primary: bool
                privateIPAddress: 'string'
                privateIPAllocationMethod: 'string'
                subnet: {
                  id: 'string'
                }
              }
            }
          ]
        }
      }
    ]
    probes: [
      {
        id: 'string'
        name: 'string'
        properties: {
          host: 'string'
          interval: int
          match: {
            body: 'string'
            statusCodes: [
              'string'
            ]
          }
          minServers: int
          path: 'string'
          pickHostNameFromBackendHttpSettings: bool
          pickHostNameFromBackendSettings: bool
          port: int
          protocol: 'string'
          timeout: int
          unhealthyThreshold: int
        }
      }
    ]
    redirectConfigurations: [
      {
        id: 'string'
        name: 'string'
        properties: {
          includePath: bool
          includeQueryString: bool
          pathRules: [
            {
              id: 'string'
            }
          ]
          redirectType: 'string'
          requestRoutingRules: [
            {
              id: 'string'
            }
          ]
          targetListener: {
            id: 'string'
          }
          targetUrl: 'string'
          urlPathMaps: [
            {
              id: 'string'
            }
          ]
        }
      }
    ]
    requestRoutingRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          backendAddressPool: {
            id: 'string'
          }
          backendHttpSettings: {
            id: 'string'
          }
          httpListener: {
            id: 'string'
          }
          loadDistributionPolicy: {
            id: 'string'
          }
          priority: int
          redirectConfiguration: {
            id: 'string'
          }
          rewriteRuleSet: {
            id: 'string'
          }
          ruleType: 'string'
          urlPathMap: {
            id: 'string'
          }
        }
      }
    ]
    rewriteRuleSets: [
      {
        id: 'string'
        name: 'string'
        properties: {
          rewriteRules: [
            {
              actionSet: {
                requestHeaderConfigurations: [
                  {
                    headerName: 'string'
                    headerValue: 'string'
                  }
                ]
                responseHeaderConfigurations: [
                  {
                    headerName: 'string'
                    headerValue: 'string'
                  }
                ]
                urlConfiguration: {
                  modifiedPath: 'string'
                  modifiedQueryString: 'string'
                  reroute: bool
                }
              }
              conditions: [
                {
                  ignoreCase: bool
                  negate: bool
                  pattern: 'string'
                  variable: 'string'
                }
              ]
              name: 'string'
              ruleSequence: int
            }
          ]
        }
      }
    ]
    routingRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          backendAddressPool: {
            id: 'string'
          }
          backendSettings: {
            id: 'string'
          }
          listener: {
            id: 'string'
          }
          priority: int
          ruleType: 'string'
        }
      }
    ]
    sku: {
      capacity: int
      name: 'string'
      tier: 'string'
    }
    sslCertificates: [
      {
        id: 'string'
        name: 'string'
        properties: {
          data: 'string'
          keyVaultSecretId: 'string'
          password: 'string'
        }
      }
    ]
    sslPolicy: {
      cipherSuites: [
        'string'
      ]
      disabledSslProtocols: [
        'string'
      ]
      minProtocolVersion: 'string'
      policyName: 'string'
      policyType: 'string'
    }
    sslProfiles: [
      {
        id: 'string'
        name: 'string'
        properties: {
          clientAuthConfiguration: {
            verifyClientCertIssuerDN: bool
            verifyClientRevocation: 'string'
          }
          sslPolicy: {
            cipherSuites: [
              'string'
            ]
            disabledSslProtocols: [
              'string'
            ]
            minProtocolVersion: 'string'
            policyName: 'string'
            policyType: 'string'
          }
          trustedClientCertificates: [
            {
              id: 'string'
            }
          ]
        }
      }
    ]
    trustedClientCertificates: [
      {
        id: 'string'
        name: 'string'
        properties: {
          data: 'string'
        }
      }
    ]
    trustedRootCertificates: [
      {
        id: 'string'
        name: 'string'
        properties: {
          data: 'string'
          keyVaultSecretId: 'string'
        }
      }
    ]
    urlPathMaps: [
      {
        id: 'string'
        name: 'string'
        properties: {
          defaultBackendAddressPool: {
            id: 'string'
          }
          defaultBackendHttpSettings: {
            id: 'string'
          }
          defaultLoadDistributionPolicy: {
            id: 'string'
          }
          defaultRedirectConfiguration: {
            id: 'string'
          }
          defaultRewriteRuleSet: {
            id: 'string'
          }
          pathRules: [
            {
              id: 'string'
              name: 'string'
              properties: {
                backendAddressPool: {
                  id: 'string'
                }
                backendHttpSettings: {
                  id: 'string'
                }
                firewallPolicy: {
                  id: 'string'
                }
                loadDistributionPolicy: {
                  id: 'string'
                }
                paths: [
                  'string'
                ]
                redirectConfiguration: {
                  id: 'string'
                }
                rewriteRuleSet: {
                  id: 'string'
                }
              }
            }
          ]
        }
      }
    ]
    webApplicationFirewallConfiguration: {
      disabledRuleGroups: [
        {
          ruleGroupName: 'string'
          rules: [
            int
          ]
        }
      ]
      enabled: bool
      exclusions: [
        {
          matchVariable: 'string'
          selector: 'string'
          selectorMatchOperator: 'string'
        }
      ]
      fileUploadLimitInMb: int
      firewallMode: 'string'
      maxRequestBodySize: int
      maxRequestBodySizeInKb: int
      requestBodyCheck: bool
      ruleSetType: 'string'
      ruleSetVersion: 'string'
    }
  }
  zones: [
    'string'
  ]
}

属性值

applicationGateways

名称 说明 值
name 资源名称 字符串 (必需)

字符限制：1-80

有效字符：
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
标识 应用程序网关的标识（如果已配置）。 ManagedServiceIdentity
properties 应用程序网关的属性。 ApplicationGatewayPropertiesFormat
zones 表示资源需要来自的可用性区域列表。 string[]

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名称 说明 值
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

ApplicationGatewayPropertiesFormat

名称 说明 值
authenticationCertificates 应用程序网关资源的身份验证证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayAuthenticationCertificate[]
autoscaleConfiguration 自动缩放配置。 ApplicationGatewayAutoscaleConfiguration
backendAddressPools 应用程序网关资源的后端地址池。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendAddressPool[]
backendHttpSettingsCollection 应用程序网关资源的后端 http 设置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendHttpSettings[]
backendSettingsCollection 应用程序网关资源的后端设置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendSettings[]
customErrorConfigurations 应用程序网关资源的自定义错误配置。 ApplicationGatewayCustomError[]
enableFips 是否在应用程序网关资源上启用 FIPS。 bool
enableHttp2 是否在应用程序网关资源上启用 HTTP2。 bool
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
forceFirewallPolicyAssociation 如果为 true，则无论该策略是否不同于 WAF 配置，都会将防火墙策略与应用程序网关相关联。 bool
frontendIPConfigurations 应用程序网关资源的前端 IP 地址。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayFrontendIPConfiguration[]
frontendPorts 应用程序网关资源的前端端口。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayFrontendPort[]
gatewayIPConfigurations 应用程序网关资源的子网。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayIPConfiguration[]
globalConfiguration 全局配置。 ApplicationGatewayGlobalConfiguration
httpListeners 应用程序网关资源的 Http 侦听器。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayHttpListener[]
侦听器 应用程序网关资源的侦听器。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayListener[]
loadDistributionPolicies 应用程序网关资源的负载分发策略。 ApplicationGatewayLoadDistributionPolicy[]
privateLinkConfigurations 应用程序网关上的 PrivateLink 配置。 ApplicationGatewayPrivateLinkConfiguration[]
probes 应用程序网关资源的探测。 ApplicationGatewayProbe[]
redirectConfigurations 重定向应用程序网关资源的配置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayRedirectConfiguration[]
requestRoutingRules 应用程序网关资源的请求路由规则。 ApplicationGatewayRequestRoutingRule[]
rewriteRuleSets 重写应用程序网关资源的规则。 ApplicationGatewayRewriteRuleSet[]
routingRules 应用程序网关资源的路由规则。 ApplicationGatewayRoutingRule[]
sku 应用程序网关资源的 SKU。 ApplicationGatewaySku
sslCertificates 应用程序网关资源的 SSL 证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewaySslCertificate[]
sslPolicy 应用程序网关资源的 SSL 策略。 ApplicationGatewaySslPolicy
sslProfiles 应用程序网关资源的 SSL 配置文件。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewaySslProfile[]
trustedClientCertificates 应用程序网关资源的受信任客户端证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayTrustedClientCertificate[]
trustedRootCertificates 应用程序网关资源的受信任根证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayTrustedRootCertificate[]
urlPathMaps 应用程序网关资源的 URL 路径映射。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayUrlPathMap[]
webApplicationFirewallConfiguration Web 应用程序防火墙配置。 ApplicationGatewayWebApplicationFirewallConfiguratio...

ApplicationGatewayAuthenticationCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的身份验证证书的名称。 string
properties 应用程序网关身份验证证书的属性。 ApplicationGatewayAuthenticationCertificatePropertie...

ApplicationGatewayAuthenticationCertificatePropertie...

名称 说明 值
data 证书公共数据。 字符串

ApplicationGatewayAutoscaleConfiguration

名称 说明 值
maxCapacity 应用程序网关容量的上限。 int

约束：
最小值 = 2
minCapacity 应用程序网关容量数的下限。 int (必需)

约束：
最小值 = 0

ApplicationGatewayBackendAddressPool

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端地址池的名称。 string
properties 应用程序网关后端地址池的属性。 ApplicationGatewayBackendAddressPoolPropertiesFormat

ApplicationGatewayBackendAddressPoolPropertiesFormat

名称 说明 值
backendAddresses 后端地址。 ApplicationGatewayBackendAddress[]

ApplicationGatewayBackendAddress

名称 说明 值
fqdn 完全限定的域名 (FQDN)。 字符串
ipAddress IP 地址。 字符串

ApplicationGatewayBackendHttpSettings

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端 http 设置的名称。 string
properties 应用程序网关后端 HTTP 设置的属性。 ApplicationGatewayBackendHttpSettingsPropertiesForma...

ApplicationGatewayBackendHttpSettingsPropertiesForma...

名称 说明 值
affinityCookieName 要用于关联 Cookie 的 Cookie 名称。 字符串
authenticationCertificates 对应用程序网关身份验证证书的引用数组。 SubResource[]
connectionDraining 后端 http 设置资源的连接清空。 ApplicationGatewayConnectionDraining
cookieBasedAffinity 基于 Cookie 的相关性。 'Disabled'
'Enabled'
hostName 要发送到后端服务器的主机标头。 字符串
path 应用作所有 HTTP 请求前缀的路径。 Null 表示不会以任何路径为前缀。 默认值为 null。 字符串
pickHostNameFromBackendAddress 是否应从后端服务器的主机名中选取主机标头。 默认值为 false。 bool
port 后端上的目标端口。 int
探测 应用程序网关的探测资源。 SubResource
probeEnabled 探测是否已启用。 默认值为 false。 bool
protocol 用于与后端通信的协议。 'Http'
'Https'
'Tcp'
“Tls”
requestTimeout 请求超时（以秒为单位）。 如果在 RequestTimeout 中未收到响应，应用程序网关请求将失败。 可接受的值为 1 秒到 86400 秒。 int
trustedRootCertificates 对应用程序网关受信任的根证书的引用数组。 SubResource[]

SubResource

名称 说明 Value
id 资源 ID。 字符串

ApplicationGatewayConnectionDraining

名称 说明 值
drainTimeoutInSec 连接排出处于活动状态的秒数。 可接受的值为 1 秒到 3600 秒。 int (必需)

约束：
最小值 = 1
最大值 = 3600
enabled 是否启用连接清空。 需要 bool ()

ApplicationGatewayBackendSettings

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端设置的名称。 string
properties 应用程序网关后端设置的属性。 ApplicationGatewayBackendSettingsPropertiesFormat

ApplicationGatewayBackendSettingsPropertiesFormat

名称 说明 值
hostName 服务器名称指示将发送到 Tls 协议的后端服务器。 字符串
pickHostNameFromBackendAddress 是否从 Tls 协议的后端服务器的主机名中选取服务器名称指示。 默认值为 false。 bool
port 后端上的目标端口。 int
探测 应用程序网关的探测资源。 SubResource
protocol 用于与后端通信的协议。 'Http'
'Https'
'Tcp'
“Tls”
timeout 连接超时（秒）。 如果在 ConnectionTimeout 中未收到响应，应用程序网关请求将失败。 可接受的值为 1 秒到 86400 秒。 int
trustedRootCertificates 对应用程序网关受信任的根证书的引用数组。 SubResource[]

ApplicationGatewayCustomError

名称 说明 值
customErrorPageUrl 应用程序网关自定义错误的错误页 URL。 字符串
statusCode 应用程序网关自定义错误的状态代码。 'HttpStatus400'
'HttpStatus403'
'HttpStatus404'
“HttpStatus405”
'HttpStatus408'
'HttpStatus499'
'HttpStatus500'
“HttpStatus502”
“HttpStatus503”
“HttpStatus504”

ApplicationGatewayFrontendIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的前端 IP 配置的名称。 string
properties 应用程序网关前端 IP 配置的属性。 ApplicationGatewayFrontendIPConfigurationPropertiesF...

ApplicationGatewayFrontendIPConfigurationPropertiesF...

名称 说明 值
privateIPAddress PrivateIP网络接口 IP 配置的地址。 字符串
privateIPAllocationMethod 专用 IP 地址分配方法。 'Dynamic'
'Static'
privateLinkConfiguration 对应用程序网关专用链接配置的引用。 SubResource
publicIPAddress 对 PublicIP 资源的引用。 SubResource
子网 对子网资源的引用。 SubResource

ApplicationGatewayFrontendPort

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的前端端口的名称。 string
properties 应用程序网关前端端口的属性。 ApplicationGatewayFrontendPortPropertiesFormat

ApplicationGatewayFrontendPortPropertiesFormat

名称 说明 值
port 前端端口。 int

ApplicationGatewayIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 IP 配置的名称。 string
properties 应用程序网关 IP 配置的属性。 ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名称 说明 值
子网 对子网资源的引用。 应用程序网关从中获取其专用地址的子网。 SubResource

ApplicationGatewayGlobalConfiguration

名称 说明 值
enableRequestBuffering 启用请求缓冲。 bool
enableResponseBuffering 启用响应缓冲。 bool

ApplicationGatewayHttpListener

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 HTTP 侦听器的名称。 string
properties 应用程序网关 HTTP 侦听器的属性。 ApplicationGatewayHttpListenerPropertiesFormat

ApplicationGatewayHttpListenerPropertiesFormat

名称 说明 值
customErrorConfigurations HTTP 侦听器的自定义错误配置。 ApplicationGatewayCustomError[]
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
frontendIPConfiguration 应用程序网关的前端 IP 配置资源。 SubResource
frontendPort 应用程序网关的前端端口资源。 SubResource
hostName HTTP 侦听器的主机名。 字符串
主机 名 也允许特殊通配符的 HTTP 侦听器的主机名列表。 string[]
protocol HTTP 侦听器的协议。 'Http'
'Https'
'Tcp'
“Tls”
requireServerNameIndication 仅当协议为 https 时适用。 为多托管启用 SNI。 bool
sslCertificate 应用程序网关的 SSL 证书资源。 SubResource
sslProfile 应用程序网关的 SSL 配置文件资源。 SubResource

ApplicationGatewayListener

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的侦听器的名称。 string
properties 应用程序网关侦听器的属性。 ApplicationGatewayListenerPropertiesFormat

ApplicationGatewayListenerPropertiesFormat

名称 说明 值
frontendIPConfiguration 应用程序网关的前端 IP 配置资源。 SubResource
frontendPort 应用程序网关的前端端口资源。 SubResource
protocol 侦听器的协议。 'Http'
'Https'
'Tcp'
“Tls”
sslCertificate 应用程序网关的 SSL 证书资源。 SubResource
sslProfile 应用程序网关的 SSL 配置文件资源。 SubResource

ApplicationGatewayLoadDistributionPolicy

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的负载分配策略的名称。 string
properties 应用程序网关负载分发策略的属性。 ApplicationGatewayLoadDistributionPolicyPropertiesFo...

ApplicationGatewayLoadDistributionPolicyPropertiesFo...

名称 说明 值
loadDistributionAlgorithm 负载分发 目标应用程序网关的资源。 'IpHash'
“LeastConnections”
'RoundRobin'
loadDistributionTargets 负载分发 目标应用程序网关的资源。 ApplicationGatewayLoadDistributionTarget[]

ApplicationGatewayLoadDistributionTarget

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的负载分配策略的名称。 string
properties 应用程序网关负载分发目标的属性。 ApplicationGatewayLoadDistributionTargetPropertiesFo...

ApplicationGatewayLoadDistributionTargetPropertiesFo...

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
weightPerServer 每个服务器的权重。 范围介于 1 和 100 之间。 int

约束：
最小值 = 1
最大值 = 100

ApplicationGatewayPrivateLinkConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的专用链接配置的名称。 string
properties 应用程序网关专用链接配置的属性。 ApplicationGatewayPrivateLinkConfigurationProperties

ApplicationGatewayPrivateLinkConfigurationProperties

名称 说明 值
ipConfigurations 应用程序网关专用链接 IP 配置的数组。 ApplicationGatewayPrivateLinkIpConfiguration[]

ApplicationGatewayPrivateLinkIpConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关专用链接 IP 配置的名称。 string
properties 应用程序网关专用链接 IP 配置的属性。 ApplicationGatewayPrivateLinkIpConfigurationProperti...

ApplicationGatewayPrivateLinkIpConfigurationProperti...

名称 说明 值
角色实体 IP 配置是否为主。 bool
privateIPAddress IP 配置的专用 IP 地址。 字符串
privateIPAllocationMethod 专用 IP 地址分配方法。 'Dynamic'
'Static'
子网 对子网资源的引用。 SubResource

ApplicationGatewayProbe

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的探测的名称。 string
properties 应用程序网关探测的属性。 ApplicationGatewayProbePropertiesFormat

ApplicationGatewayProbePropertiesFormat

名称 说明 值
host 要向其发送探测的主机名。 字符串
interval 探测间隔（以秒为单位）。 这是每两次连续探测之间的时间间隔。 可接受的值为 1 秒到 86400 秒。 int
match 对正常探测响应进行分类的条件。 ApplicationGatewayProbeHealthResponseMatch
minServers 始终标记为正常的最小服务器数。 默认值为 0。 int
path 探测的相对路径。 有效路径从“/”开始。 探测将发送到 {Protocol}：//{host}：{port}{path}。 字符串
pickHostNameFromBackendHttpSettings 是否应从后端 http 设置中选取主机标头。 默认值为 false。 bool
pickHostNameFromBackendSettings 是否应从 Tls 协议的后端设置中选取服务器名称指示。 默认值为 false。 bool
port 将用于探测后端服务器的自定义端口。 有效值的范围从 1 到 65535。 如果未设置，将使用 http 设置中的端口。 此属性仅对Standard_v2和WAF_v2有效。 int

约束：
最小值 = 1
最大值 = 65535
protocol 用于探测的协议。 “Http”
“Https”
“Tcp”
“Tls”
timeout 探测超时（以秒为单位）。 如果在此超时期限内未收到有效响应，则探测标记为失败。 可接受的值为 1 秒到 86400 秒。 int
unhealthyThreshold 探测重试计数。 在连续探测失败计数达到 UnhealthyThreshold 后，后端服务器被标记为关闭。 可接受的值为 1 秒到 20 秒。 int

ApplicationGatewayProbeHealthResponseMatch

名称 说明 值
body 运行状况响应中必须包含的正文。 默认值为空。 字符串
statusCodes 允许的正常状态代码范围。 正常状态代码的默认范围是 200-399。 string[]

ApplicationGatewayRedirectConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的重定向配置的名称。 string
properties 应用程序网关重定向配置的属性。 ApplicationGatewayRedirectConfigurationPropertiesFor...

ApplicationGatewayRedirectConfigurationPropertiesFor...

名称 说明 值
includePath 在重定向的 URL 中包含路径。 bool
includeQueryString 在重定向的 URL 中包含查询字符串。 bool
pathRules 指定重定向配置的路径规则。 SubResource[]
redirectType HTTP 重定向类型。 “找到”
“永久”
“SeeOther”
“临时”
requestRoutingRules 指定重定向配置的请求路由。 SubResource[]
targetListener 引用要将请求重定向到的侦听器。 SubResource
targetUrl 将请求重定向到的 URL。 字符串
urlPathMaps 指定默认重定向配置的 URL 路径映射。 SubResource[]

ApplicationGatewayRequestRoutingRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的请求路由规则的名称。 string
properties 应用程序网关请求路由规则的属性。 ApplicationGatewayRequestRoutingRulePropertiesFormat

ApplicationGatewayRequestRoutingRulePropertiesFormat

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
backendHttpSettings 应用程序网关的后端 http 设置资源。 SubResource
httpListener 应用程序网关的 Http 侦听器资源。 SubResource
loadDistributionPolicy 应用程序网关的加载分发策略资源。 SubResource
priority 请求路由规则的优先级。 int

约束：
最小值 = 1
最大值 = 20000
redirectConfiguration 重定向应用程序网关的配置资源。 SubResource
rewriteRuleSet 重写应用程序网关的基本规则中的规则集资源。 SubResource
ruleType 规则类型。 “Basic”
“PathBasedRouting”
urlPathMap 应用程序网关的 URL 路径映射资源。 SubResource

ApplicationGatewayRewriteRuleSet

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的重写规则集的名称。 string
properties 应用程序网关重写规则集的属性。 ApplicationGatewayRewriteRuleSetPropertiesFormat

ApplicationGatewayRewriteRuleSetPropertiesFormat

名称 说明 值
rewriteRules 重写规则集中的规则。 ApplicationGatewayRewriteRule[]

ApplicationGatewayRewriteRule

名称 说明 值
actionSet 要作为重写规则的一部分执行的操作集。 ApplicationGatewayRewriteRuleActionSet
条件 将基于哪些条件评估操作集执行。 ApplicationGatewayRewriteRuleCondition[]
name 应用程序网关中唯一的重写规则的名称。 字符串
ruleSequence 重写规则的规则序列，用于确定重写RuleSet 中特定规则的执行顺序。 int

ApplicationGatewayRewriteRuleActionSet

名称 说明 值
requestHeaderConfigurations 操作集中的请求标头操作。 ApplicationGatewayHeaderConfiguration[]
responseHeaderConfigurations 操作集中的响应标头操作。 ApplicationGatewayHeaderConfiguration[]
urlConfiguration 操作集中的 URL 配置操作。 ApplicationGatewayUrlConfiguration

ApplicationGatewayHeaderConfiguration

名称 说明 值
headerName 标头配置的标头名称。 字符串
headerValue 标头配置的标头值。 字符串

ApplicationGatewayUrlConfiguration

名称 说明 值
modifiedPath 用户为 URL 重写提供的 URL 路径。 Null 表示不会更新任何路径。 默认值为 null。 字符串
modifiedQueryString 用户为 URL 重写提供的查询字符串。 Null 表示不会更新任何查询字符串。 默认值为 null。 字符串
reroute 如果设置为 true，它将使用修改后的路径重新评估基于路径的请求路由规则中提供的 URL 路径映射。 默认值为 false。 bool

ApplicationGatewayRewriteRuleCondition

名称 说明 值
ignoreCase 将此参数设置为真值，并强制模式执行区分大小写比较。 bool
negate 将此值设置为“真”将强制检查用户给定的条件的否定。 bool
pattern 计算条件真实性的模式（固定字符串或正则表达式）。 字符串
可变 RewriteRuleCondition 的 condition 参数。 字符串

ApplicationGatewayRoutingRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的路由规则的名称。 string
properties 应用程序网关路由规则的属性。 ApplicationGatewayRoutingRulePropertiesFormat

ApplicationGatewayRoutingRulePropertiesFormat

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
backendSettings 应用程序网关的后端设置资源。 SubResource
听众 应用程序网关的侦听器资源。 SubResource
priority 路由规则的优先级。 int (必需)

约束：
最小值 = 1
最大值 = 20000
ruleType 规则类型。 “Basic”
“PathBasedRouting”

ApplicationGatewaySku

名称 说明 值
容量 应用程序网关的容量 (实例计数) 。 int
name 应用程序网关 SKU 的名称。 “Standard_Large”
“Standard_Medium”
“Standard_Small”
“Standard_v2”
“WAF_Large”
“WAF_Medium”
“WAF_v2”
层 应用程序网关的层。 “Standard”
“Standard_v2”
“WAF”
“WAF_v2”

ApplicationGatewaySslCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 SSL 证书的名称。 string
properties 应用程序网关 SSL 证书的属性。 ApplicationGatewaySslCertificatePropertiesFormat

ApplicationGatewaySslCertificatePropertiesFormat

名称 说明 值
data Base-64 编码 pfx 证书。 仅适用于 PUT 请求。 字符串
keyVaultSecretId (base-64 编码的未加密 pfx 的机密 ID，) 存储在 KeyVault 中的“Secret”或“Certificate”对象。 字符串
password 数据中指定的 pfx 文件的密码。 仅适用于 PUT 请求。 字符串

ApplicationGatewaySslPolicy

名称 说明 值
cipherSuites 要按应用程序网关的指定顺序启用的 Ssl 密码套件。 包含任意项的字符串数组：
“TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_128_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_128_CBC_SHA256”
“TLS_DHE_DSS_WITH_AES_256_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_256_CBC_SHA256”
“TLS_DHE_RSA_WITH_AES_128_CBC_SHA”
“TLS_DHE_RSA_WITH_AES_128_GCM_SHA256”
“TLS_DHE_RSA_WITH_AES_256_CBC_SHA”
“TLS_DHE_RSA_WITH_AES_256_GCM_SHA384”
“TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA”
“TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256”
“TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256”
“TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA”
“TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384”
“TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384”
“TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA”
“TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256”
“TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256”
“TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA”
“TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384”
“TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384”
“TLS_RSA_WITH_3DES_EDE_CBC_SHA”
“TLS_RSA_WITH_AES_128_CBC_SHA”
“TLS_RSA_WITH_AES_128_CBC_SHA256”
“TLS_RSA_WITH_AES_128_GCM_SHA256”
“TLS_RSA_WITH_AES_256_CBC_SHA”
“TLS_RSA_WITH_AES_256_CBC_SHA256”
“TLS_RSA_WITH_AES_256_GCM_SHA384”
disabledSslProtocols 在应用程序网关上禁用 Ssl 协议。 包含任意项的字符串数组：
“TLSv1_0”
“TLSv1_1”
“TLSv1_2”
“TLSv1_3”
minProtocolVersion 应用程序网关支持的最低 Ssl 协议版本。 “TLSv1_0”
“TLSv1_1”
“TLSv1_2”
“TLSv1_3”
policyName Ssl 预定义策略的名称。 “AppGwSslPolicy20150501”
“AppGwSslPolicy20170401”
“AppGwSslPolicy20170401S”
“AppGwSslPolicy20220101”
“AppGwSslPolicy20220101S”
policyType Ssl 策略的类型。 “Custom”
“CustomV2”
“Predefined”

ApplicationGatewaySslProfile

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 SSL 配置文件的名称。 string
properties 应用程序网关 SSL 配置文件的属性。 ApplicationGatewaySslProfilePropertiesFormat

ApplicationGatewaySslProfilePropertiesFormat

名称 说明 值
clientAuthConfiguration 应用程序网关资源的客户端身份验证配置。 ApplicationGatewayClientAuthConfiguration
sslPolicy 应用程序网关资源的 SSL 策略。 ApplicationGatewaySslPolicy
trustedClientCertificates 对应用程序网关受信任客户端证书的引用数组。 SubResource[]

ApplicationGatewayClientAuthConfiguration

名称 说明 值
verifyClientCertIssuerDN 验证应用程序网关上的客户端证书颁发者名称。 bool
verifyClientRevocation 验证客户端证书吊销状态。 “None”
'OCSP'

ApplicationGatewayTrustedClientCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的受信任客户端证书的名称。 string
properties 应用程序网关受信任的客户端证书的属性。 ApplicationGatewayTrustedClientCertificateProperties...

ApplicationGatewayTrustedClientCertificateProperties...

名称 说明 值
data 证书公共数据。 字符串

ApplicationGatewayTrustedRootCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的受信任根证书的名称。 string
properties 应用程序网关受信任的根证书的属性。 ApplicationGatewayTrustedRootCertificatePropertiesFo...

ApplicationGatewayTrustedRootCertificatePropertiesFo...

名称 说明 值
data 证书公共数据。 字符串
keyVaultSecretId (base-64 编码的未加密 pfx 的机密 ID，) 存储在 KeyVault 中的“Secret”或“Certificate”对象。 字符串

ApplicationGatewayUrlPathMap

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 URL 路径映射的名称。 string
properties 应用程序网关 URL 路径映射的属性。 ApplicationGatewayUrlPathMapPropertiesFormat

ApplicationGatewayUrlPathMapPropertiesFormat

名称 说明 值
defaultBackendAddressPool URL 路径映射的默认后端地址池资源。 SubResource
defaultBackendHttpSettings URL 路径映射的默认后端 http 设置资源。 SubResource
defaultLoadDistributionPolicy URL 路径映射的默认负载分布策略资源。 SubResource
defaultRedirectConfiguration URL 路径映射的默认重定向配置资源。 SubResource
defaultRewriteRuleSet URL 路径映射的默认重写规则集资源。 SubResource
pathRules URL 路径映射资源的路径规则。 ApplicationGatewayPathRule[]

ApplicationGatewayPathRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的路径规则的名称。 string
properties 应用程序网关路径规则的属性。 ApplicationGatewayPathRulePropertiesFormat

ApplicationGatewayPathRulePropertiesFormat

名称 说明 值
backendAddressPool URL 路径映射路径规则的后端地址池资源。 SubResource
backendHttpSettings URL 路径映射路径规则的后端 http 设置资源。 SubResource
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
loadDistributionPolicy URL 路径映射路径规则的加载分发策略资源。 SubResource
路径 URL 路径映射的路径规则。 string[]
redirectConfiguration URL 路径映射路径规则的重定向配置资源。 SubResource
rewriteRuleSet 重写 URL 路径映射路径规则的规则集资源。 SubResource

ApplicationGatewayWebApplicationFirewallConfiguratio...

名称 说明 值
disabledRuleGroups 禁用的规则组。 ApplicationGatewayFirewallDisabledRuleGroup[]
enabled 是否启用 Web 应用程序防火墙。 bool (必需)
排除 排除列表。 ApplicationGatewayFirewallExclusion[]
fileUploadLimitInMb WAF 的最大文件上传大小（以 Mb 为单位）。 int

约束：
最小值 = 0
firewallMode Web 应用程序防火墙模式。 “检测”
需要“预防” ()
maxRequestBodySize WAF 的最大请求正文大小。 int

约束：
最小值 = 8
最大值 = 128
maxRequestBodySizeInKb WAF 的最大请求正文大小（以 Kb 为单位）。 int

约束：
最小值 = 8
最大值 = 128
requestBodyCheck 是否允许 WAF 检查请求正文。 bool
ruleSetType Web 应用程序防火墙规则集的类型。 可能的值为：“OWASP”。 字符串 (必需)
ruleSetVersion 规则集类型的版本。 字符串 (必需)

ApplicationGatewayFirewallDisabledRuleGroup

名称 说明 值
ruleGroupName 将禁用的规则组的名称。 字符串 (必需)
规则 将禁用的规则列表。 如果为 null，则将禁用规则组的所有规则。 int[]

ApplicationGatewayFirewallExclusion

名称 说明 值
matchVariable 要排除的变量。 字符串 (必需)
选择器 当 matchVariable 是集合时，运算符用于指定此排除项适用于集合中的哪些元素。 字符串 (必需)
selectorMatchOperator 当 matchVariable 是集合时，对选择器执行操作以指定此排除项适用于集合中的哪些元素。 字符串 (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
使用 Azure SQL 数据库自动缩放 LANSA Windows VM ScaleSet

部署到 Azure		 该模板部署一个 Windows VMSS，其中包含规模集中所需的 VM 计数，以及要安装到每个 VM 中的 LANSA MSI。 部署 VM 规模集后，将使用自定义脚本扩展安装 LANSA MSI)
在虚拟网络中Create WordPress 站点

部署到 Azure		 此模板在虚拟网络中的容器实例上创建 WordPress 站点。 并输出可访问 WordPress 站点的公共站点 FQDN。
Create Azure 应用程序网关 v2

部署到 Azure		 此模板在后端池中创建包含两个Windows Server 2016服务器的Azure 应用程序网关
在 Azure 应用程序网关 上Create Azure WAF v2

部署到 Azure		 此模板在 Azure 应用程序网关 上创建 Azure Web 应用程序防火墙 v2，后端池中具有两个Windows Server 2016服务器
具有 NAT 网关和应用程序网关的 AKS 群集

部署到 Azure		 此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，为入站连接部署应用程序网关。
Azure 应用程序网关演示设置

部署到 Azure		 通过此模板可以快速部署Azure 应用程序网关演示，以测试是否使用基于 Cookie 的相关性的负载均衡。
使用 ILB ASE 的 eShop 网站

部署到 Azure		 应用服务环境是 Azure 应用服务的一项高级服务计划选项，可提供完全隔离的专用环境来安全地大规模运行 Azure 应用服务应用，包括 Web 应用、移动应用和 API 应用。
多层流量管理器、L4 ILB、L7 AppGateway

部署到 Azure		 此模板部署虚拟网络、通过子网隔离网络、部署 VM 和配置负载均衡
具有 NSG、ILB、AppGateway 的多层应用

部署到 Azure		 此模板部署虚拟网络、通过子网隔离网络、部署 VM 和配置负载均衡
使用应用网关在内部 VNet 中Create API 管理

部署到 Azure		 此模板演示如何在受Azure 应用程序网关保护的专用网络上Create Azure API 管理 实例。
具有应用程序网关源的 Front Door 标准版/高级版

部署到 Azure		 此模板创建 Front Door 标准版/高级版和应用程序网关实例，并使用 NSG 和 WAF 策略验证流量是否已通过 Front Door 源。
带有容器实例和应用程序网关的 Front Door

部署到 Azure		 此模板使用容器组和应用程序网关创建 Front Door 标准版/高级版。
使用 Azure 应用程序网关 部署 Ubuntu VM 规模集

部署到 Azure		 此模板允许部署与 Azure 应用程序网关 集成的简单 Ubuntu VM 规模集，并且最多支持 1000 个 VM
使用 Azure 应用程序网关 部署 Windows VM 规模集

部署到 Azure		 此模板允许部署与 Azure 应用程序网关 集成的简单 Windows VM 规模集，并且最多支持 1000 个 VM
具有 应用程序网关 入口控制器的 AKS 群集

部署到 Azure		 此示例演示如何使用 应用程序网关、应用程序网关 入口控制器、Azure 容器注册表、Log Analytics 和 密钥保管库 部署 AKS 群集
使用 WAF、SSL、IIS 和 HTTPS 重定向的应用网关

部署到 Azure		 此模板在 IIS 服务器上部署具有 WAF、端到端 SSL 和 HTTP 到 HTTPS 重定向的应用程序网关。
Create应用程序网关

部署到 Azure		 此模板在虚拟网络中创建应用程序网关，并为任意数量的虚拟机设置负载均衡规则
Create IPv6 应用程序网关

部署到 Azure		 此模板在双堆栈虚拟网络中创建具有 IPv6 前端的应用程序网关。
使用 密钥保管库 Create 应用程序网关 V2

部署到 Azure		 此模板在虚拟网络中部署应用程序网关 V2、用户定义的标识、密钥保管库、机密 (证书数据) ，以及密钥保管库和应用程序网关上的访问策略。
多托管应用程序网关

部署到 Azure		 此模板创建应用程序网关并将其配置为端口 443 上的多托管。
使用路径替代Create应用程序网关

部署到 Azure		 此模板部署应用程序网关，并显示后端地址池的路径替代功能的使用情况。
使用探测Create应用程序网关

部署到 Azure		 此模板部署具有增强探测功能的应用程序网关。
使用公共 IP Create应用程序网关

部署到 Azure		 此模板为应用程序网关和在其中部署应用程序网关虚拟网络创建应用程序网关、公共 IP 地址。 此外，还配置两个后端服务器的 http 负载均衡应用程序网关。 请注意，必须为后端服务器指定有效的 IP。
使用公共 IP (卸载) Create应用程序网关

部署到 Azure		 此模板为应用程序网关和在其中部署应用程序网关虚拟网络创建应用程序网关、公共 IP 地址。 此外，还可以为两台后端服务器的 Ssl 卸载和负载均衡配置应用程序网关。 请注意，必须为后端服务器指定有效的 IP。
使用重定向Create应用程序网关

部署到 Azure		 此模板在虚拟网络中创建具有重定向功能的应用程序网关，并设置负载均衡和重定向规则 (基本和基于路径的)
使用重写Create应用程序网关

部署到 Azure		 此模板在虚拟网络中创建具有重写功能的应用程序网关，并设置负载均衡和重写规则
Create应用程序网关 (自定义 SSL)

部署到 Azure		 此模板部署使用自定义 ssl 策略配置的应用程序网关。
Create应用程序网关 (SSL 策略)

部署到 Azure		 此模板部署配置了预定义 ssl 策略的应用程序网关。
基于 URL 路径的路由的应用程序网关

部署到 Azure		 此模板创建应用程序网关并将其配置为基于 URL 路径的路由。
Create 应用程序网关 v2

部署到 Azure		 此模板在虚拟网络中创建应用程序网关 v2，并使用公共前端设置自动缩放属性和 HTTP 负载均衡规则
Create应用程序网关 (WAF)

部署到 Azure		 此模板在虚拟网络中创建具有Web 应用程序防火墙功能的应用程序网关，并为任意数量的虚拟机设置负载均衡规则
使用 WAF 和防火墙策略应用程序网关

部署到 Azure		 此模板创建一个应用程序网关，其中配置了 WAF 和防火墙策略
具有 IP 限制的 Web 应用的应用程序网关

部署到 Azure		 此模板在 Azure Web 应用前面创建一个应用程序网关，并在 Web 应用上启用了 IP 限制。
Create WebApps 应用程序网关

部署到 Azure		 此模板在启用了自定义探测的两个 Azure Web 应用前面创建应用程序网关。
使用证书Create 应用程序网关

部署到 Azure		 此模板演示如何生成密钥保管库自签名证书，然后从应用程序网关引用。
使用内部API 管理和 Web 应用应用程序网关

部署到 Azure		 应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。
Create受 应用程序网关 v2 保护的 Web 应用

部署到 Azure		 此模板为 应用程序网关 v2 创建具有访问限制的 Azure Web 应用。 应用程序网关部署在启用了“Microsoft.Web”服务终结点的 vNet (子网) 中。 Web 应用限制对来自子网的流量的访问。
Create Web 应用、PE 和 应用程序网关 v2

部署到 Azure		 此模板在 Azure 虚拟网络 子网 （应用程序网关 v2）中创建具有专用终结点的 Azure Web 应用。 应用程序网关部署在 vNet (子网) 中。 Web 应用使用专用终结点限制对来自子网的流量的访问

ARM 模板资源定义

可以使用面向以下操作部署 applicationGateways 资源类型：

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

资源格式

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

{
  "type": "Microsoft.Network/applicationGateways",
  "apiVersion": "2022-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "authenticationCertificates": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "data": "string"
        }
      }
    ],
    "autoscaleConfiguration": {
      "maxCapacity": "int",
      "minCapacity": "int"
    },
    "backendAddressPools": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "backendAddresses": [
            {
              "fqdn": "string",
              "ipAddress": "string"
            }
          ]
        }
      }
    ],
    "backendHttpSettingsCollection": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "affinityCookieName": "string",
          "authenticationCertificates": [
            {
              "id": "string"
            }
          ],
          "connectionDraining": {
            "drainTimeoutInSec": "int",
            "enabled": "bool"
          },
          "cookieBasedAffinity": "string",
          "hostName": "string",
          "path": "string",
          "pickHostNameFromBackendAddress": "bool",
          "port": "int",
          "probe": {
            "id": "string"
          },
          "probeEnabled": "bool",
          "protocol": "string",
          "requestTimeout": "int",
          "trustedRootCertificates": [
            {
              "id": "string"
            }
          ]
        }
      }
    ],
    "backendSettingsCollection": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "hostName": "string",
          "pickHostNameFromBackendAddress": "bool",
          "port": "int",
          "probe": {
            "id": "string"
          },
          "protocol": "string",
          "timeout": "int",
          "trustedRootCertificates": [
            {
              "id": "string"
            }
          ]
        }
      }
    ],
    "customErrorConfigurations": [
      {
        "customErrorPageUrl": "string",
        "statusCode": "string"
      }
    ],
    "enableFips": "bool",
    "enableHttp2": "bool",
    "firewallPolicy": {
      "id": "string"
    },
    "forceFirewallPolicyAssociation": "bool",
    "frontendIPConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateIPAddress": "string",
          "privateIPAllocationMethod": "string",
          "privateLinkConfiguration": {
            "id": "string"
          },
          "publicIPAddress": {
            "id": "string"
          },
          "subnet": {
            "id": "string"
          }
        }
      }
    ],
    "frontendPorts": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "port": "int"
        }
      }
    ],
    "gatewayIPConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "subnet": {
            "id": "string"
          }
        }
      }
    ],
    "globalConfiguration": {
      "enableRequestBuffering": "bool",
      "enableResponseBuffering": "bool"
    },
    "httpListeners": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "customErrorConfigurations": [
            {
              "customErrorPageUrl": "string",
              "statusCode": "string"
            }
          ],
          "firewallPolicy": {
            "id": "string"
          },
          "frontendIPConfiguration": {
            "id": "string"
          },
          "frontendPort": {
            "id": "string"
          },
          "hostName": "string",
          "hostNames": [ "string" ],
          "protocol": "string",
          "requireServerNameIndication": "bool",
          "sslCertificate": {
            "id": "string"
          },
          "sslProfile": {
            "id": "string"
          }
        }
      }
    ],
    "listeners": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "frontendIPConfiguration": {
            "id": "string"
          },
          "frontendPort": {
            "id": "string"
          },
          "protocol": "string",
          "sslCertificate": {
            "id": "string"
          },
          "sslProfile": {
            "id": "string"
          }
        }
      }
    ],
    "loadDistributionPolicies": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "loadDistributionAlgorithm": "string",
          "loadDistributionTargets": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "backendAddressPool": {
                  "id": "string"
                },
                "weightPerServer": "int"
              }
            }
          ]
        }
      }
    ],
    "privateLinkConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "ipConfigurations": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "primary": "bool",
                "privateIPAddress": "string",
                "privateIPAllocationMethod": "string",
                "subnet": {
                  "id": "string"
                }
              }
            }
          ]
        }
      }
    ],
    "probes": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "host": "string",
          "interval": "int",
          "match": {
            "body": "string",
            "statusCodes": [ "string" ]
          },
          "minServers": "int",
          "path": "string",
          "pickHostNameFromBackendHttpSettings": "bool",
          "pickHostNameFromBackendSettings": "bool",
          "port": "int",
          "protocol": "string",
          "timeout": "int",
          "unhealthyThreshold": "int"
        }
      }
    ],
    "redirectConfigurations": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "includePath": "bool",
          "includeQueryString": "bool",
          "pathRules": [
            {
              "id": "string"
            }
          ],
          "redirectType": "string",
          "requestRoutingRules": [
            {
              "id": "string"
            }
          ],
          "targetListener": {
            "id": "string"
          },
          "targetUrl": "string",
          "urlPathMaps": [
            {
              "id": "string"
            }
          ]
        }
      }
    ],
    "requestRoutingRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "backendAddressPool": {
            "id": "string"
          },
          "backendHttpSettings": {
            "id": "string"
          },
          "httpListener": {
            "id": "string"
          },
          "loadDistributionPolicy": {
            "id": "string"
          },
          "priority": "int",
          "redirectConfiguration": {
            "id": "string"
          },
          "rewriteRuleSet": {
            "id": "string"
          },
          "ruleType": "string",
          "urlPathMap": {
            "id": "string"
          }
        }
      }
    ],
    "rewriteRuleSets": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "rewriteRules": [
            {
              "actionSet": {
                "requestHeaderConfigurations": [
                  {
                    "headerName": "string",
                    "headerValue": "string"
                  }
                ],
                "responseHeaderConfigurations": [
                  {
                    "headerName": "string",
                    "headerValue": "string"
                  }
                ],
                "urlConfiguration": {
                  "modifiedPath": "string",
                  "modifiedQueryString": "string",
                  "reroute": "bool"
                }
              },
              "conditions": [
                {
                  "ignoreCase": "bool",
                  "negate": "bool",
                  "pattern": "string",
                  "variable": "string"
                }
              ],
              "name": "string",
              "ruleSequence": "int"
            }
          ]
        }
      }
    ],
    "routingRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "backendAddressPool": {
            "id": "string"
          },
          "backendSettings": {
            "id": "string"
          },
          "listener": {
            "id": "string"
          },
          "priority": "int",
          "ruleType": "string"
        }
      }
    ],
    "sku": {
      "capacity": "int",
      "name": "string",
      "tier": "string"
    },
    "sslCertificates": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "data": "string",
          "keyVaultSecretId": "string",
          "password": "string"
        }
      }
    ],
    "sslPolicy": {
      "cipherSuites": [ "string" ],
      "disabledSslProtocols": [ "string" ],
      "minProtocolVersion": "string",
      "policyName": "string",
      "policyType": "string"
    },
    "sslProfiles": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "clientAuthConfiguration": {
            "verifyClientCertIssuerDN": "bool",
            "verifyClientRevocation": "string"
          },
          "sslPolicy": {
            "cipherSuites": [ "string" ],
            "disabledSslProtocols": [ "string" ],
            "minProtocolVersion": "string",
            "policyName": "string",
            "policyType": "string"
          },
          "trustedClientCertificates": [
            {
              "id": "string"
            }
          ]
        }
      }
    ],
    "trustedClientCertificates": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "data": "string"
        }
      }
    ],
    "trustedRootCertificates": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "data": "string",
          "keyVaultSecretId": "string"
        }
      }
    ],
    "urlPathMaps": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "defaultBackendAddressPool": {
            "id": "string"
          },
          "defaultBackendHttpSettings": {
            "id": "string"
          },
          "defaultLoadDistributionPolicy": {
            "id": "string"
          },
          "defaultRedirectConfiguration": {
            "id": "string"
          },
          "defaultRewriteRuleSet": {
            "id": "string"
          },
          "pathRules": [
            {
              "id": "string",
              "name": "string",
              "properties": {
                "backendAddressPool": {
                  "id": "string"
                },
                "backendHttpSettings": {
                  "id": "string"
                },
                "firewallPolicy": {
                  "id": "string"
                },
                "loadDistributionPolicy": {
                  "id": "string"
                },
                "paths": [ "string" ],
                "redirectConfiguration": {
                  "id": "string"
                },
                "rewriteRuleSet": {
                  "id": "string"
                }
              }
            }
          ]
        }
      }
    ],
    "webApplicationFirewallConfiguration": {
      "disabledRuleGroups": [
        {
          "ruleGroupName": "string",
          "rules": [ "int" ]
        }
      ],
      "enabled": "bool",
      "exclusions": [
        {
          "matchVariable": "string",
          "selector": "string",
          "selectorMatchOperator": "string"
        }
      ],
      "fileUploadLimitInMb": "int",
      "firewallMode": "string",
      "maxRequestBodySize": "int",
      "maxRequestBodySizeInKb": "int",
      "requestBodyCheck": "bool",
      "ruleSetType": "string",
      "ruleSetVersion": "string"
    }
  },
  "zones": [ "string" ]
}

属性值

applicationGateways

名称 说明 Value
type 资源类型 'Microsoft.Network/applicationGateways'
apiVersion 资源 API 版本 '2022-11-01'
name 资源名称 字符串 (必需)

字符限制：1-80

有效字符：
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
标识 应用程序网关的标识（如果已配置）。 ManagedServiceIdentity
properties 应用程序网关的属性。 ApplicationGatewayPropertiesFormat
zones 指示资源需要来自何处的可用性区域列表。 string[]

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned， UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名称 说明 值
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

ApplicationGatewayPropertiesFormat

名称 说明 值
authenticationCertificates 应用程序网关资源的身份验证证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayAuthenticationCertificate[]
autoscaleConfiguration 自动缩放配置。 ApplicationGatewayAutoscaleConfiguration
backendAddressPools 应用程序网关资源的后端地址池。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendAddressPool[]
backendHttpSettingsCollection 应用程序网关资源的后端 http 设置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendHttpSettings[]
backendSettingsCollection 应用程序网关资源的后端设置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendSettings[]
customErrorConfigurations 应用程序网关资源的自定义错误配置。 ApplicationGatewayCustomError[]
enableFips 是否在应用程序网关资源上启用 FIPS。 bool
enableHttp2 是否在应用程序网关资源上启用 HTTP2。 bool
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
forceFirewallPolicyAssociation 如果为 true，则无论该策略是否不同于 WAF 配置，都会将防火墙策略与应用程序网关相关联。 bool
frontendIPConfigurations 应用程序网关资源的前端 IP 地址。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayFrontendIPConfiguration[]
frontendPorts 应用程序网关资源的前端端口。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayFrontendPort[]
gatewayIPConfigurations 应用程序网关资源的子网。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayIPConfiguration[]
globalConfiguration 全局配置。 ApplicationGatewayGlobalConfiguration
httpListeners 应用程序网关资源的 Http 侦听器。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayHttpListener[]
侦听器 应用程序网关资源的侦听器。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayListener[]
loadDistributionPolicies 应用程序网关资源的负载分发策略。 ApplicationGatewayLoadDistributionPolicy[]
privateLinkConfigurations 应用程序网关上的 PrivateLink 配置。 ApplicationGatewayPrivateLinkConfiguration[]
probes 应用程序网关资源的探测。 ApplicationGatewayProbe[]
redirectConfigurations 重定向应用程序网关资源的配置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayRedirectConfiguration[]
requestRoutingRules 应用程序网关资源的请求路由规则。 ApplicationGatewayRequestRoutingRule[]
rewriteRuleSets 重写应用程序网关资源的规则。 ApplicationGatewayRewriteRuleSet[]
routingRules 应用程序网关资源的路由规则。 ApplicationGatewayRoutingRule[]
sku 应用程序网关资源的 SKU。 ApplicationGatewaySku
sslCertificates 应用程序网关资源的 SSL 证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewaySslCertificate[]
sslPolicy 应用程序网关资源的 SSL 策略。 ApplicationGatewaySslPolicy
sslProfiles 应用程序网关资源的 SSL 配置文件。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewaySslProfile[]
trustedClientCertificates 应用程序网关资源的受信任客户端证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayTrustedClientCertificate[]
trustedRootCertificates 应用程序网关资源的受信任根证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayTrustedRootCertificate[]
urlPathMaps 应用程序网关资源的 URL 路径映射。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayUrlPathMap[]
webApplicationFirewallConfiguration Web 应用程序防火墙配置。 ApplicationGatewayWebApplicationFirewallConfiguratio...

ApplicationGatewayAuthenticationCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的身份验证证书的名称。 string
properties 应用程序网关身份验证证书的属性。 ApplicationGatewayAuthenticationCertificatePropertie...

ApplicationGatewayAuthenticationCertificatePropertie...

名称 说明 值
data 证书公共数据。 字符串

ApplicationGatewayAutoscaleConfiguration

名称 说明 值
maxCapacity 应用程序网关容量的上限。 int

约束：
最小值 = 2
minCapacity 应用程序网关容量数的下限。 int (必需)

约束：
最小值 = 0

ApplicationGatewayBackendAddressPool

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端地址池的名称。 string
properties 应用程序网关后端地址池的属性。 ApplicationGatewayBackendAddressPoolPropertiesFormat

ApplicationGatewayBackendAddressPoolPropertiesFormat

名称 说明 值
backendAddresses 后端地址。 ApplicationGatewayBackendAddress[]

ApplicationGatewayBackendAddress

名称 说明 值
fqdn 完全限定的域名 (FQDN)。 字符串
ipAddress IP 地址。 字符串

ApplicationGatewayBackendHttpSettings

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端 http 设置的名称。 string
properties 应用程序网关后端 HTTP 设置的属性。 ApplicationGatewayBackendHttpSettingsPropertiesForma...

ApplicationGatewayBackendHttpSettingsPropertiesForma...

名称 说明 值
affinityCookieName 要用于关联 Cookie 的 Cookie 名称。 字符串
authenticationCertificates 对应用程序网关身份验证证书的引用数组。 SubResource[]
connectionDraining 后端 http 设置资源的连接清空。 ApplicationGatewayConnectionDraining
cookieBasedAffinity 基于 Cookie 的相关性。 'Disabled'
'Enabled'
hostName 要发送到后端服务器的主机标头。 字符串
path 应用作所有 HTTP 请求前缀的路径。 Null 表示不会以任何路径为前缀。 默认值为 null。 字符串
pickHostNameFromBackendAddress 是否应从后端服务器的主机名中选取主机标头。 默认值为 false。 bool
port 后端上的目标端口。 int
探测 应用程序网关的探测资源。 SubResource
probeEnabled 探测是否已启用。 默认值为 false。 bool
protocol 用于与后端通信的协议。 'Http'
'Https'
'Tcp'
“Tls”
requestTimeout 请求超时（以秒为单位）。 如果在 RequestTimeout 中未收到响应，应用程序网关请求将失败。 可接受的值为 1 秒到 86400 秒。 int
trustedRootCertificates 对应用程序网关受信任的根证书的引用数组。 SubResource[]

SubResource

名称 说明 Value
id 资源 ID。 字符串

ApplicationGatewayConnectionDraining

名称 说明 值
drainTimeoutInSec 连接排出处于活动状态的秒数。 可接受的值为 1 秒到 3600 秒。 int (必需)

约束：
最小值 = 1
最大值 = 3600
enabled 是否启用连接清空。 需要 bool ()

ApplicationGatewayBackendSettings

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端设置的名称。 string
properties 应用程序网关后端设置的属性。 ApplicationGatewayBackendSettingsPropertiesFormat

ApplicationGatewayBackendSettingsPropertiesFormat

名称 说明 值
hostName 服务器名称指示将发送到 Tls 协议的后端服务器。 字符串
pickHostNameFromBackendAddress 是否从 Tls 协议的后端服务器的主机名中选取服务器名称指示。 默认值为 false。 bool
port 后端上的目标端口。 int
探测 应用程序网关的探测资源。 SubResource
protocol 用于与后端通信的协议。 'Http'
'Https'
'Tcp'
“Tls”
timeout 连接超时（秒）。 如果在 ConnectionTimeout 中未收到响应，应用程序网关请求将失败。 可接受的值为 1 秒到 86400 秒。 int
trustedRootCertificates 对应用程序网关受信任的根证书的引用数组。 SubResource[]

ApplicationGatewayCustomError

名称 说明 值
customErrorPageUrl 应用程序网关自定义错误的错误页 URL。 字符串
statusCode 应用程序网关自定义错误的状态代码。 'HttpStatus400'
'HttpStatus403'
'HttpStatus404'
“HttpStatus405”
'HttpStatus408'
'HttpStatus499'
'HttpStatus500'
“HttpStatus502”
“HttpStatus503”
“HttpStatus504”

ApplicationGatewayFrontendIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的前端 IP 配置的名称。 string
properties 应用程序网关前端 IP 配置的属性。 ApplicationGatewayFrontendIPConfigurationPropertiesF...

ApplicationGatewayFrontendIPConfigurationPropertiesF...

名称 说明 值
privateIPAddress PrivateIP网络接口 IP 配置的地址。 字符串
privateIPAllocationMethod 专用 IP 地址分配方法。 'Dynamic'
'Static'
privateLinkConfiguration 对应用程序网关专用链接配置的引用。 SubResource
publicIPAddress 对 PublicIP 资源的引用。 SubResource
子网 对子网资源的引用。 SubResource

ApplicationGatewayFrontendPort

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的前端端口的名称。 string
properties 应用程序网关前端端口的属性。 ApplicationGatewayFrontendPortPropertiesFormat

ApplicationGatewayFrontendPortPropertiesFormat

名称 说明 值
port 前端端口。 int

ApplicationGatewayIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 IP 配置的名称。 string
properties 应用程序网关 IP 配置的属性。 ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名称 说明 值
子网 对子网资源的引用。 应用程序网关从中获取其专用地址的子网。 SubResource

ApplicationGatewayGlobalConfiguration

名称 说明 值
enableRequestBuffering 启用请求缓冲。 bool
enableResponseBuffering 启用响应缓冲。 bool

ApplicationGatewayHttpListener

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 HTTP 侦听器的名称。 string
properties 应用程序网关 HTTP 侦听器的属性。 ApplicationGatewayHttpListenerPropertiesFormat

ApplicationGatewayHttpListenerPropertiesFormat

名称 说明 值
customErrorConfigurations HTTP 侦听器的自定义错误配置。 ApplicationGatewayCustomError[]
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
frontendIPConfiguration 应用程序网关的前端 IP 配置资源。 SubResource
frontendPort 应用程序网关的前端端口资源。 SubResource
hostName HTTP 侦听器的主机名。 字符串
主机 名 也允许特殊通配符的 HTTP 侦听器的主机名列表。 string[]
protocol HTTP 侦听器的协议。 “Http”
“Https”
“Tcp”
“Tls”
requireServerNameIndication 仅当协议为 https 时才适用。 为多托管启用 SNI。 bool
sslCertificate 应用程序网关的 SSL 证书资源。 SubResource
sslProfile 应用程序网关的 SSL 配置文件资源。 SubResource

ApplicationGatewayListener

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的侦听器的名称。 string
properties 应用程序网关侦听器的属性。 ApplicationGatewayListenerPropertiesFormat

ApplicationGatewayListenerPropertiesFormat

名称 说明 值
frontendIPConfiguration 应用程序网关的前端 IP 配置资源。 SubResource
frontendPort 应用程序网关的前端端口资源。 SubResource
protocol 侦听器的协议。 “Http”
“Https”
“Tcp”
“Tls”
sslCertificate 应用程序网关的 SSL 证书资源。 SubResource
sslProfile 应用程序网关的 SSL 配置文件资源。 SubResource

ApplicationGatewayLoadDistributionPolicy

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的负载分发策略的名称。 string
properties 应用程序网关负载分发策略的属性。 ApplicationGatewayLoadDistributionPolicyPropertiesFo...

ApplicationGatewayLoadDistributionPolicyPropertiesFo...

名称 说明 值
loadDistributionAlgorithm 加载分发目标应用程序网关的资源。 “IpHash”
“LeastConnections”
“RoundRobin”
loadDistributionTargets 加载分发目标应用程序网关的资源。 ApplicationGatewayLoadDistributionTarget[]

ApplicationGatewayLoadDistributionTarget

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的负载分发策略的名称。 string
properties 应用程序网关负载分发目标的属性。 ApplicationGatewayLoadDistributionTargetPropertiesFo...

ApplicationGatewayLoadDistributionTargetPropertiesFo...

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
weightPerServer 每个服务器的权重。 范围介于 1 和 100 之间。 int

约束：
最小值 = 1
最大值 = 100

ApplicationGatewayPrivateLinkConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的专用链接配置的名称。 string
properties 应用程序网关专用链接配置的属性。 ApplicationGatewayPrivateLinkConfigurationProperties

ApplicationGatewayPrivateLinkConfigurationProperties

名称 说明 值
ipConfigurations 应用程序网关专用链接 IP 配置的数组。 ApplicationGatewayPrivateLinkIpConfiguration[]

ApplicationGatewayPrivateLinkIpConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关专用链接 IP 配置的名称。 string
properties 应用程序网关专用链接 IP 配置的属性。 ApplicationGatewayPrivateLinkIpConfigurationProperti...

ApplicationGatewayPrivateLinkIpConfigurationProperti...

名称 说明 值
角色实体 IP 配置是否为主。 bool
privateIPAddress IP 配置的专用 IP 地址。 字符串
privateIPAllocationMethod 专用 IP 地址分配方法。 “Dynamic”
“Static”
子网 对子网资源的引用。 SubResource

ApplicationGatewayProbe

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的探测的名称。 string
properties 应用程序网关探测的属性。 ApplicationGatewayProbePropertiesFormat

ApplicationGatewayProbePropertiesFormat

名称 说明 值
host 要向其发送探测的主机名。 字符串
interval 探测间隔（以秒为单位）。 这是每两次连续探测之间的时间间隔。 可接受的值为 1 秒到 86400 秒。 int
match 对正常探测响应进行分类的条件。 ApplicationGatewayProbeHealthResponseMatch
minServers 始终标记为正常的最小服务器数。 默认值为 0。 int
path 探测的相对路径。 有效路径从“/”开始。 探测将发送到 {Protocol}：//{host}：{port}{path}。 字符串
pickHostNameFromBackendHttpSettings 是否应从后端 http 设置中选取主机标头。 默认值为 false。 bool
pickHostNameFromBackendSettings 是否应从 Tls 协议的后端设置中选取服务器名称指示。 默认值为 false。 bool
port 将用于探测后端服务器的自定义端口。 有效值的范围从 1 到 65535。 如果未设置，将使用 http 设置中的端口。 此属性仅对Standard_v2和WAF_v2有效。 int

约束：
最小值 = 1
最大值 = 65535
protocol 用于探测的协议。 “Http”
“Https”
“Tcp”
“Tls”
timeout 探测超时（以秒为单位）。 如果在此超时期限内未收到有效响应，则探测标记为失败。 可接受的值为 1 秒到 86400 秒。 int
unhealthyThreshold 探测重试计数。 在连续探测失败计数达到 UnhealthyThreshold 后，后端服务器被标记为关闭。 可接受的值为 1 秒到 20 秒。 int

ApplicationGatewayProbeHealthResponseMatch

名称 说明 值
body 运行状况响应中必须包含的正文。 默认值为空。 字符串
statusCodes 允许的正常状态代码范围。 正常状态代码的默认范围是 200-399。 string[]

ApplicationGatewayRedirectConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的重定向配置的名称。 string
properties 应用程序网关重定向配置的属性。 ApplicationGatewayRedirectConfigurationPropertiesFor...

ApplicationGatewayRedirectConfigurationPropertiesFor...

名称 说明 值
includePath 在重定向的 URL 中包含路径。 bool
includeQueryString 在重定向的 URL 中包含查询字符串。 bool
pathRules 指定重定向配置的路径规则。 SubResource[]
redirectType HTTP 重定向类型。 “找到”
“永久”
“SeeOther”
“临时”
requestRoutingRules 指定重定向配置的请求路由。 SubResource[]
targetListener 引用要将请求重定向到的侦听器。 SubResource
targetUrl 将请求重定向到的 URL。 字符串
urlPathMaps 指定默认重定向配置的 URL 路径映射。 SubResource[]

ApplicationGatewayRequestRoutingRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的请求路由规则的名称。 string
properties 应用程序网关请求路由规则的属性。 ApplicationGatewayRequestRoutingRulePropertiesFormat

ApplicationGatewayRequestRoutingRulePropertiesFormat

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
backendHttpSettings 应用程序网关的后端 http 设置资源。 SubResource
httpListener 应用程序网关的 Http 侦听器资源。 SubResource
loadDistributionPolicy 应用程序网关的加载分发策略资源。 SubResource
priority 请求路由规则的优先级。 int

约束：
最小值 = 1
最大值 = 20000
redirectConfiguration 重定向应用程序网关的配置资源。 SubResource
rewriteRuleSet 重写应用程序网关的基本规则中的规则集资源。 SubResource
ruleType 规则类型。 “Basic”
“PathBasedRouting”
urlPathMap 应用程序网关的 URL 路径映射资源。 SubResource

ApplicationGatewayRewriteRuleSet

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的重写规则集的名称。 string
properties 应用程序网关重写规则集的属性。 ApplicationGatewayRewriteRuleSetPropertiesFormat

ApplicationGatewayRewriteRuleSetPropertiesFormat

名称 说明 值
rewriteRules 重写规则集中的规则。 ApplicationGatewayRewriteRule[]

ApplicationGatewayRewriteRule

名称 说明 值
actionSet 要作为重写规则的一部分执行的操作集。 ApplicationGatewayRewriteRuleActionSet
条件 将基于其评估操作集执行的条件。 ApplicationGatewayRewriteRuleCondition[]
name 应用程序网关中唯一的重写规则的名称。 字符串
ruleSequence 重写规则的规则序列，用于确定 RewriteRuleSet 中特定规则的执行顺序。 int

ApplicationGatewayRewriteRuleActionSet

名称 说明 值
requestHeaderConfigurations 操作集中的请求标头操作。 ApplicationGatewayHeaderConfiguration[]
responseHeaderConfigurations 操作集中的响应标头操作。 ApplicationGatewayHeaderConfiguration[]
urlConfiguration 操作集中的 URL 配置操作。 ApplicationGatewayUrlConfiguration

ApplicationGatewayHeaderConfiguration

名称 说明 值
headerName 标头配置的标头名称。 字符串
headerValue 标头配置的标头值。 字符串

ApplicationGatewayUrlConfiguration

名称 说明 值
modifiedPath 用户为 URL 重写提供的 URL 路径。 Null 表示不会更新任何路径。 默认值为 null。 字符串
modifiedQueryString 用户为 URL 重写提供的查询字符串。 Null 表示不会更新任何查询字符串。 默认值为 null。 字符串
重新路由 如果设置为 true，它将使用修改后的路径重新评估基于路径的请求路由规则中提供的 URL 路径映射。 默认值为 false。 bool

ApplicationGatewayRewriteRuleCondition

名称 说明 值
ignoreCase 使用 将此参数设置为真值会强制模式执行区分大小写的比较。 bool
negate 将此值设置为真值将强制检查用户给出的条件的否定。 bool
pattern 计算条件真实性的模式（固定字符串或正则表达式）。 字符串
可变 RewriteRuleCondition 的 condition 参数。 字符串

ApplicationGatewayRoutingRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的路由规则的名称。 string
properties 应用程序网关路由规则的属性。 ApplicationGatewayRoutingRulePropertiesFormat

ApplicationGatewayRoutingRulePropertiesFormat

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
backendSettings 应用程序网关的后端设置资源。 SubResource
听众 应用程序网关的侦听器资源。 SubResource
priority 路由规则的优先级。 int (必需)

约束：
最小值 = 1
最大值 = 20000
ruleType 规则类型。 'Basic'
“PathBasedRouting”

ApplicationGatewaySku

名称 说明 值
容量 容量 (应用程序网关的实例计数) 。 int
name 应用程序网关 SKU 的名称。 “Standard_Large”
“Standard_Medium”
“Standard_Small”
“Standard_v2”
“WAF_Large”
“WAF_Medium”
“WAF_v2”
层 应用程序网关的层。 'Standard'
“Standard_v2”
“WAF”
“WAF_v2”

ApplicationGatewaySslCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 SSL 证书的名称。 string
properties 应用程序网关 SSL 证书的属性。 ApplicationGatewaySslCertificatePropertiesFormat

ApplicationGatewaySslCertificatePropertiesFormat

名称 说明 值
data Base-64 编码的 pfx 证书。 仅适用于 PUT 请求。 字符串
keyVaultSecretId (base-64 编码的未加密 pfx 的机密 ID，) 存储在 KeyVault 中的“Secret”或“Certificate”对象。 字符串
password 数据中指定的 pfx 文件的密码。 仅适用于 PUT 请求。 字符串

ApplicationGatewaySslPolicy

名称 说明 值
cipherSuites 要按指定顺序启用到应用程序网关的 Ssl 密码套件。 包含任何一项的字符串数组：
“TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_128_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_128_CBC_SHA256”
“TLS_DHE_DSS_WITH_AES_256_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_256_CBC_SHA256”
“TLS_DHE_RSA_WITH_AES_128_CBC_SHA”
“TLS_DHE_RSA_WITH_AES_128_GCM_SHA256”
“TLS_DHE_RSA_WITH_AES_256_CBC_SHA”
“TLS_DHE_RSA_WITH_AES_256_GCM_SHA384”
“TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA”
“TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256”
“TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256”
“TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA”
“TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384”
“TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384”
“TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA”
“TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256”
“TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256”
“TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA”
“TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384”
“TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384”
“TLS_RSA_WITH_3DES_EDE_CBC_SHA”
“TLS_RSA_WITH_AES_128_CBC_SHA”
“TLS_RSA_WITH_AES_128_CBC_SHA256”
“TLS_RSA_WITH_AES_128_GCM_SHA256”
“TLS_RSA_WITH_AES_256_CBC_SHA”
“TLS_RSA_WITH_AES_256_CBC_SHA256”
“TLS_RSA_WITH_AES_256_GCM_SHA384”
disabledSslProtocols 在应用程序网关上禁用 Ssl 协议。 包含任何一项的字符串数组：
“TLSv1_0”
“TLSv1_1”
“TLSv1_2”
“TLSv1_3”
minProtocolVersion 应用程序网关支持的最低 Ssl 协议版本。 “TLSv1_0”
“TLSv1_1”
“TLSv1_2”
“TLSv1_3”
policyName Ssl 预定义策略的名称。 “AppGwSslPolicy20150501”
“AppGwSslPolicy20170401”
“AppGwSslPolicy20170401S”
“AppGwSslPolicy20220101”
“AppGwSslPolicy20220101S”
policyType Ssl 策略的类型。 “Custom”
“CustomV2”
“Predefined”

ApplicationGatewaySslProfile

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 SSL 配置文件的名称。 string
properties 应用程序网关 SSL 配置文件的属性。 ApplicationGatewaySslProfilePropertiesFormat

ApplicationGatewaySslProfilePropertiesFormat

名称 说明 值
clientAuthConfiguration 应用程序网关资源的客户端身份验证配置。 ApplicationGatewayClientAuthConfiguration
sslPolicy 应用程序网关资源的 SSL 策略。 ApplicationGatewaySslPolicy
trustedClientCertificates 对应用程序网关受信任客户端证书的引用数组。 SubResource[]

ApplicationGatewayClientAuthConfiguration

名称 说明 值
verifyClientCertIssuerDN 验证应用程序网关上的客户端证书颁发者名称。 bool
verifyClientRevocation 验证客户端证书吊销状态。 “None”
“OCSP”

ApplicationGatewayTrustedClientCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的受信任客户端证书的名称。 string
properties 应用程序网关受信任的客户端证书的属性。 ApplicationGatewayTrustedClientCertificateProperties...

ApplicationGatewayTrustedClientCertificateProperties...

名称 说明 值
data 证书公共数据。 字符串

ApplicationGatewayTrustedRootCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的受信任根证书的名称。 string
properties 应用程序网关受信任的根证书的属性。 ApplicationGatewayTrustedRootCertificatePropertiesFo...

ApplicationGatewayTrustedRootCertificatePropertiesFo...

名称 说明 值
data 证书公共数据。 字符串
keyVaultSecretId (base-64 编码的未加密 pfx 的机密 ID，) 存储在 KeyVault 中的“Secret”或“Certificate”对象。 字符串

ApplicationGatewayUrlPathMap

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 URL 路径映射的名称。 string
properties 应用程序网关 URL 路径映射的属性。 ApplicationGatewayUrlPathMapPropertiesFormat

ApplicationGatewayUrlPathMapPropertiesFormat

名称 说明 值
defaultBackendAddressPool URL 路径映射的默认后端地址池资源。 SubResource
defaultBackendHttpSettings URL 路径映射的默认后端 http 设置资源。 SubResource
defaultLoadDistributionPolicy URL 路径映射的默认负载分发策略资源。 SubResource
defaultRedirectConfiguration URL 路径映射的默认重定向配置资源。 SubResource
defaultRewriteRuleSet URL 路径映射的默认重写规则集资源。 SubResource
pathRules URL 路径映射资源的路径规则。 ApplicationGatewayPathRule[]

ApplicationGatewayPathRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的路径规则的名称。 string
properties 应用程序网关路径规则的属性。 ApplicationGatewayPathRulePropertiesFormat

ApplicationGatewayPathRulePropertiesFormat

名称 说明 值
backendAddressPool URL 路径映射路径规则的后端地址池资源。 SubResource
backendHttpSettings URL 路径映射路径规则的后端 http 设置资源。 SubResource
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
loadDistributionPolicy URL 路径映射路径规则的加载分发策略资源。 SubResource
路径 URL 路径映射的路径规则。 string[]
redirectConfiguration URL 路径映射路径规则的重定向配置资源。 SubResource
rewriteRuleSet 重写 URL 路径映射路径规则的规则集资源。 SubResource

ApplicationGatewayWebApplicationFirewallConfiguratio...

名称 说明 值
disabledRuleGroups 禁用的规则组。 ApplicationGatewayFirewallDisabledRuleGroup[]
enabled 是否启用 Web 应用程序防火墙。 bool (必需)
排除 排除列表。 ApplicationGatewayFirewallExclusion[]
fileUploadLimitInMb WAF 的最大文件上传大小（以 Mb 为单位）。 int

约束：
最小值 = 0
firewallMode Web 应用程序防火墙模式。 “检测”
需要“预防” ()
maxRequestBodySize WAF 的最大请求正文大小。 int

约束：
最小值 = 8
最大值 = 128
maxRequestBodySizeInKb WAF 的最大请求正文大小（以 Kb 为单位）。 int

约束：
最小值 = 8
最大值 = 128
requestBodyCheck 是否允许 WAF 检查请求正文。 bool
ruleSetType Web 应用程序防火墙规则集的类型。 可能的值为：“OWASP”。 字符串 (必需)
ruleSetVersion 规则集类型的版本。 字符串 (必需)

ApplicationGatewayFirewallDisabledRuleGroup

名称 说明 值
ruleGroupName 将禁用的规则组的名称。 字符串 (必需)
规则 将禁用的规则列表。 如果为 null，则将禁用规则组的所有规则。 int[]

ApplicationGatewayFirewallExclusion

名称 说明 值
matchVariable 要排除的变量。 字符串 (必需)
选择器 当 matchVariable 是集合时，运算符用于指定此排除项适用于集合中的哪些元素。 字符串 (必需)
selectorMatchOperator 当 matchVariable 是集合时，对选择器执行操作以指定此排除项适用于集合中的哪些元素。 字符串 (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
使用 Azure SQL 数据库自动缩放 LANSA Windows VM ScaleSet

部署到 Azure		 该模板部署一个 Windows VMSS，其中包含规模集中所需的 VM 计数，以及要安装到每个 VM 中的 LANSA MSI。 部署 VM 规模集后，将使用自定义脚本扩展安装 LANSA MSI)
在虚拟网络中Create WordPress 站点

部署到 Azure		 此模板在虚拟网络中的容器实例上创建 WordPress 站点。 并输出可访问 WordPress 站点的公共站点 FQDN。
Create Azure 应用程序网关 v2

部署到 Azure		 此模板在后端池中创建包含两个Windows Server 2016服务器的Azure 应用程序网关
在 Azure 应用程序网关 上Create Azure WAF v2

部署到 Azure		 此模板在 Azure 应用程序网关 上创建 Azure Web 应用程序防火墙 v2，后端池中具有两个Windows Server 2016服务器
具有 NAT 网关和应用程序网关的 AKS 群集

部署到 Azure		 此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，为入站连接部署应用程序网关。
Azure 应用程序网关演示设置

部署到 Azure		 通过此模板可以快速部署Azure 应用程序网关演示，以测试是否使用基于 Cookie 的相关性的负载均衡。
使用 ILB ASE 的 eShop 网站

部署到 Azure		 应用服务环境是 Azure 应用服务的一项高级服务计划选项，可提供完全隔离的专用环境来安全地大规模运行 Azure 应用服务应用，包括 Web 应用、移动应用和 API 应用。
多层流量管理器、L4 ILB、L7 AppGateway

部署到 Azure		 此模板部署虚拟网络、通过子网隔离网络、部署 VM 和配置负载均衡
具有 NSG、ILB、AppGateway 的多层应用

部署到 Azure		 此模板部署虚拟网络、通过子网隔离网络、部署 VM 和配置负载均衡
使用应用网关在内部 VNet 中Create API 管理

部署到 Azure		 此模板演示如何在受Azure 应用程序网关保护的专用网络上Create Azure API 管理 实例。
具有应用程序网关源的 Front Door 标准版/高级版

部署到 Azure		 此模板创建 Front Door 标准版/高级版和应用程序网关实例，并使用 NSG 和 WAF 策略验证流量是否已通过 Front Door 源。
带有容器实例和应用程序网关的 Front Door

部署到 Azure		 此模板使用容器组和应用程序网关创建 Front Door 标准版/高级版。
使用 Azure 应用程序网关 部署 Ubuntu VM 规模集

部署到 Azure		 此模板允许部署与 Azure 应用程序网关 集成的简单 Ubuntu VM 规模集，并且最多支持 1000 个 VM
使用 Azure 应用程序网关 部署 Windows VM 规模集

部署到 Azure		 此模板允许部署与 Azure 应用程序网关 集成的简单 Windows VM 规模集，并且最多支持 1000 个 VM
具有 应用程序网关 入口控制器的 AKS 群集

部署到 Azure		 此示例演示如何使用 应用程序网关、应用程序网关 入口控制器、Azure 容器注册表、Log Analytics 和 密钥保管库 部署 AKS 群集
使用 WAF、SSL、IIS 和 HTTPS 重定向的应用网关

部署到 Azure		 此模板在 IIS 服务器上部署具有 WAF、端到端 SSL 和 HTTP 到 HTTPS 重定向的应用程序网关。
Create应用程序网关

部署到 Azure		 此模板在虚拟网络中创建应用程序网关，并为任意数量的虚拟机设置负载均衡规则
Create IPv6 应用程序网关

部署到 Azure		 此模板在双堆栈虚拟网络中创建具有 IPv6 前端的应用程序网关。
使用 密钥保管库 Create 应用程序网关 V2

部署到 Azure		 此模板在虚拟网络中部署应用程序网关 V2、用户定义的标识、密钥保管库、机密 (证书数据) ，以及密钥保管库和应用程序网关上的访问策略。
多宿主应用程序网关

部署到 Azure		 此模板创建应用程序网关并将其配置为端口 443 上的多宿主。
使用路径替代Create应用程序网关

部署到 Azure		 此模板部署应用程序网关并显示后端地址池的路径替代功能的使用情况。
使用探测Create应用程序网关

部署到 Azure		 此模板部署具有增强探测功能的应用程序网关。
使用公共 IP Create应用程序网关

部署到 Azure		 此模板创建应用程序网关、应用程序网关的公共 IP 地址，以及在其中部署应用程序网关虚拟网络。 此外，为两台后端服务器的 Http 负载均衡配置应用程序网关。 请注意，必须为后端服务器指定有效的 IP。
使用公共 IP (卸载) Create应用程序网关

部署到 Azure		 此模板创建应用程序网关、应用程序网关的公共 IP 地址，以及在其中部署应用程序网关虚拟网络。 还配置应用程序网关，以便使用两个后端服务器进行 Ssl 卸载和负载均衡。 请注意，必须为后端服务器指定有效的 IP。
使用重定向Create应用程序网关

部署到 Azure		 此模板在虚拟网络中创建具有重定向功能的应用程序网关，并设置负载均衡和重定向规则 (基本和基于路径的)
使用重写Create应用程序网关

部署到 Azure		 此模板在虚拟网络中创建具有重写功能的应用程序网关，并设置负载均衡和重写规则
Create应用程序网关 (自定义 SSL)

部署到 Azure		 此模板部署使用自定义 ssl 策略配置的应用程序网关。
Create应用程序网关 (SSL 策略)

部署到 Azure		 此模板部署配置了预定义 ssl 策略的应用程序网关。
基于 URL 路径的路由的应用程序网关

部署到 Azure		 此模板创建应用程序网关并将其配置为基于 URL 路径的路由。
Create 应用程序网关 v2

部署到 Azure		 此模板在虚拟网络中创建应用程序网关 v2，并使用公共前端设置自动缩放属性和 HTTP 负载均衡规则
Create应用程序网关 (WAF)

部署到 Azure		 此模板在虚拟网络中创建具有Web 应用程序防火墙功能的应用程序网关，并为任意数量的虚拟机设置负载均衡规则
使用 WAF 和防火墙策略应用程序网关

部署到 Azure		 此模板创建一个应用程序网关，其中配置了 WAF 和防火墙策略
具有 IP 限制的 Web 应用的应用程序网关

部署到 Azure		 此模板在 Azure Web 应用前面创建一个应用程序网关，并在 Web 应用上启用了 IP 限制。
Create WebApps 应用程序网关

部署到 Azure		 此模板在启用了自定义探测的两个 Azure Web 应用前面创建应用程序网关。
使用证书Create 应用程序网关

部署到 Azure		 此模板演示如何生成密钥保管库自签名证书，然后从应用程序网关引用。
使用内部API 管理和 Web 应用应用程序网关

部署到 Azure		 应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。
Create受 应用程序网关 v2 保护的 Web 应用

部署到 Azure		 此模板为 应用程序网关 v2 创建具有访问限制的 Azure Web 应用。 应用程序网关部署在启用了“Microsoft.Web”服务终结点的 vNet (子网) 中。 Web 应用限制对来自子网的流量的访问。
Create Web 应用、PE 和 应用程序网关 v2

部署到 Azure		 此模板在 Azure 虚拟网络 子网 （应用程序网关 v2）中创建具有专用终结点的 Azure Web 应用。 应用程序网关部署在 vNet (子网) 中。 Web 应用使用专用终结点限制对来自子网的流量的访问

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

可以使用面向以下操作部署 applicationGateways 资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/applicationGateways@2022-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      authenticationCertificates = [
        {
          id = "string"
          name = "string"
          properties = {
            data = "string"
          }
        }
      ]
      autoscaleConfiguration = {
        maxCapacity = int
        minCapacity = int
      }
      backendAddressPools = [
        {
          id = "string"
          name = "string"
          properties = {
            backendAddresses = [
              {
                fqdn = "string"
                ipAddress = "string"
              }
            ]
          }
        }
      ]
      backendHttpSettingsCollection = [
        {
          id = "string"
          name = "string"
          properties = {
            affinityCookieName = "string"
            authenticationCertificates = [
              {
                id = "string"
              }
            ]
            connectionDraining = {
              drainTimeoutInSec = int
              enabled = bool
            }
            cookieBasedAffinity = "string"
            hostName = "string"
            path = "string"
            pickHostNameFromBackendAddress = bool
            port = int
            probe = {
              id = "string"
            }
            probeEnabled = bool
            protocol = "string"
            requestTimeout = int
            trustedRootCertificates = [
              {
                id = "string"
              }
            ]
          }
        }
      ]
      backendSettingsCollection = [
        {
          id = "string"
          name = "string"
          properties = {
            hostName = "string"
            pickHostNameFromBackendAddress = bool
            port = int
            probe = {
              id = "string"
            }
            protocol = "string"
            timeout = int
            trustedRootCertificates = [
              {
                id = "string"
              }
            ]
          }
        }
      ]
      customErrorConfigurations = [
        {
          customErrorPageUrl = "string"
          statusCode = "string"
        }
      ]
      enableFips = bool
      enableHttp2 = bool
      firewallPolicy = {
        id = "string"
      }
      forceFirewallPolicyAssociation = bool
      frontendIPConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            privateIPAddress = "string"
            privateIPAllocationMethod = "string"
            privateLinkConfiguration = {
              id = "string"
            }
            publicIPAddress = {
              id = "string"
            }
            subnet = {
              id = "string"
            }
          }
        }
      ]
      frontendPorts = [
        {
          id = "string"
          name = "string"
          properties = {
            port = int
          }
        }
      ]
      gatewayIPConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            subnet = {
              id = "string"
            }
          }
        }
      ]
      globalConfiguration = {
        enableRequestBuffering = bool
        enableResponseBuffering = bool
      }
      httpListeners = [
        {
          id = "string"
          name = "string"
          properties = {
            customErrorConfigurations = [
              {
                customErrorPageUrl = "string"
                statusCode = "string"
              }
            ]
            firewallPolicy = {
              id = "string"
            }
            frontendIPConfiguration = {
              id = "string"
            }
            frontendPort = {
              id = "string"
            }
            hostName = "string"
            hostNames = [
              "string"
            ]
            protocol = "string"
            requireServerNameIndication = bool
            sslCertificate = {
              id = "string"
            }
            sslProfile = {
              id = "string"
            }
          }
        }
      ]
      listeners = [
        {
          id = "string"
          name = "string"
          properties = {
            frontendIPConfiguration = {
              id = "string"
            }
            frontendPort = {
              id = "string"
            }
            protocol = "string"
            sslCertificate = {
              id = "string"
            }
            sslProfile = {
              id = "string"
            }
          }
        }
      ]
      loadDistributionPolicies = [
        {
          id = "string"
          name = "string"
          properties = {
            loadDistributionAlgorithm = "string"
            loadDistributionTargets = [
              {
                id = "string"
                name = "string"
                properties = {
                  backendAddressPool = {
                    id = "string"
                  }
                  weightPerServer = int
                }
              }
            ]
          }
        }
      ]
      privateLinkConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            ipConfigurations = [
              {
                id = "string"
                name = "string"
                properties = {
                  primary = bool
                  privateIPAddress = "string"
                  privateIPAllocationMethod = "string"
                  subnet = {
                    id = "string"
                  }
                }
              }
            ]
          }
        }
      ]
      probes = [
        {
          id = "string"
          name = "string"
          properties = {
            host = "string"
            interval = int
            match = {
              body = "string"
              statusCodes = [
                "string"
              ]
            }
            minServers = int
            path = "string"
            pickHostNameFromBackendHttpSettings = bool
            pickHostNameFromBackendSettings = bool
            port = int
            protocol = "string"
            timeout = int
            unhealthyThreshold = int
          }
        }
      ]
      redirectConfigurations = [
        {
          id = "string"
          name = "string"
          properties = {
            includePath = bool
            includeQueryString = bool
            pathRules = [
              {
                id = "string"
              }
            ]
            redirectType = "string"
            requestRoutingRules = [
              {
                id = "string"
              }
            ]
            targetListener = {
              id = "string"
            }
            targetUrl = "string"
            urlPathMaps = [
              {
                id = "string"
              }
            ]
          }
        }
      ]
      requestRoutingRules = [
        {
          id = "string"
          name = "string"
          properties = {
            backendAddressPool = {
              id = "string"
            }
            backendHttpSettings = {
              id = "string"
            }
            httpListener = {
              id = "string"
            }
            loadDistributionPolicy = {
              id = "string"
            }
            priority = int
            redirectConfiguration = {
              id = "string"
            }
            rewriteRuleSet = {
              id = "string"
            }
            ruleType = "string"
            urlPathMap = {
              id = "string"
            }
          }
        }
      ]
      rewriteRuleSets = [
        {
          id = "string"
          name = "string"
          properties = {
            rewriteRules = [
              {
                actionSet = {
                  requestHeaderConfigurations = [
                    {
                      headerName = "string"
                      headerValue = "string"
                    }
                  ]
                  responseHeaderConfigurations = [
                    {
                      headerName = "string"
                      headerValue = "string"
                    }
                  ]
                  urlConfiguration = {
                    modifiedPath = "string"
                    modifiedQueryString = "string"
                    reroute = bool
                  }
                }
                conditions = [
                  {
                    ignoreCase = bool
                    negate = bool
                    pattern = "string"
                    variable = "string"
                  }
                ]
                name = "string"
                ruleSequence = int
              }
            ]
          }
        }
      ]
      routingRules = [
        {
          id = "string"
          name = "string"
          properties = {
            backendAddressPool = {
              id = "string"
            }
            backendSettings = {
              id = "string"
            }
            listener = {
              id = "string"
            }
            priority = int
            ruleType = "string"
          }
        }
      ]
      sku = {
        capacity = int
        name = "string"
        tier = "string"
      }
      sslCertificates = [
        {
          id = "string"
          name = "string"
          properties = {
            data = "string"
            keyVaultSecretId = "string"
            password = "string"
          }
        }
      ]
      sslPolicy = {
        cipherSuites = [
          "string"
        ]
        disabledSslProtocols = [
          "string"
        ]
        minProtocolVersion = "string"
        policyName = "string"
        policyType = "string"
      }
      sslProfiles = [
        {
          id = "string"
          name = "string"
          properties = {
            clientAuthConfiguration = {
              verifyClientCertIssuerDN = bool
              verifyClientRevocation = "string"
            }
            sslPolicy = {
              cipherSuites = [
                "string"
              ]
              disabledSslProtocols = [
                "string"
              ]
              minProtocolVersion = "string"
              policyName = "string"
              policyType = "string"
            }
            trustedClientCertificates = [
              {
                id = "string"
              }
            ]
          }
        }
      ]
      trustedClientCertificates = [
        {
          id = "string"
          name = "string"
          properties = {
            data = "string"
          }
        }
      ]
      trustedRootCertificates = [
        {
          id = "string"
          name = "string"
          properties = {
            data = "string"
            keyVaultSecretId = "string"
          }
        }
      ]
      urlPathMaps = [
        {
          id = "string"
          name = "string"
          properties = {
            defaultBackendAddressPool = {
              id = "string"
            }
            defaultBackendHttpSettings = {
              id = "string"
            }
            defaultLoadDistributionPolicy = {
              id = "string"
            }
            defaultRedirectConfiguration = {
              id = "string"
            }
            defaultRewriteRuleSet = {
              id = "string"
            }
            pathRules = [
              {
                id = "string"
                name = "string"
                properties = {
                  backendAddressPool = {
                    id = "string"
                  }
                  backendHttpSettings = {
                    id = "string"
                  }
                  firewallPolicy = {
                    id = "string"
                  }
                  loadDistributionPolicy = {
                    id = "string"
                  }
                  paths = [
                    "string"
                  ]
                  redirectConfiguration = {
                    id = "string"
                  }
                  rewriteRuleSet = {
                    id = "string"
                  }
                }
              }
            ]
          }
        }
      ]
      webApplicationFirewallConfiguration = {
        disabledRuleGroups = [
          {
            ruleGroupName = "string"
            rules = [
              int
            ]
          }
        ]
        enabled = bool
        exclusions = [
          {
            matchVariable = "string"
            selector = "string"
            selectorMatchOperator = "string"
          }
        ]
        fileUploadLimitInMb = int
        firewallMode = "string"
        maxRequestBodySize = int
        maxRequestBodySizeInKb = int
        requestBodyCheck = bool
        ruleSetType = "string"
        ruleSetVersion = "string"
      }
    }
    zones = [
      "string"
    ]
  })
}

属性值

applicationGateways

名称 说明 Value
type 资源类型 “Microsoft.Network/applicationGateways@2022-11-01”
name 资源名称 字符串 (必需)

字符限制：1-80

有效字符：
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
标识 应用程序网关的标识（如果已配置）。 ManagedServiceIdentity
properties 应用程序网关的属性。 ApplicationGatewayPropertiesFormat
zones 表示资源需要来自的可用性区域列表。 string[]

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从虚拟机中删除任何标识。 “SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”
identity_ids 与资源关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 用户标识 ID 数组。

ManagedServiceIdentityUserAssignedIdentities

名称 说明 值
{customized property} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

ApplicationGatewayPropertiesFormat

名称 说明 值
authenticationCertificates 应用程序网关资源的身份验证证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayAuthenticationCertificate[]
autoscaleConfiguration 自动缩放配置。 ApplicationGatewayAutoscaleConfiguration
backendAddressPools 应用程序网关资源的后端地址池。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendAddressPool[]
backendHttpSettingsCollection 应用程序网关资源的后端 http 设置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendHttpSettings[]
backendSettingsCollection 应用程序网关资源的后端设置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayBackendSettings[]
customErrorConfigurations 应用程序网关资源的自定义错误配置。 ApplicationGatewayCustomError[]
enableFips 是否在应用程序网关资源上启用 FIPS。 bool
enableHttp2 是否在应用程序网关资源上启用 HTTP2。 bool
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
forceFirewallPolicyAssociation 如果为 true，则无论该策略是否不同于 WAF 配置，都会将防火墙策略与应用程序网关相关联。 bool
frontendIPConfigurations 应用程序网关资源的前端 IP 地址。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayFrontendIPConfiguration[]
frontendPorts 应用程序网关资源的前端端口。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayFrontendPort[]
gatewayIPConfigurations 应用程序网关资源的子网。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayIPConfiguration[]
globalConfiguration 全局配置。 ApplicationGatewayGlobalConfiguration
httpListeners 应用程序网关资源的 Http 侦听器。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayHttpListener[]
侦听器 应用程序网关资源的侦听器。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayListener[]
loadDistributionPolicies 应用程序网关资源的负载分发策略。 ApplicationGatewayLoadDistributionPolicy[]
privateLinkConfigurations 应用程序网关上的 PrivateLink 配置。 ApplicationGatewayPrivateLinkConfiguration[]
probes 应用程序网关资源的探测。 ApplicationGatewayProbe[]
redirectConfigurations 重定向应用程序网关资源的配置。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayRedirectConfiguration[]
requestRoutingRules 应用程序网关资源的请求路由规则。 ApplicationGatewayRequestRoutingRule[]
rewriteRuleSets 重写应用程序网关资源的规则。 ApplicationGatewayRewriteRuleSet[]
routingRules 应用程序网关资源的路由规则。 ApplicationGatewayRoutingRule[]
sku 应用程序网关资源的 SKU。 ApplicationGatewaySku
sslCertificates 应用程序网关资源的 SSL 证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewaySslCertificate[]
sslPolicy 应用程序网关资源的 SSL 策略。 ApplicationGatewaySslPolicy
sslProfiles 应用程序网关资源的 SSL 配置文件。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewaySslProfile[]
trustedClientCertificates 应用程序网关资源的受信任客户端证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayTrustedClientCertificate[]
trustedRootCertificates 应用程序网关资源的受信任根证书。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayTrustedRootCertificate[]
urlPathMaps 应用程序网关资源的 URL 路径映射。 有关默认限制，请参阅应用程序网关限制。 ApplicationGatewayUrlPathMap[]
webApplicationFirewallConfiguration Web 应用程序防火墙配置。 ApplicationGatewayWebApplicationFirewallConfiguratio...

ApplicationGatewayAuthenticationCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的身份验证证书的名称。 string
properties 应用程序网关身份验证证书的属性。 ApplicationGatewayAuthenticationCertificatePropertie...

ApplicationGatewayAuthenticationCertificatePropertie...

名称 说明 值
data 证书公共数据。 字符串

ApplicationGatewayAutoscaleConfiguration

名称 说明 值
maxCapacity 应用程序网关容量的上限。 int

约束：
最小值 = 2
minCapacity 应用程序网关容量数的下限。 int (必需)

约束：
最小值 = 0

ApplicationGatewayBackendAddressPool

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端地址池的名称。 string
properties 应用程序网关后端地址池的属性。 ApplicationGatewayBackendAddressPoolPropertiesFormat

ApplicationGatewayBackendAddressPoolPropertiesFormat

名称 说明 值
backendAddresses 后端地址。 ApplicationGatewayBackendAddress[]

ApplicationGatewayBackendAddress

名称 说明 值
fqdn 完全限定的域名 (FQDN)。 字符串
ipAddress IP 地址。 字符串

ApplicationGatewayBackendHttpSettings

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端 http 设置的名称。 string
properties 应用程序网关后端 HTTP 设置的属性。 ApplicationGatewayBackendHttpSettingsPropertiesForma...

ApplicationGatewayBackendHttpSettingsPropertiesForma...

名称 说明 值
affinityCookieName 要用于关联 Cookie 的 Cookie 名称。 字符串
authenticationCertificates 对应用程序网关身份验证证书的引用数组。 SubResource[]
connectionDraining 后端 http 设置资源的连接清空。 ApplicationGatewayConnectionDraining
cookieBasedAffinity 基于 Cookie 的相关性。 “Disabled”
“Enabled”
hostName 要发送到后端服务器的主机标头。 字符串
path 应用作所有 HTTP 请求前缀的路径。 Null 表示不会以任何路径为前缀。 默认值为 null。 字符串
pickHostNameFromBackendAddress 是否应从后端服务器的主机名中选取主机标头。 默认值为 false。 bool
port 后端上的目标端口。 int
探测 应用程序网关的探测资源。 SubResource
probeEnabled 探测是否已启用。 默认值为 false。 bool
protocol 用于与后端通信的协议。 “Http”
“Https”
“Tcp”
“Tls”
requestTimeout 请求超时（以秒为单位）。 如果在 RequestTimeout 中未收到响应，应用程序网关请求将失败。 可接受的值为 1 秒到 86400 秒。 int
trustedRootCertificates 对应用程序网关受信任的根证书的引用数组。 SubResource[]

SubResource

名称 说明 Value
id 资源 ID。 字符串

ApplicationGatewayConnectionDraining

名称 说明 值
drainTimeoutInSec 连接排出处于活动状态的秒数。 可接受的值为 1 秒到 3600 秒。 int (必需)

约束：
最小值 = 1
最大值 = 3600
enabled 是否启用连接清空。 需要 bool ()

ApplicationGatewayBackendSettings

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的后端设置的名称。 string
properties 应用程序网关后端设置的属性。 ApplicationGatewayBackendSettingsPropertiesFormat

ApplicationGatewayBackendSettingsPropertiesFormat

名称 说明 值
hostName 要发送到后端服务器的 Tls 协议的服务器名称指示。 字符串
pickHostNameFromBackendAddress 是否从 Tls 协议的后端服务器的主机名中选取服务器名称指示。 默认值为 false。 bool
port 后端上的目标端口。 int
探测 应用程序网关的探测资源。 SubResource
protocol 用于与后端通信的协议。 “Http”
“Https”
“Tcp”
“Tls”
timeout 连接超时（秒）。 如果在 ConnectionTimeout 中未收到响应，应用程序网关请求将失败。 可接受的值为 1 秒到 86400 秒。 int
trustedRootCertificates 对应用程序网关受信任的根证书的引用数组。 SubResource[]

ApplicationGatewayCustomError

名称 说明 值
customErrorPageUrl 应用程序网关自定义错误的错误页 URL。 字符串
statusCode 应用程序网关自定义错误的状态代码。 “HttpStatus400”
“HttpStatus403”
“HttpStatus404”
“HttpStatus405”
“HttpStatus408”
“HttpStatus499”
“HttpStatus500”
“HttpStatus502”
“HttpStatus503”
“HttpStatus504”

ApplicationGatewayFrontendIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的前端 IP 配置的名称。 string
properties 应用程序网关前端 IP 配置的属性。 ApplicationGatewayFrontendIPConfigurationPropertiesF...

ApplicationGatewayFrontendIPConfigurationPropertiesF...

名称 说明 值
privateIPAddress PrivateIPAddress 网络接口 IP 配置。 字符串
privateIPAllocationMethod 专用 IP 地址分配方法。 “动态”
“Static”
privateLinkConfiguration 对应用程序网关专用链接配置的引用。 SubResource
publicIPAddress 对 PublicIP 资源的引用。 SubResource
子网 对子网资源的引用。 SubResource

ApplicationGatewayFrontendPort

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的前端端口的名称。 string
properties 应用程序网关前端端口的属性。 ApplicationGatewayFrontendPortPropertiesFormat

ApplicationGatewayFrontendPortPropertiesFormat

名称 说明 值
port 前端端口。 int

ApplicationGatewayIPConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 IP 配置的名称。 string
properties 应用程序网关 IP 配置的属性。 ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationGatewayIPConfigurationPropertiesFormat

名称 说明 值
子网 对子网资源的引用。 应用程序网关从中获取其专用地址的子网。 SubResource

ApplicationGatewayGlobalConfiguration

名称 说明 值
enableRequestBuffering 启用请求缓冲。 bool
enableResponseBuffering 启用响应缓冲。 bool

ApplicationGatewayHttpListener

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 HTTP 侦听器的名称。 string
properties 应用程序网关 HTTP 侦听器的属性。 ApplicationGatewayHttpListenerPropertiesFormat

ApplicationGatewayHttpListenerPropertiesFormat

名称 说明 值
customErrorConfigurations HTTP 侦听器的自定义错误配置。 ApplicationGatewayCustomError[]
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
frontendIPConfiguration 应用程序网关的前端 IP 配置资源。 SubResource
frontendPort 应用程序网关的前端端口资源。 SubResource
hostName HTTP 侦听器的主机名。 字符串
主机 名 也允许特殊通配符的 HTTP 侦听器的主机名列表。 string[]
protocol HTTP 侦听器的协议。 “Http”
“Https”
“Tcp”
“Tls”
requireServerNameIndication 仅当协议为 https 时才适用。 为多托管启用 SNI。 bool
sslCertificate 应用程序网关的 SSL 证书资源。 SubResource
sslProfile 应用程序网关的 SSL 配置文件资源。 SubResource

ApplicationGatewayListener

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的侦听器的名称。 string
properties 应用程序网关侦听器的属性。 ApplicationGatewayListenerPropertiesFormat

ApplicationGatewayListenerPropertiesFormat

名称 说明 值
frontendIPConfiguration 应用程序网关的前端 IP 配置资源。 SubResource
frontendPort 应用程序网关的前端端口资源。 SubResource
protocol 侦听器的协议。 “Http”
“Https”
“Tcp”
“Tls”
sslCertificate 应用程序网关的 SSL 证书资源。 SubResource
sslProfile 应用程序网关的 SSL 配置文件资源。 SubResource

ApplicationGatewayLoadDistributionPolicy

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的负载分配策略的名称。 string
properties 应用程序网关负载分发策略的属性。 ApplicationGatewayLoadDistributionPolicyPropertiesFo...

ApplicationGatewayLoadDistributionPolicyPropertiesFo...

名称 说明 值
loadDistributionAlgorithm 负载分发 目标应用程序网关的资源。 “IpHash”
“LeastConnections”
“RoundRobin”
loadDistributionTargets 负载分发 目标应用程序网关的资源。 ApplicationGatewayLoadDistributionTarget[]

ApplicationGatewayLoadDistributionTarget

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的负载分配策略的名称。 string
properties 应用程序网关负载分发目标的属性。 ApplicationGatewayLoadDistributionTargetPropertiesFo...

ApplicationGatewayLoadDistributionTargetPropertiesFo...

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
weightPerServer 每个服务器的权重。 范围介于 1 和 100 之间。 int

约束：
最小值 = 1
最大值 = 100

ApplicationGatewayPrivateLinkConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的专用链接配置的名称。 string
properties 应用程序网关专用链接配置的属性。 ApplicationGatewayPrivateLinkConfigurationProperties

ApplicationGatewayPrivateLinkConfigurationProperties

名称 说明 值
ipConfigurations 应用程序网关专用链接 IP 配置的数组。 ApplicationGatewayPrivateLinkIpConfiguration[]

ApplicationGatewayPrivateLinkIpConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关专用链接 IP 配置的名称。 string
properties 应用程序网关专用链接 IP 配置的属性。 ApplicationGatewayPrivateLinkIpConfigurationProperti...

ApplicationGatewayPrivateLinkIpConfigurationProperti...

名称 说明 值
角色实体 IP 配置是否为主。 bool
privateIPAddress IP 配置的专用 IP 地址。 字符串
privateIPAllocationMethod 专用 IP 地址分配方法。 “动态”
“Static”
子网 对子网资源的引用。 SubResource

ApplicationGatewayProbe

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的探测的名称。 string
properties 应用程序网关探测的属性。 ApplicationGatewayProbePropertiesFormat

ApplicationGatewayProbePropertiesFormat

名称 说明 值
host 要向其发送探测的主机名。 字符串
interval 探测间隔（以秒为单位）。 这是每两次连续探测之间的时间间隔。 可接受的值为 1 秒到 86400 秒。 int
match 对正常探测响应进行分类的条件。 ApplicationGatewayProbeHealthResponseMatch
minServers 始终标记为正常的最小服务器数。 默认值为 0。 int
path 探测的相对路径。 有效路径从“/”开始。 探测将发送到 {Protocol}：//{host}：{port}{path}。 字符串
pickHostNameFromBackendHttpSettings 是否应从后端 http 设置中选取主机标头。 默认值为 false。 bool
pickHostNameFromBackendSettings 是否应从 Tls 协议的后端设置中选取服务器名称指示。 默认值为 false。 bool
port 将用于探测后端服务器的自定义端口。 有效值范围为 1 到 65535。 如果未设置，将使用 http 设置中的端口。 此属性仅对Standard_v2和WAF_v2有效。 int

约束：
最小值 = 1
最大值 = 65535
protocol 用于探测的协议。 “Http”
“Https”
“Tcp”
“Tls”
timeout 探测超时（以秒为单位）。 如果在此超时期限内未收到有效响应，则标记为失败的探测。 可接受的值为 1 秒到 86400 秒。 int
unhealthyThreshold 探测重试计数。 在连续探测失败计数达到 UnhealthyThreshold 后，后端服务器被标记为关闭。 可接受的值为 1 秒到 20 秒。 int

ApplicationGatewayProbeHealthResponseMatch

名称 说明 值
body 必须包含在运行状况响应中的正文。 默认值为空。 字符串
statusCodes 允许的正常状态代码范围。 正常状态代码的默认范围为 200-399。 string[]

ApplicationGatewayRedirectConfiguration

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的重定向配置的名称。 string
properties 应用程序网关重定向配置的属性。 ApplicationGatewayRedirectConfigurationPropertiesFor...

ApplicationGatewayRedirectConfigurationPropertiesFor...

名称 说明 值
includePath 在重定向的 URL 中包含路径。 bool
includeQueryString 在重定向 URL 中包含查询字符串。 bool
pathRules 指定重定向配置的路径规则。 SubResource[]
redirectType HTTP 重定向类型。 “Found”
“永久”
“Seeother”
“Temporary”
requestRoutingRules 指定重定向配置的请求路由。 SubResource[]
targetListener 对要将请求重定向到的侦听器的引用。 SubResource
targetUrl 将请求重定向到的 URL。 字符串
urlPathMaps 指定默认重定向配置的 URL 路径映射。 SubResource[]

ApplicationGatewayRequestRoutingRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的请求路由规则的名称。 string
properties 应用程序网关请求路由规则的属性。 ApplicationGatewayRequestRoutingRulePropertiesFormat

ApplicationGatewayRequestRoutingRulePropertiesFormat

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
backendHttpSettings 应用程序网关的后端 http 设置资源。 SubResource
httpListener 应用程序网关的 Http 侦听器资源。 SubResource
loadDistributionPolicy 应用程序网关的负载分发策略资源。 SubResource
priority 请求路由规则的优先级。 int

约束：
最小值 = 1
最大值 = 20000
redirectConfiguration 重定向应用程序网关的配置资源。 SubResource
rewriteRuleSet 在应用程序网关的基本规则中重写规则集资源。 SubResource
ruleType 规则类型。 "Basic"
“PathBasedRouting”
urlPathMap 应用程序网关的 URL 路径映射资源。 SubResource

ApplicationGatewayRewriteRuleSet

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的重写规则集的名称。 string
properties 应用程序网关重写规则集的属性。 ApplicationGatewayRewriteRuleSetPropertiesFormat

ApplicationGatewayRewriteRuleSetPropertiesFormat

名称 说明 值
rewriteRules 重写规则集中的规则。 ApplicationGatewayRewriteRule[]

ApplicationGatewayRewriteRule

名称 说明 值
actionSet 要作为重写规则的一部分执行的操作集。 ApplicationGatewayRewriteRuleActionSet
条件 将基于其评估操作集执行的条件。 ApplicationGatewayRewriteRuleCondition[]
name 应用程序网关中唯一的重写规则的名称。 字符串
ruleSequence 重写规则的规则序列，用于确定 RewriteRuleSet 中特定规则的执行顺序。 int

ApplicationGatewayRewriteRuleActionSet

名称 说明 值
requestHeaderConfigurations 操作集中的请求标头操作。 ApplicationGatewayHeaderConfiguration[]
responseHeaderConfigurations 操作集中的响应标头操作。 ApplicationGatewayHeaderConfiguration[]
urlConfiguration 操作集中的 URL 配置操作。 ApplicationGatewayUrlConfiguration

ApplicationGatewayHeaderConfiguration

名称 说明 值
headerName 标头配置的标头名称。 字符串
headerValue 标头配置的标头值。 字符串

ApplicationGatewayUrlConfiguration

名称 说明 值
modifiedPath 用户为 URL 重写提供的 URL 路径。 Null 表示不会更新任何路径。 默认值为 null。 字符串
modifiedQueryString 用户为 URL 重写提供的查询字符串。 Null 表示不会更新任何查询字符串。 默认值为 null。 字符串
重新路由 如果设置为 true，它将使用修改后的路径重新评估基于路径的请求路由规则中提供的 URL 路径映射。 默认值为 false。 bool

ApplicationGatewayRewriteRuleCondition

名称 说明 值
ignoreCase 使用 将此参数设置为真值会强制模式执行区分大小写的比较。 bool
negate 将此值设置为真值将强制检查用户给出的条件的否定。 bool
pattern 计算条件真实性的模式（固定字符串或正则表达式）。 字符串
可变 RewriteRuleCondition 的 condition 参数。 字符串

ApplicationGatewayRoutingRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的路由规则的名称。 string
properties 应用程序网关路由规则的属性。 ApplicationGatewayRoutingRulePropertiesFormat

ApplicationGatewayRoutingRulePropertiesFormat

名称 说明 值
backendAddressPool 应用程序网关的后端地址池资源。 SubResource
backendSettings 应用程序网关的后端设置资源。 SubResource
听众 应用程序网关的侦听器资源。 SubResource
priority 路由规则的优先级。 int (必需)

约束：
最小值 = 1
最大值 = 20000
ruleType 规则类型。 "Basic"
“PathBasedRouting”

ApplicationGatewaySku

名称 说明 值
容量 容量 (应用程序网关的实例计数) 。 int
name 应用程序网关 SKU 的名称。 “Standard_Large”
“Standard_Medium”
“Standard_Small”
“Standard_v2”
“WAF_Large”
“WAF_Medium”
“WAF_v2”
层 应用程序网关的层。 “Standard”
“Standard_v2”
“WAF”
“WAF_v2”

ApplicationGatewaySslCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 SSL 证书的名称。 string
properties 应用程序网关 SSL 证书的属性。 ApplicationGatewaySslCertificatePropertiesFormat

ApplicationGatewaySslCertificatePropertiesFormat

名称 说明 值
data Base-64 编码的 pfx 证书。 仅适用于 PUT 请求。 字符串
keyVaultSecretId (base-64 编码的未加密 pfx 的机密 ID，) 存储在 KeyVault 中的“Secret”或“Certificate”对象。 字符串
password 数据中指定的 pfx 文件的密码。 仅适用于 PUT 请求。 字符串

ApplicationGatewaySslPolicy

名称 说明 值
cipherSuites 要按指定顺序启用到应用程序网关的 Ssl 密码套件。 包含任何一项的字符串数组：
“TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_128_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_128_CBC_SHA256”
“TLS_DHE_DSS_WITH_AES_256_CBC_SHA”
“TLS_DHE_DSS_WITH_AES_256_CBC_SHA256”
“TLS_DHE_RSA_WITH_AES_128_CBC_SHA”
“TLS_DHE_RSA_WITH_AES_128_GCM_SHA256”
“TLS_DHE_RSA_WITH_AES_256_CBC_SHA”
“TLS_DHE_RSA_WITH_AES_256_GCM_SHA384”
“TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA”
“TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256”
“TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256”
“TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA”
“TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384”
“TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384”
“TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA”
“TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256”
“TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256”
“TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA”
“TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384”
“TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384”
“TLS_RSA_WITH_3DES_EDE_CBC_SHA”
“TLS_RSA_WITH_AES_128_CBC_SHA”
“TLS_RSA_WITH_AES_128_CBC_SHA256”
“TLS_RSA_WITH_AES_128_GCM_SHA256”
“TLS_RSA_WITH_AES_256_CBC_SHA”
“TLS_RSA_WITH_AES_256_CBC_SHA256”
“TLS_RSA_WITH_AES_256_GCM_SHA384”
disabledSslProtocols 在应用程序网关上禁用 Ssl 协议。 包含任意项的字符串数组：
“TLSv1_0”
“TLSv1_1”
“TLSv1_2”
“TLSv1_3”
minProtocolVersion 应用程序网关支持的最低 Ssl 协议版本。 “TLSv1_0”
“TLSv1_1”
“TLSv1_2”
“TLSv1_3”
policyName Ssl 预定义策略的名称。 “AppGwSslPolicy20150501”
“AppGwSslPolicy20170401”
“AppGwSslPolicy20170401S”
“AppGwSslPolicy20220101”
“AppGwSslPolicy20220101S”
policyType Ssl 策略的类型。 “Custom”
“CustomV2”
“预定义”

ApplicationGatewaySslProfile

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 SSL 配置文件的名称。 string
properties 应用程序网关 SSL 配置文件的属性。 ApplicationGatewaySslProfilePropertiesFormat

ApplicationGatewaySslProfilePropertiesFormat

名称 说明 值
clientAuthConfiguration 应用程序网关资源的客户端身份验证配置。 ApplicationGatewayClientAuthConfiguration
sslPolicy 应用程序网关资源的 SSL 策略。 ApplicationGatewaySslPolicy
trustedClientCertificates 对应用程序网关受信任客户端证书的引用数组。 SubResource[]

ApplicationGatewayClientAuthConfiguration

名称 说明 值
verifyClientCertIssuerDN 验证应用程序网关上的客户端证书颁发者名称。 bool
verifyClientRevocation 验证客户端证书吊销状态。 "None"
“OCSP”

ApplicationGatewayTrustedClientCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的受信任客户端证书的名称。 string
properties 应用程序网关受信任的客户端证书的属性。 ApplicationGatewayTrustedClientCertificateProperties...

ApplicationGatewayTrustedClientCertificateProperties...

名称 说明 值
data 证书公共数据。 字符串

ApplicationGatewayTrustedRootCertificate

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的受信任根证书的名称。 string
properties 应用程序网关受信任的根证书的属性。 ApplicationGatewayTrustedRootCertificatePropertiesFo...

ApplicationGatewayTrustedRootCertificatePropertiesFo...

名称 说明 值
data 证书公共数据。 字符串
keyVaultSecretId (base-64 编码的未加密 pfx 的机密 ID，) 存储在 KeyVault 中的“Secret”或“Certificate”对象。 字符串

ApplicationGatewayUrlPathMap

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的 URL 路径映射的名称。 string
properties 应用程序网关 URL 路径映射的属性。 ApplicationGatewayUrlPathMapPropertiesFormat

ApplicationGatewayUrlPathMapPropertiesFormat

名称 说明 值
defaultBackendAddressPool URL 路径映射的默认后端地址池资源。 SubResource
defaultBackendHttpSettings URL 路径映射的默认后端 http 设置资源。 SubResource
defaultLoadDistributionPolicy URL 路径映射的默认负载分布策略资源。 SubResource
defaultRedirectConfiguration URL 路径映射的默认重定向配置资源。 SubResource
defaultRewriteRuleSet URL 路径映射的默认重写规则集资源。 SubResource
pathRules URL 路径映射资源的路径规则。 ApplicationGatewayPathRule[]

ApplicationGatewayPathRule

名称 说明 Value
id 资源 ID。 字符串
name 应用程序网关中唯一的路径规则的名称。 string
properties 应用程序网关路径规则的属性。 ApplicationGatewayPathRulePropertiesFormat

ApplicationGatewayPathRulePropertiesFormat

名称 说明 值
backendAddressPool URL 路径映射路径规则的后端地址池资源。 SubResource
backendHttpSettings URL 路径映射路径规则的后端 http 设置资源。 SubResource
firewallPolicy 对 FirewallPolicy 资源的引用。 SubResource
loadDistributionPolicy URL 路径映射路径规则的加载分发策略资源。 SubResource
路径 URL 路径映射的路径规则。 string[]
redirectConfiguration 重定向 URL 路径映射路径规则的配置资源。 SubResource
rewriteRuleSet 重写 URL 路径映射路径规则的规则集资源。 SubResource

ApplicationGatewayWebApplicationFirewallConfiguratio...

名称 说明 值
disabledRuleGroups 禁用的规则组。 ApplicationGatewayFirewallDisabledRuleGroup[]
enabled 是否启用 Web 应用程序防火墙。 需要 bool ()
排除 排除列表。 ApplicationGatewayFirewallExclusion[]
fileUploadLimitInMb WAF 的最大文件上传大小（以 Mb 为单位）。 int

约束：
最小值 = 0
firewallMode Web 应用程序防火墙模式。 “检测”
需要“预防” ()
maxRequestBodySize WAF 的最大请求正文大小。 int

约束：
最小值 = 8
最大值 = 128
maxRequestBodySizeInKb WAF 的最大请求正文大小（以 Kb 为单位）。 int

约束：
最小值 = 8
最大值 = 128
requestBodyCheck 是否允许 WAF 检查请求正文。 bool
ruleSetType Web 应用程序防火墙规则集的类型。 可能的值为：“OWASP”。 字符串 (必需)
ruleSetVersion 规则集类型的版本。 字符串 (必需)

ApplicationGatewayFirewallDisabledRuleGroup

名称 说明 值
ruleGroupName 将禁用的规则组的名称。 字符串 (必需)
规则 将禁用的规则列表。 如果为 null，则将禁用规则组的所有规则。 int[]

ApplicationGatewayFirewallExclusion

名称 说明 值
matchVariable 要排除的变量。 字符串 (必需)
选择器 当 matchVariable 是集合时，运算符用于指定此排除项应用于集合中的哪些元素。 字符串 (必需)
selectorMatchOperator 当 matchVariable 是集合时，对选择器执行操作以指定此排除项应用于集合中的哪些元素。 字符串 (必需)