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

Application Gateways - Create Or Update

创建或更新指定的应用程序网关。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}?api-version=2022-01-01

URI 参数

Name In Required Type Description
applicationGatewayName
path True
  • string

应用程序网关的名称。

resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

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

api-version
query True
  • string

客户端 API 版本。

请求正文

Name Type Description
id
  • string

资源 ID。

identity

如果已配置,则应用程序网关的标识。

location
  • string

资源位置。

properties.authenticationCertificates

应用程序网关资源的身份验证证书。 有关默认限制,请参阅应用程序网关限制

properties.autoscaleConfiguration

自动缩放配置。

properties.backendAddressPools

应用程序网关资源的后端地址池。 有关默认限制,请参阅应用程序网关限制

properties.backendHttpSettingsCollection

应用程序网关资源的后端 http 设置。 有关默认限制,请参阅应用程序网关限制

properties.backendSettingsCollection

应用程序网关资源的后端设置。 有关默认限制,请参阅应用程序网关限制

properties.customErrorConfigurations

应用程序网关资源的自定义错误配置。

properties.enableFips
  • boolean

是否在应用程序网关资源上启用 FIPS。

properties.enableHttp2
  • boolean

是否在应用程序网关资源上启用 HTTP2。

properties.firewallPolicy

对 FirewallPolicy 资源的引用。

properties.forceFirewallPolicyAssociation
  • boolean

如果为 true,则无论策略与 WAF 配置是否不同,都会将防火墙策略与应用程序网关相关联。

properties.frontendIPConfigurations

应用程序网关资源的前端 IP 地址。 有关默认限制,请参阅应用程序网关限制

properties.frontendPorts

应用程序网关资源的前端端口。 有关默认限制,请参阅应用程序网关限制

properties.gatewayIPConfigurations

应用程序网关资源的子网。 有关默认限制,请参阅应用程序网关限制

properties.globalConfiguration

全局配置。

properties.httpListeners

应用程序网关资源的 Http 侦听器。 有关默认限制,请参阅应用程序网关限制

properties.listeners

应用程序网关资源的侦听器。 有关默认限制,请参阅应用程序网关限制

properties.loadDistributionPolicies

加载应用程序网关资源的分发策略。

properties.privateLinkConfigurations

应用程序网关上的 PrivateLink 配置。

properties.probes

应用程序网关资源的探测。

properties.redirectConfigurations

重定向应用程序网关资源的配置。 有关默认限制,请参阅应用程序网关限制

properties.requestRoutingRules

请求应用程序网关资源的路由规则。

properties.rewriteRuleSets

重写应用程序网关资源的规则。

properties.routingRules

应用程序网关资源的路由规则。

properties.sku

应用程序网关资源的 SKU。

properties.sslCertificates

应用程序网关资源的 SSL 证书。 有关默认限制,请参阅应用程序网关限制

properties.sslPolicy

应用程序网关资源的 SSL 策略。

properties.sslProfiles

应用程序网关资源的 SSL 配置文件。 有关默认限制,请参阅应用程序网关限制

properties.trustedClientCertificates

应用程序网关资源的受信任客户端证书。 有关默认限制,请参阅应用程序网关限制

properties.trustedRootCertificates

应用程序网关资源的受信任根证书。 有关默认限制,请参阅应用程序网关限制

properties.urlPathMaps

应用程序网关资源的 URL 路径映射。 有关默认限制,请参阅应用程序网关限制

properties.webApplicationFirewallConfiguration

Web 应用程序防火墙配置。

tags
  • object

资源标记。

zones
  • string[]

表示资源需要从何处获取的可用性区域的列表。

响应

Name Type Description
200 OK

更新成功。 该操作返回生成的 ApplicationGateway 资源。

201 Created

创建成功。 该操作返回生成的 ApplicationGateway 资源。

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Create Application Gateway

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw?api-version=2022-01-01

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
    }
  },
  "location": "eastus",
  "properties": {
    "sku": {
      "name": "Standard_v2",
      "tier": "Standard_v2",
      "capacity": 3
    },
    "gatewayIPConfigurations": [
      {
        "name": "appgwipc",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet"
          }
        }
      }
    ],
    "sslCertificates": [
      {
        "name": "sslcert",
        "properties": {
          "data": "****",
          "password": "****"
        }
      },
      {
        "name": "sslcert2",
        "properties": {
          "keyVaultSecretId": "https://kv/secret"
        }
      }
    ],
    "trustedRootCertificates": [
      {
        "name": "rootcert",
        "properties": {
          "data": "****"
        }
      },
      {
        "name": "rootcert1",
        "properties": {
          "keyVaultSecretId": "https://kv/secret"
        }
      }
    ],
    "trustedClientCertificates": [
      {
        "name": "clientcert",
        "properties": {
          "data": "****"
        }
      }
    ],
    "frontendIPConfigurations": [
      {
        "name": "appgwfip",
        "properties": {
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"
          }
        }
      }
    ],
    "frontendPorts": [
      {
        "name": "appgwfp",
        "properties": {
          "port": 443
        }
      },
      {
        "name": "appgwfp80",
        "properties": {
          "port": 80
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "appgwpool",
        "properties": {
          "backendAddresses": [
            {
              "ipAddress": "10.0.1.1"
            },
            {
              "ipAddress": "10.0.1.2"
            }
          ]
        }
      },
      {
        "name": "appgwpool1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1",
        "properties": {
          "backendAddresses": [
            "10.0.0.1",
            "10.0.0.2"
          ]
        }
      }
    ],
    "backendHttpSettingsCollection": [
      {
        "name": "appgwbhs",
        "properties": {
          "port": 80,
          "protocol": "Http",
          "cookieBasedAffinity": "Disabled",
          "requestTimeout": 30
        }
      }
    ],
    "sslProfiles": [
      {
        "name": "sslProfile1",
        "properties": {
          "sslPolicy": {
            "policyType": "Custom",
            "minProtocolVersion": "TLSv1_1",
            "cipherSuites": [
              "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
            ]
          },
          "clientAuthConfiguration": {
            "verifyClientCertIssuerDN": true
          },
          "trustedClientCertificates": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert"
            }
          ]
        }
      }
    ],
    "httpListeners": [
      {
        "name": "appgwhl",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"
          },
          "protocol": "Https",
          "sslCertificate": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"
          },
          "sslProfile": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1"
          },
          "requireServerNameIndication": false
        }
      },
      {
        "name": "appgwhttplistener",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"
          },
          "protocol": "Http"
        }
      }
    ],
    "urlPathMaps": [
      {
        "name": "pathMap1",
        "properties": {
          "defaultBackendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "defaultBackendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "defaultRewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "defaultLoadDistributionPolicy": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
          },
          "pathRules": [
            {
              "name": "apiPaths",
              "properties": {
                "paths": [
                  "/api",
                  "/v1/api"
                ],
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                },
                "backendHttpSettings": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
                },
                "rewriteRuleSet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
                },
                "loadDistributionPolicy": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
                }
              }
            }
          ]
        }
      }
    ],
    "requestRoutingRules": [
      {
        "name": "appgwrule",
        "properties": {
          "ruleType": "Basic",
          "priority": 10,
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"
          },
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "rewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "loadDistributionPolicy": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
          }
        }
      },
      {
        "name": "appgwPathBasedRule",
        "properties": {
          "ruleType": "PathBasedRouting",
          "priority": 20,
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"
          },
          "urlPathMap": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"
          }
        }
      }
    ],
    "rewriteRuleSets": [
      {
        "name": "rewriteRuleSet1",
        "properties": {
          "rewriteRules": [
            {
              "name": "Set X-Forwarded-For",
              "ruleSequence": 102,
              "conditions": [
                {
                  "variable": "http_req_Authorization",
                  "pattern": "^Bearer",
                  "ignoreCase": true,
                  "negate": false
                }
              ],
              "actionSet": {
                "requestHeaderConfigurations": [
                  {
                    "headerName": "X-Forwarded-For",
                    "headerValue": "{var_add_x_forwarded_for_proxy}"
                  }
                ],
                "responseHeaderConfigurations": [
                  {
                    "headerName": "Strict-Transport-Security",
                    "headerValue": "max-age=31536000"
                  }
                ],
                "urlConfiguration": {
                  "modifiedPath": "/abc"
                }
              }
            }
          ]
        }
      }
    ],
    "loadDistributionPolicies": [
      {
        "name": "ldp1",
        "properties": {
          "loadDistributionAlgorithm": "RoundRobin",
          "loadDistributionTargets": [
            {
              "name": "ld11",
              "properties": {
                "weightPerServer": 40,
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                }
              }
            },
            {
              "name": "ld11",
              "properties": {
                "weightPerServer": 60,
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"
                }
              }
            }
          ]
        }
      }
    ],
    "globalConfiguration": {
      "enableRequestBuffering": true,
      "enableResponseBuffering": true
    }
  }
}

Sample Response

{
  "name": "appgw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw",
  "type": "Microsoft.Network/applicationGateways",
  "location": "southcentralus",
  "properties": {
    "provisioningState": "Succeeded",
    "sku": {
      "name": "Standard_Medium",
      "tier": "Standard",
      "capacity": 3
    },
    "operationalState": "Running",
    "gatewayIPConfigurations": [
      {
        "name": "appgwipc",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc",
        "properties": {
          "provisioningState": "Succeeded",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"
          }
        }
      }
    ],
    "sslCertificates": [
      {
        "name": "sslcert",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert",
        "properties": {
          "provisioningState": "Succeeded",
          "publicCertData": "*****"
        }
      }
    ],
    "trustedClientCertificates": [
      {
        "name": "clientcert",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert",
        "properties": {
          "provisioningState": "Succeeded",
          "data": "****"
        }
      }
    ],
    "authenticationCertificates": [],
    "frontendIPConfigurations": [
      {
        "name": "appgwfip",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"
          }
        }
      }
    ],
    "frontendPorts": [
      {
        "name": "appgwfp",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 443
        }
      },
      {
        "name": "appgwfp80",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "appgwpool",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool",
        "properties": {
          "provisioningState": "Succeeded",
          "backendAddresses": []
        }
      },
      {
        "name": "appgwpool1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1",
        "properties": {
          "provisioningState": "Succeeded",
          "backendAddresses": [
            "10.0.0.1",
            "10.0.0.2"
          ]
        }
      }
    ],
    "backendHttpSettingsCollection": [
      {
        "name": "appgwbhs",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80,
          "protocol": "Http",
          "cookieBasedAffinity": "Disabled",
          "requestTimeout": 30
        }
      }
    ],
    "sslProfiles": [
      {
        "name": "sslProfile1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1",
        "properties": {
          "provisioningState": "Succeeded",
          "sslPolicy": {
            "policyType": "Custom",
            "minProtocolVersion": "TLSv1_1",
            "cipherSuites": [
              "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
            ]
          },
          "clientAuthConfiguration": {
            "verifyClientCertIssuerDN": true
          },
          "trustedClientCertificates": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert"
            }
          ]
        }
      }
    ],
    "httpListeners": [
      {
        "name": "appgwhl",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"
          },
          "protocol": "Https",
          "sslCertificate": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"
          },
          "sslProfile": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1"
          },
          "requireServerNameIndication": false
        }
      },
      {
        "name": "appgwhttplistener",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"
          },
          "protocol": "Http"
        }
      }
    ],
    "urlPathMaps": [
      {
        "name": "pathMap1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1",
        "properties": {
          "provisioningState": "Succeeded",
          "defaultBackendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "defaultBackendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "defaultRewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "defaultLoadDistributionPolicy": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
          },
          "pathRules": [
            {
              "name": "apiPaths",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths",
              "properties": {
                "provisioningState": "Succeeded",
                "paths": [
                  "/api",
                  "/v1/api"
                ],
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                },
                "backendHttpSettings": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
                },
                "rewriteRuleSet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
                },
                "loadDistributionPolicy": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
                }
              }
            }
          ]
        }
      }
    ],
    "requestRoutingRules": [
      {
        "name": "appgwrule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "Basic",
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"
          },
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "rewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "loadDistributionPolicy": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
          }
        }
      },
      {
        "name": "appgwPathBasedRule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "PathBasedRouting",
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"
          },
          "urlPathMap": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"
          }
        }
      }
    ],
    "rewriteRuleSets": [
      {
        "name": "rewriteRuleSet1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1",
        "properties": {
          "provisioningState": "Succeeded",
          "rewriteRules": [
            {
              "name": "Set X-Forwarded-For",
              "ruleSequence": 102,
              "conditions": [
                {
                  "variable": "http_req_Authorization",
                  "pattern": "^Bearer",
                  "ignoreCase": true,
                  "negate": false
                }
              ],
              "actionSet": {
                "requestHeaderConfigurations": [
                  {
                    "headerName": "X-Forwarded-For",
                    "headerValue": "{var_remote-addr}"
                  }
                ],
                "responseHeaderConfigurations": [
                  {
                    "headerName": "Strict-Transport-Security",
                    "headerValue": "max-age=31536000"
                  }
                ],
                "urlConfiguration": {
                  "modifiedPath": "/abc",
                  "reroute": true
                }
              }
            }
          ]
        }
      }
    ],
    "probes": [],
    "loadDistributionPolicies": [
      {
        "name": "ldp1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1",
        "properties": {
          "loadDistributionAlgorithm": "RoundRobin",
          "loadDistributionTargets": [
            {
              "name": "ld11",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1",
              "properties": {
                "weightPerServer": 40,
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                }
              }
            },
            {
              "name": "ld11",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1",
              "properties": {
                "weightPerServer": 60,
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"
                }
              }
            }
          ]
        }
      }
    ],
    "globalConfiguration": {
      "enableRequestBuffering": true,
      "enableResponseBuffering": true
    }
  }
}
{
  "name": "appgw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw",
  "type": "Microsoft.Network/applicationGateways",
  "location": "southcentralus",
  "properties": {
    "provisioningState": "Succeeded",
    "sku": {
      "name": "Standard_Medium",
      "tier": "Standard",
      "capacity": 3
    },
    "operationalState": "Running",
    "gatewayIPConfigurations": [
      {
        "name": "appgwipc",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc",
        "properties": {
          "provisioningState": "Succeeded",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"
          }
        }
      }
    ],
    "sslCertificates": [
      {
        "name": "sslcert",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert",
        "properties": {
          "provisioningState": "Succeeded",
          "publicCertData": "*****"
        }
      }
    ],
    "trustedClientCertificates": [
      {
        "name": "clientcert",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert",
        "properties": {
          "provisioningState": "Succeeded",
          "data": "****"
        }
      }
    ],
    "authenticationCertificates": [],
    "frontendIPConfigurations": [
      {
        "name": "appgwfip",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"
          },
          "privateLinkConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLinkConfig1"
          }
        }
      }
    ],
    "frontendPorts": [
      {
        "name": "appgwfp",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 443
        }
      },
      {
        "name": "appgwfp80",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "appgwpool",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool",
        "properties": {
          "provisioningState": "Succeeded",
          "backendAddresses": []
        }
      },
      {
        "name": "appgwpool1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1",
        "properties": {
          "provisioningState": "Succeeded",
          "backendAddresses": [
            "10.0.0.1",
            "10.0.0.2"
          ]
        }
      }
    ],
    "backendHttpSettingsCollection": [
      {
        "name": "appgwbhs",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80,
          "protocol": "Http",
          "cookieBasedAffinity": "Disabled",
          "requestTimeout": 30
        }
      }
    ],
    "sslProfiles": [
      {
        "name": "sslProfile1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1",
        "properties": {
          "provisioningState": "Succeeded",
          "sslPolicy": {
            "policyType": "Custom",
            "minProtocolVersion": "TLSv1_1",
            "cipherSuites": [
              "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
            ]
          },
          "clientAuthConfiguration": {
            "verifyClientCertIssuerDN": true
          },
          "trustedClientCertificates": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert"
            }
          ]
        }
      }
    ],
    "httpListeners": [
      {
        "name": "appgwhl",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"
          },
          "protocol": "Https",
          "sslCertificate": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"
          },
          "sslProfile": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1"
          },
          "requireServerNameIndication": false
        }
      },
      {
        "name": "appgwhttplistener",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"
          },
          "protocol": "Http"
        }
      }
    ],
    "urlPathMaps": [
      {
        "name": "pathMap1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1",
        "properties": {
          "provisioningState": "Succeeded",
          "defaultBackendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "defaultBackendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "defaultRewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "defaultLoadDistributionPolicy": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
          },
          "pathRules": [
            {
              "name": "apiPaths",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths",
              "properties": {
                "provisioningState": "Succeeded",
                "paths": [
                  "/api",
                  "/v1/api"
                ],
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                },
                "backendHttpSettings": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
                },
                "rewriteRuleSet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
                },
                "loadDistributionPolicy": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
                }
              }
            }
          ]
        }
      }
    ],
    "requestRoutingRules": [
      {
        "name": "appgwrule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "Basic",
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"
          },
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "rewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "loadDistributionPolicy": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1"
          }
        }
      },
      {
        "name": "appgwPathBasedRule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "PathBasedRouting",
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"
          },
          "urlPathMap": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"
          }
        }
      }
    ],
    "rewriteRuleSets": [
      {
        "name": "rewriteRuleSet1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1",
        "properties": {
          "provisioningState": "Succeeded",
          "rewriteRules": [
            {
              "name": "Set X-Forwarded-For",
              "ruleSequence": 102,
              "conditions": [
                {
                  "variable": "http_req_Authorization",
                  "pattern": "^Bearer",
                  "ignoreCase": true,
                  "negate": false
                }
              ],
              "actionSet": {
                "requestHeaderConfigurations": [
                  {
                    "headerName": "X-Forwarded-For",
                    "headerValue": "{var_remote-addr}"
                  }
                ],
                "responseHeaderConfigurations": [
                  {
                    "headerName": "Strict-Transport-Security",
                    "headerValue": "max-age=31536000"
                  }
                ],
                "urlConfiguration": {
                  "modifiedPath": "/abc",
                  "modifiedQueryString": "x=y&a=b"
                }
              }
            }
          ]
        }
      }
    ],
    "probes": [],
    "loadDistributionPolicies": [
      {
        "name": "ldp1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1",
        "properties": {
          "loadDistributionAlgorithm": "RoundRobin",
          "loadDistributionTargets": [
            {
              "name": "ld11",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1",
              "properties": {
                "weightPerServer": 40,
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                }
              }
            },
            {
              "name": "ld11",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1",
              "properties": {
                "weightPerServer": 60,
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"
                }
              }
            }
          ]
        }
      }
    ],
    "globalConfiguration": {
      "enableRequestBuffering": true,
      "enableResponseBuffering": true
    }
  }
}

定义

ApplicationGateway

应用程序网关资源。

ApplicationGatewayAuthenticationCertificate

应用程序网关的身份验证证书。

ApplicationGatewayAutoscaleConfiguration

应用程序网关自动缩放配置。

ApplicationGatewayBackendAddress

应用程序网关的后端地址。

ApplicationGatewayBackendAddressPool

应用程序网关的后端地址池。

ApplicationGatewayBackendHttpSettings

应用程序网关的后端地址池设置。

ApplicationGatewayBackendSettings

应用程序网关的后端地址池设置。

ApplicationGatewayClientAuthConfiguration

应用程序网关客户端身份验证配置。

ApplicationGatewayConnectionDraining

连接清空允许在从配置中删除后端服务器后,在指定时间内激活与后端服务器的打开连接。

ApplicationGatewayCookieBasedAffinity

基于 Cookie 的相关性。

ApplicationGatewayCustomError

应用程序网关的客户错误。

ApplicationGatewayCustomErrorStatusCode

应用程序网关客户错误的状态代码。

ApplicationGatewayFirewallDisabledRuleGroup

允许禁用规则组或整个规则组中的规则。

ApplicationGatewayFirewallExclusion

允许排除满足 WAF 检查条件的某些变量。

ApplicationGatewayFirewallMode

Web 应用程序防火墙模式。

ApplicationGatewayFrontendIPConfiguration

应用程序网关的前端 IP 配置。

ApplicationGatewayFrontendPort

应用程序网关的前端端口。

ApplicationGatewayGlobalConfiguration

应用程序网关全局配置。

ApplicationGatewayHeaderConfiguration

应用程序网关 中设置的 Actions 的标头配置。

ApplicationGatewayHttpListener

应用程序网关的 Http 侦听器。

ApplicationGatewayIPConfiguration

应用程序网关的 IP 配置。 目前允许 1 个公共 IP 和 1 个专用 IP 配置。

ApplicationGatewayListener

应用程序网关的侦听器。

ApplicationGatewayLoadDistributionAlgorithm

负载分发目标应用程序网关的资源。

ApplicationGatewayLoadDistributionPolicy

应用程序网关的负载分发策略。

ApplicationGatewayLoadDistributionTarget

应用程序网关的负载分发目标。

ApplicationGatewayOperationalState

应用程序网关资源的运行状态。

ApplicationGatewayPathRule

应用程序网关的 URL 路径映射的路径规则。

ApplicationGatewayPrivateEndpointConnection

应用程序网关上的专用终结点连接。

ApplicationGatewayPrivateLinkConfiguration

在应用程序网关上专用链接配置。

ApplicationGatewayPrivateLinkIpConfiguration

应用程序网关专用链接 IP 配置。

ApplicationGatewayProbe

应用程序网关的探测。

ApplicationGatewayProbeHealthResponseMatch

应用程序网关探测运行状况响应匹配。

ApplicationGatewayProtocol

应用程序网关协议。

ApplicationGatewayRedirectConfiguration

重定向应用程序网关的配置。

ApplicationGatewayRedirectType

HTTP 重定向类型。

ApplicationGatewayRequestRoutingRule

应用程序网关的请求路由规则。

ApplicationGatewayRequestRoutingRuleType

规则类型。

ApplicationGatewayRewriteRule

重写应用程序网关的规则。

ApplicationGatewayRewriteRuleActionSet

应用程序网关重写规则中的操作集。

ApplicationGatewayRewriteRuleCondition

应用程序网关重写规则中的一组条件。

ApplicationGatewayRewriteRuleSet

重写应用程序网关的规则集。

ApplicationGatewayRoutingRule

应用程序网关的路由规则。

ApplicationGatewaySku

应用程序网关的 SKU。

ApplicationGatewaySkuName

应用程序网关 SKU 的名称。

ApplicationGatewaySslCertificate

应用程序网关的 SSL 证书。

ApplicationGatewaySslPolicy

应用程序网关 Ssl 策略。

ApplicationGatewaySslPolicyName

Ssl 预定义策略的名称。

ApplicationGatewaySslPolicyType

Ssl 策略的类型。

ApplicationGatewaySslProfile

应用程序网关的 SSL 配置文件。

ApplicationGatewaySslProtocol

应用程序网关支持的最低 SSL 协议版本。

ApplicationGatewayTier

应用程序网关的层。

ApplicationGatewayTrustedClientCertificate

应用程序网关的受信任客户端证书。

ApplicationGatewayTrustedRootCertificate

应用程序网关的受信任根证书。

ApplicationGatewayUrlConfiguration

应用程序网关中设置的操作的 URL 配置。

ApplicationGatewayUrlPathMap

UrlPathMaps 为 PathBasedRouting 提供后端映射信息的 URL 路径。

ApplicationGatewayWebApplicationFirewallConfiguration

应用程序网关 Web 应用程序防火墙配置。

ApplicationSecurityGroup

资源组中的应用程序安全组。

AutoApproval

专用链接服务的自动审批列表。

BackendAddressPool

后端 IP 地址池。

CloudError

服务的错误响应。

CloudErrorBody

服务的错误响应。

CustomDnsConfigPropertiesFormat

包含来自客户的自定义 Dns 解析配置。

DdosSettings

包含公共 IP 的 DDoS 保护设置。

DdosSettingsProtectionCoverage

公共 IP 的 DDoS 保护策略可自定义性。 只有标准覆盖范围才能进行自定义。

Delegation

详细说明子网委派到的服务。

DeleteOptions

指定删除 VM 时公共 IP 地址会发生什么情况

ExtendedLocation

ExtendedLocation 复杂类型。

ExtendedLocationTypes

扩展位置的类型。

FlowLog

流日志资源。

FlowLogFormatParameters

定义流日志格式的参数。

FlowLogFormatType

流日志的文件类型。

FrontendIPConfiguration

负载均衡器的前端 IP 地址。

GatewayLoadBalancerTunnelInterface

负载均衡器后端地址池的网关负载均衡器隧道接口。

GatewayLoadBalancerTunnelInterfaceType

网关负载均衡器隧道接口的流量类型。

GatewayLoadBalancerTunnelProtocol

网关负载均衡器隧道接口的协议。

InboundNatRule

负载均衡器的入站 NAT 规则。

IPAllocationMethod

IP 地址分配方法。

IPConfiguration

IP 配置。

IPConfigurationProfile

IP 配置文件子资源。

IpTag

包含与对象关联的 IpTag。

IPVersion

IP 地址版本。

LoadBalancerBackendAddress

负载均衡器后端地址。

LoadBalancerBackendAddressAdminState

一个管理状态列表,一旦设置可以替代运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。

ManagedServiceIdentity

资源的标识。

NatGateway

Nat 网关资源。

NatGatewaySku

NAT 网关的 SKU。

NatGatewaySkuName

Nat 网关 SKU 的名称。

NatRulePortMapping

为后端池创建的入站 NAT 规则的单个端口映射。

NetworkInterface

资源组中的网络接口。

NetworkInterfaceAuxiliaryMode

网络接口资源的辅助模式。

NetworkInterfaceDnsSettings

网络接口的 DNS 设置。

NetworkInterfaceIPConfiguration

网络接口中的 IPConfiguration。

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

网络接口的 PrivateLinkConnection 属性。

NetworkInterfaceMigrationPhase

网络接口资源的迁移阶段。

NetworkInterfaceNicType

网络接口资源的类型。

NetworkInterfaceTapConfiguration

点击网络接口中的配置。

NetworkSecurityGroup

NetworkSecurityGroup 资源。

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

PrivateEndpointConnection 资源。

PrivateEndpointIPConfiguration

专用终结点的 IP 配置。

PrivateLinkService

专用链接服务资源。

PrivateLinkServiceConnection

PrivateLinkServiceConnection 资源。

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

PrivateLinkServiceIpConfiguration

专用链接服务 IP 配置。

ProvisioningState

当前预配状态。

PublicIPAddress

公共 IP 地址资源。

PublicIPAddressDnsSettings

包含与公共 IP 地址关联的 DNS 记录的 FQDN。

PublicIPAddressMigrationPhase

公共 IP 地址的迁移阶段。

PublicIPAddressSku

公共 IP 地址的 SKU。

PublicIPAddressSkuName

公共 IP 地址 SKU 的名称。

PublicIPAddressSkuTier

公共 IP 地址 SKU 的层。

ResourceIdentityType

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

ResourceNavigationLink

ResourceNavigationLink 资源。

RetentionPolicyParameters

定义流日志保留策略的参数。

Route

路由资源。

RouteNextHopType

数据包应发送到的 Azure 跃点的类型。

RouteTable

路由表资源。

SecurityRule

网络安全规则。

SecurityRuleAccess

是允许还是拒绝网络流量。

SecurityRuleDirection

规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。

SecurityRuleProtocol

此规则应用到的网络协议。

ServiceAssociationLink

ServiceAssociationLink 资源。

ServiceEndpointPolicy

服务终结点策略资源。

ServiceEndpointPolicyDefinition

服务终结点策略定义。

ServiceEndpointPropertiesFormat

服务终结点属性。

Subnet

虚拟网络资源中的子网。

SubResource

对另一个子资源的引用。

TrafficAnalyticsConfigurationProperties

定义流量分析配置的参数。

TrafficAnalyticsProperties

定义流量分析配置的参数。

TransportProtocol

终结点的传输协议。

UserAssignedIdentities

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

VirtualNetworkPrivateEndpointNetworkPolicies

在子网中的专用终结点上启用或禁用应用网络策略。

VirtualNetworkPrivateLinkServiceNetworkPolicies

在子网中的专用链接服务上启用或禁用应用网络策略。

VirtualNetworkTap

虚拟网络点击资源。

Visibility

专用链接服务的可见性列表。

ApplicationGateway

应用程序网关资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

identity

如果已配置,则应用程序网关的标识。

location
  • string

资源位置。

name
  • string

资源名称。

properties.authenticationCertificates

应用程序网关资源的身份验证证书。 有关默认限制,请参阅应用程序网关限制

properties.autoscaleConfiguration

自动缩放配置。

properties.backendAddressPools

应用程序网关资源的后端地址池。 有关默认限制,请参阅应用程序网关限制

properties.backendHttpSettingsCollection

应用程序网关资源的后端 http 设置。 有关默认限制,请参阅应用程序网关限制

properties.backendSettingsCollection

应用程序网关资源的后端设置。 有关默认限制,请参阅应用程序网关限制

properties.customErrorConfigurations

应用程序网关资源的自定义错误配置。

properties.enableFips
  • boolean

是否在应用程序网关资源上启用 FIPS。

properties.enableHttp2
  • boolean

是否在应用程序网关资源上启用 HTTP2。

properties.firewallPolicy

对 FirewallPolicy 资源的引用。

properties.forceFirewallPolicyAssociation
  • boolean

如果为 true,则无论策略与 WAF 配置是否不同,都会将防火墙策略与应用程序网关相关联。

properties.frontendIPConfigurations

应用程序网关资源的前端 IP 地址。 有关默认限制,请参阅应用程序网关限制

properties.frontendPorts

应用程序网关资源的前端端口。 有关默认限制,请参阅应用程序网关限制

properties.gatewayIPConfigurations

应用程序网关资源的子网。 有关默认限制,请参阅应用程序网关限制

properties.globalConfiguration

全局配置。

properties.httpListeners

应用程序网关资源的 Http 侦听器。 有关默认限制,请参阅应用程序网关限制

properties.listeners

应用程序网关资源的侦听器。 有关默认限制,请参阅应用程序网关限制

properties.loadDistributionPolicies

加载应用程序网关资源的分发策略。

properties.operationalState

应用程序网关资源的运行状态。

properties.privateEndpointConnections

应用程序网关上的专用终结点连接。

properties.privateLinkConfigurations

应用程序网关上的 PrivateLink 配置。

properties.probes

应用程序网关资源的探测。

properties.provisioningState

应用程序网关资源的预配状态。

properties.redirectConfigurations

重定向应用程序网关资源的配置。 有关默认限制,请参阅应用程序网关限制

properties.requestRoutingRules

请求应用程序网关资源的路由规则。

properties.resourceGuid
  • string

应用程序网关资源的资源 GUID 属性。

properties.rewriteRuleSets

重写应用程序网关资源的规则。

properties.routingRules

应用程序网关资源的路由规则。

properties.sku

应用程序网关资源的 SKU。

properties.sslCertificates

应用程序网关资源的 SSL 证书。 有关默认限制,请参阅应用程序网关限制

properties.sslPolicy

应用程序网关资源的 SSL 策略。

properties.sslProfiles

应用程序网关资源的 SSL 配置文件。 有关默认限制,请参阅应用程序网关限制

properties.trustedClientCertificates

应用程序网关资源的受信任客户端证书。 有关默认限制,请参阅应用程序网关限制

properties.trustedRootCertificates

应用程序网关资源的受信任根证书。 有关默认限制,请参阅应用程序网关限制

properties.urlPathMaps

应用程序网关资源的 URL 路径映射。 有关默认限制,请参阅应用程序网关限制

properties.webApplicationFirewallConfiguration

Web 应用程序防火墙配置。

tags
  • object

资源标记。

type
  • string

资源类型。

zones
  • string[]

表示资源需要从何处获取的可用性区域的列表。

ApplicationGatewayAuthenticationCertificate

应用程序网关的身份验证证书。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

应用程序网关中唯一的身份验证证书的名称。

properties.data
  • string

证书公共数据。

properties.provisioningState

身份验证证书资源的预配状态。

type
  • string

资源的类型。

ApplicationGatewayAutoscaleConfiguration

应用程序网关自动缩放配置。

Name Type Description
maxCapacity
  • integer

应用程序网关容量数上限。

minCapacity
  • integer

应用程序网关容量数的下限。

ApplicationGatewayBackendAddress

应用程序网关的后端地址。

Name Type Description
fqdn
  • string

完全限定的域名 (FQDN)。

ipAddress
  • string

IP 地址。

ApplicationGatewayBackendAddressPool

应用程序网关的后端地址池。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的后端地址池的名称。

properties.backendAddresses

后端地址。

properties.backendIPConfigurations

对网络接口中定义的 IP 的引用集合。

properties.provisioningState

后端地址池资源的预配状态。

type
  • string

资源的类型。

ApplicationGatewayBackendHttpSettings

应用程序网关的后端地址池设置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的后端 http 设置的名称。

properties.affinityCookieName
  • string

要用于关联 Cookie 的 Cookie 名称。

properties.authenticationCertificates

对应用程序网关身份验证证书的引用数组。

properties.connectionDraining

后端 http 设置资源的连接耗尽。

properties.cookieBasedAffinity

基于 Cookie 的相关性。

properties.hostName
  • string

要发送到后端服务器的主机标头。

properties.path
  • string

应用作所有 HTTP 请求前缀的路径。 Null 表示不会为路径添加前缀。 默认值为 null。

properties.pickHostNameFromBackendAddress
  • boolean

是否应从后端服务器的主机名中选取主机标头。 默认值为 false。

properties.port
  • integer

后端上的目标端口。

properties.probe

探测应用程序网关的资源。

properties.probeEnabled
  • boolean

是否启用探测。 默认值为 false。

properties.protocol

用于与后端通信的协议。

properties.provisioningState

后端 HTTP 设置资源的预配状态。

properties.requestTimeout
  • integer

请求超时(以秒为单位)。 如果在 RequestTimeout 中未收到响应,应用程序网关将失败请求。 可接受的值为 1 秒到 86400 秒。

properties.trustedRootCertificates

对应用程序网关受信任根证书的引用数组。

type
  • string

资源的类型。

ApplicationGatewayBackendSettings

应用程序网关的后端地址池设置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的后端设置的名称。

properties.hostName
  • string

要发送到用于 Tls 协议的后端服务器的服务器名称指示。

properties.pickHostNameFromBackendAddress
  • boolean

是否从 Tls 协议的后端服务器的主机名中选择服务器名称指示。 默认值为 false。

properties.port
  • integer

后端上的目标端口。

properties.probe

探测应用程序网关的资源。

properties.protocol

用于与后端通信的协议。

properties.provisioningState

后端 HTTP 设置资源的预配状态。

properties.timeout
  • integer

连接超时(秒)。 如果 ConnectionTimeout 中未收到响应,应用程序网关将失败请求。 可接受的值为 1 秒到 86400 秒。

properties.trustedRootCertificates

对应用程序网关受信任根证书的引用数组。

type
  • string

资源的类型。

ApplicationGatewayClientAuthConfiguration

应用程序网关客户端身份验证配置。

Name Type Description
verifyClientCertIssuerDN
  • boolean

验证应用程序网关上的客户端证书颁发者名称。

ApplicationGatewayConnectionDraining

连接清空允许在从配置中删除后端服务器后,在指定时间内激活与后端服务器的打开连接。

Name Type Description
drainTimeoutInSec
  • integer

连接清空的秒数处于活动状态。 可接受的值为 1 秒到 3600 秒。

enabled
  • boolean

是否启用连接清空。

ApplicationGatewayCookieBasedAffinity

基于 Cookie 的相关性。

Name Type Description
Disabled
  • string
Enabled
  • string

ApplicationGatewayCustomError

应用程序网关的客户错误。

Name Type Description
customErrorPageUrl
  • string

应用程序网关客户错误的错误页 URL。

statusCode

应用程序网关客户错误的状态代码。

ApplicationGatewayCustomErrorStatusCode

应用程序网关客户错误的状态代码。

Name Type Description
HttpStatus403
  • string
HttpStatus502
  • string

ApplicationGatewayFirewallDisabledRuleGroup

允许禁用规则组或整个规则组中的规则。

Name Type Description
ruleGroupName
  • string

将禁用的规则组的名称。

rules
  • integer[]

将禁用的规则列表。 如果为 null,则将禁用规则组的所有规则。

ApplicationGatewayFirewallExclusion

允许排除满足 WAF 检查条件的某些变量。

Name Type Description
matchVariable
  • string

要排除的变量。

selector
  • string

matchVariable 是集合时,运算符用于指定此排除应用于的集合中的哪些元素。

selectorMatchOperator
  • string

matchVariable 是集合时,对选择器进行操作以指定此排除应用于的集合中的哪些元素。

ApplicationGatewayFirewallMode

Web 应用程序防火墙模式。

Name Type Description
Detection
  • string
Prevention
  • string

ApplicationGatewayFrontendIPConfiguration

应用程序网关的前端 IP 配置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

应用程序网关中唯一的前端 IP 配置的名称。

properties.privateIPAddress
  • string

网络接口 IP 配置的 PrivateIPAddress。

properties.privateIPAllocationMethod

专用 IP 地址分配方法。

properties.privateLinkConfiguration

对应用程序网关专用链接配置的引用。

properties.provisioningState

前端 IP 配置资源的预配状态。

properties.publicIPAddress

对 PublicIP 资源的引用。

properties.subnet

对子网资源的引用。

type
  • string

资源的类型。

ApplicationGatewayFrontendPort

应用程序网关的前端端口。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

应用程序网关中唯一的前端端口的名称。

properties.port
  • integer

前端端口。

properties.provisioningState

前端端口资源的预配状态。

type
  • string

资源的类型。

ApplicationGatewayGlobalConfiguration

应用程序网关全局配置。

Name Type Description
enableRequestBuffering
  • boolean

启用请求缓冲。

enableResponseBuffering
  • boolean

启用响应缓冲。

ApplicationGatewayHeaderConfiguration

应用程序网关 中设置的 Actions 的标头配置。

Name Type Description
headerName
  • string

标头配置的标头名称。

headerValue
  • string

标头配置的标头值。

ApplicationGatewayHttpListener

应用程序网关的 Http 侦听器。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的 HTTP 侦听器的名称。

properties.customErrorConfigurations

HTTP 侦听器的自定义错误配置。

properties.firewallPolicy

对 FirewallPolicy 资源的引用。

properties.frontendIPConfiguration

应用程序网关的前端 IP 配置资源。

properties.frontendPort

应用程序网关的前端端口资源。

properties.hostName
  • string

HTTP 侦听器的主机名。

properties.hostNames
  • string[]

允许特殊通配符的 HTTP 侦听器的主机名列表。

properties.protocol

HTTP 侦听器的协议。

properties.provisioningState

HTTP 侦听器资源的预配状态。

properties.requireServerNameIndication
  • boolean

仅当协议为 https 时适用。 为多托管启用 SNI。

properties.sslCertificate

应用程序网关的 SSL 证书资源。

properties.sslProfile

应用程序网关的 SSL 配置文件资源。

type
  • string

资源的类型。

ApplicationGatewayIPConfiguration

应用程序网关的 IP 配置。 目前允许 1 个公共 IP 和 1 个专用 IP 配置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

应用程序网关中唯一的 IP 配置的名称。

properties.provisioningState

应用程序网关 IP 配置资源的预配状态。

properties.subnet

对子网资源的引用。 应用程序网关从中获取其专用地址的子网。

type
  • string

资源的类型。

ApplicationGatewayListener

应用程序网关的侦听器。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的侦听器的名称。

properties.frontendIPConfiguration

应用程序网关的前端 IP 配置资源。

properties.frontendPort

应用程序网关的前端端口资源。

properties.protocol

侦听器的协议。

properties.provisioningState

侦听器资源的预配状态。

properties.sslCertificate

应用程序网关的 SSL 证书资源。

properties.sslProfile

应用程序网关的 SSL 配置文件资源。

type
  • string

资源的类型。

ApplicationGatewayLoadDistributionAlgorithm

负载分发目标应用程序网关的资源。

Name Type Description
IpHash
  • string
LeastConnections
  • string
RoundRobin
  • string

ApplicationGatewayLoadDistributionPolicy

应用程序网关的负载分发策略。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关内唯一的负载分发策略的名称。

properties.loadDistributionAlgorithm

负载分发目标应用程序网关的资源。

properties.loadDistributionTargets

负载分发目标应用程序网关的资源。

properties.provisioningState

负载分发策略资源的预配状态。

type
  • string

资源的类型。

ApplicationGatewayLoadDistributionTarget

应用程序网关的负载分发目标。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关内唯一的负载分发策略的名称。

properties.backendAddressPool

应用程序网关的后端地址池资源。

properties.weightPerServer
  • integer

每个服务器的权重。 介于 1 和 100 之间。

type
  • string

资源的类型。

ApplicationGatewayOperationalState

应用程序网关资源的运行状态。

Name Type Description
Running
  • string
Starting
  • string
Stopped
  • string
Stopping
  • string

ApplicationGatewayPathRule

应用程序网关的 URL 路径映射的路径规则。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的路径规则的名称。

properties.backendAddressPool

URL 路径映射路径规则的后端地址池资源。

properties.backendHttpSettings

URL 路径映射路径规则的后端 http 设置资源。

properties.firewallPolicy

对 FirewallPolicy 资源的引用。

properties.loadDistributionPolicy

URL 路径映射路径规则的负载分发策略资源。

properties.paths
  • string[]

URL 路径映射的路径规则。

properties.provisioningState

路径规则资源的预配状态。

properties.redirectConfiguration

重定向 URL 路径映射路径规则的配置资源。

properties.rewriteRuleSet

重写 URL 路径映射路径规则的规则集资源。

type
  • string

资源的类型。

ApplicationGatewayPrivateEndpointConnection

应用程序网关上的专用终结点连接。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

应用程序网关上的专用终结点连接的名称。

properties.linkIdentifier
  • string

使用者链接 ID。

properties.privateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

properties.provisioningState

应用程序网关专用终结点连接资源的预配状态。

type
  • string

资源的类型。

ApplicationGatewayPrivateLinkConfiguration

在应用程序网关上专用链接配置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的专用链接配置的名称。

properties.ipConfigurations

应用程序网关专用链接 IP 配置的数组。

properties.provisioningState

应用程序网关专用链接配置的预配状态。

type
  • string

资源的类型。

ApplicationGatewayPrivateLinkIpConfiguration

应用程序网关专用链接 IP 配置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

应用程序网关专用链接 IP 配置的名称。

properties.primary
  • boolean

ip 配置是否为主要配置。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAllocationMethod

专用 IP 地址分配方法。

properties.provisioningState

应用程序网关专用链接 IP 配置的预配状态。

properties.subnet

对子网资源的引用。

type
  • string

资源类型。

ApplicationGatewayProbe

应用程序网关的探测。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的探测的名称。

properties.host
  • string

要向其发送探测的主机名。

properties.interval
  • integer

探测间隔(以秒为单位)。 这是每两次连续探测之间的时间间隔。 可接受的值为 1 秒到 86400 秒。

properties.match

对正常探测响应进行分类的条件。

properties.minServers
  • integer

始终标记为“正常”的最小服务器数。 默认值为 0。

properties.path
  • string

探测的相对路径。 有效路径从“/”开始。 探测发送到 ://:。

properties.pickHostNameFromBackendHttpSettings
  • boolean

是否应从后端 http 设置中选取主机标头。 默认值为 false。

properties.pickHostNameFromBackendSettings
  • boolean

是否应从 Tls 协议的后端设置中选择服务器名称指示。 默认值为 false。

properties.port
  • integer

将用于探测后端服务器的自定义端口。 有效值范围为 1 到 65535。 如果未设置,将使用 http 设置中的端口。 此属性仅适用于Standard_v2和WAF_v2。

properties.protocol

用于探测的协议。

properties.provisioningState

探测资源的预配状态。

properties.timeout
  • integer

探测超时(以秒为单位)。 如果此超时期限未收到有效响应,则标记为失败的探测。 可接受的值为 1 秒到 86400 秒。

properties.unhealthyThreshold
  • integer

探测重试计数。 后端服务器在连续探测失败计数达到 UnhealthyThreshold 后被标记为关闭。 可接受的值为 1 秒到 20。

type
  • string

资源的类型。

ApplicationGatewayProbeHealthResponseMatch

应用程序网关探测运行状况响应匹配。

Name Type Description
body
  • string

运行状况响应中必须包含的正文。 默认值为空。

statusCodes
  • string[]

允许的正常状态代码范围。 正常状态代码的默认范围为 200-399。

ApplicationGatewayProtocol

应用程序网关协议。

Name Type Description
Http
  • string
Https
  • string
Tcp
  • string
Tls
  • string

ApplicationGatewayRedirectConfiguration

重定向应用程序网关的配置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的重定向配置的名称。

properties.includePath
  • boolean

在重定向的 URL 中包含路径。

properties.includeQueryString
  • boolean

在重定向 URL 中包含查询字符串。

properties.pathRules

指定重定向配置的路径规则。

properties.redirectType

HTTP 重定向类型。

properties.requestRoutingRules

指定重定向配置的请求路由。

properties.targetListener

对侦听器的引用,以将请求重定向到该侦听器。

properties.targetUrl
  • string

将请求重定向到的 URL。

properties.urlPathMaps

指定默认重定向配置的 URL 路径映射。

type
  • string

资源的类型。

ApplicationGatewayRedirectType

HTTP 重定向类型。

Name Type Description
Found
  • string
Permanent
  • string
SeeOther
  • string
Temporary
  • string

ApplicationGatewayRequestRoutingRule

应用程序网关的请求路由规则。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的请求路由规则的名称。

properties.backendAddressPool

应用程序网关的后端地址池资源。

properties.backendHttpSettings

应用程序网关的后端 http 设置资源。

properties.httpListener

应用程序网关的 Http 侦听器资源。

properties.loadDistributionPolicy

应用程序网关的负载分发策略资源。

properties.priority
  • integer

请求路由规则的优先级。

properties.provisioningState

请求路由规则资源的预配状态。

properties.redirectConfiguration

重定向应用程序网关的配置资源。

properties.rewriteRuleSet

在应用程序网关的基本规则中重写规则集资源。

properties.ruleType

规则类型。

properties.urlPathMap

应用程序网关的 URL 路径映射资源。

type
  • string

资源的类型。

ApplicationGatewayRequestRoutingRuleType

规则类型。

Name Type Description
Basic
  • string
PathBasedRouting
  • string

ApplicationGatewayRewriteRule

重写应用程序网关的规则。

Name Type Description
actionSet

要作为重写规则的一部分执行的操作集。

conditions

将基于操作集执行进行评估的条件。

name
  • string

在应用程序网关中唯一的重写规则的名称。

ruleSequence
  • integer

重写规则的规则序列,用于确定重写RuleSet 中特定规则的执行顺序。

ApplicationGatewayRewriteRuleActionSet

应用程序网关重写规则中的操作集。

Name Type Description
requestHeaderConfigurations

操作集中的请求标头操作。

responseHeaderConfigurations

操作集中的响应标头操作。

urlConfiguration

操作集中的 URL 配置操作。

ApplicationGatewayRewriteRuleCondition

应用程序网关重写规则中的一组条件。

Name Type Description
ignoreCase
  • boolean

将此参数设置为真实值,强制模式执行区分大小写的比较。

negate
  • boolean

将此值设置为事实将强制检查用户给出的条件的否定。

pattern
  • string

计算条件真实性的固定字符串或正则表达式的模式。

variable
  • string

RewriteRuleCondition 的条件参数。

ApplicationGatewayRewriteRuleSet

重写应用程序网关的规则集。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的重写规则集的名称。

properties.provisioningState

重写规则集资源的预配状态。

properties.rewriteRules

重写规则集中的重写规则。

ApplicationGatewayRoutingRule

应用程序网关的路由规则。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的路由规则的名称。

properties.backendAddressPool

应用程序网关的后端地址池资源。

properties.backendSettings

应用程序网关的后端设置资源。

properties.listener

应用程序网关的侦听器资源。

properties.priority
  • integer

路由规则的优先级。

properties.provisioningState

请求路由规则资源的预配状态。

properties.ruleType

规则类型。

type
  • string

资源的类型。

ApplicationGatewaySku

应用程序网关的 SKU。

Name Type Description
capacity
  • integer

应用程序网关的容量 (实例计数) 。

name

应用程序网关 SKU 的名称。

tier

应用程序网关的层。

ApplicationGatewaySkuName

应用程序网关 SKU 的名称。

Name Type Description
Standard_Large
  • string
Standard_Medium
  • string
Standard_Small
  • string
Standard_v2
  • string
WAF_Large
  • string
WAF_Medium
  • string
WAF_v2
  • string

ApplicationGatewaySslCertificate

应用程序网关的 SSL 证书。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的 SSL 证书的名称。

properties.data
  • string

Base-64 编码的 pfx 证书。 仅适用于 PUT 请求。

properties.keyVaultSecretId
  • string

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

properties.password
  • string

数据中指定的 pfx 文件的密码。 仅适用于 PUT 请求。

properties.provisioningState

SSL 证书资源的预配状态。

properties.publicCertData
  • string

Base-64 编码的公共证书数据对应于数据中指定的 pfx。 仅适用于 GET 请求。

type
  • string

资源的类型。

ApplicationGatewaySslPolicy

应用程序网关 Ssl 策略。

Name Type Description
cipherSuites
  • string[]

要按照应用程序网关的指定顺序启用 Ssl 密码套件。

disabledSslProtocols
  • string[]

在应用程序网关上禁用 Ssl 协议。

minProtocolVersion

应用程序网关支持的最低 Ssl 协议版本。

policyName

Ssl 预定义策略的名称。

policyType

Ssl Policy 的类型。

ApplicationGatewaySslPolicyName

Ssl 预定义策略的名称。

Name Type Description
AppGwSslPolicy20150501
  • string
AppGwSslPolicy20170401
  • string
AppGwSslPolicy20170401S
  • string
AppGwSslPolicy20220101
  • string
AppGwSslPolicy20220101S
  • string

ApplicationGatewaySslPolicyType

Ssl 策略的类型。

Name Type Description
Custom
  • string
CustomV2
  • string
Predefined
  • string

ApplicationGatewaySslProfile

应用程序网关的 SSL 配置文件。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的 SSL 配置文件的名称。

properties.clientAuthConfiguration

应用程序网关资源的客户端身份验证配置。

properties.provisioningState

HTTP 侦听器资源的预配状态。

properties.sslPolicy

应用程序网关资源的 SSL 策略。

properties.trustedClientCertificates

对应用程序网关受信任客户端证书的引用数组。

type
  • string

资源的类型。

ApplicationGatewaySslProtocol

应用程序网关支持的最低 SSL 协议版本。

Name Type Description
TLSv1_0
  • string
TLSv1_1
  • string
TLSv1_2
  • string
TLSv1_3
  • string

ApplicationGatewayTier

应用程序网关的层。

Name Type Description
Standard
  • string
Standard_v2
  • string
WAF
  • string
WAF_v2
  • string

ApplicationGatewayTrustedClientCertificate

应用程序网关的受信任客户端证书。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的受信任客户端证书的名称。

properties.clientCertIssuerDN
  • string

客户端证书颁发者的可分辨名称。

properties.data
  • string

证书公共数据。

properties.provisioningState

受信任的客户端证书资源的预配状态。

properties.validatedCertData
  • string

验证的证书数据。

type
  • string

资源的类型。

ApplicationGatewayTrustedRootCertificate

应用程序网关的受信任根证书。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

应用程序网关中唯一的受信任根证书的名称。

properties.data
  • string

证书公共数据。

properties.keyVaultSecretId
  • string

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

properties.provisioningState

受信任的根证书资源的预配状态。

type
  • string

资源的类型。

ApplicationGatewayUrlConfiguration

应用程序网关中设置的操作的 URL 配置。

Name Type Description
modifiedPath
  • string

用户为 URL 重写提供的 URL 路径。 Null 表示不会更新任何路径。 默认值为 null。

modifiedQueryString
  • string

用户为 URL 重写提供的查询字符串。 Null 表示不会更新任何查询字符串。 默认值为 null。

reroute
  • boolean

如果设置为 true,它将使用修改的路径重新评估基于路径的请求路由规则中提供的 URL 路径映射。 默认值为 false。

ApplicationGatewayUrlPathMap

UrlPathMaps 为 PathBasedRouting 提供后端映射信息的 URL 路径。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

在应用程序网关中唯一的 URL 路径映射的名称。

properties.defaultBackendAddressPool

URL 路径映射的默认后端地址池资源。

properties.defaultBackendHttpSettings

URL 路径映射的默认后端 http 设置资源。

properties.defaultLoadDistributionPolicy

URL 路径映射的默认负载分发策略资源。

properties.defaultRedirectConfiguration

URL 路径映射的默认重定向配置资源。

properties.defaultRewriteRuleSet

URL 路径映射的默认重写规则集资源。

properties.pathRules

URL 路径映射资源的路径规则。

properties.provisioningState

URL 路径映射资源的预配状态。

type
  • string

资源的类型。

ApplicationGatewayWebApplicationFirewallConfiguration

应用程序网关 Web 应用程序防火墙配置。

Name Type Description
disabledRuleGroups

禁用的规则组。

enabled
  • boolean

是否启用 Web 应用程序防火墙。

exclusions

排除列表。

fileUploadLimitInMb
  • integer

WAF 的最大文件上传大小(以 Mb 为单位)。

firewallMode

Web 应用程序防火墙模式。

maxRequestBodySize
  • integer

WAF 的最大请求正文大小。

maxRequestBodySizeInKb
  • integer

WAF 的最大请求正文大小(以 Kb 为单位)。

requestBodyCheck
  • boolean

是否允许 WAF 检查请求正文。

ruleSetType
  • string

Web 应用程序防火墙规则集的类型。 可能的值为:“OWASP”。

ruleSetVersion
  • string

规则集类型的版本。

ApplicationSecurityGroup

资源组中的应用程序安全组。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.provisioningState

应用程序安全组资源的预配状态。

properties.resourceGuid
  • string

应用程序安全组资源的资源 GUID 属性。 它唯一标识资源,即使用户更改其名称或跨订阅或资源组迁移资源。

tags
  • object

资源标记。

type
  • string

资源类型。

AutoApproval

专用链接服务的自动审批列表。

Name Type Description
subscriptions
  • string[]

订阅列表。

BackendAddressPool

后端 IP 地址池。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

负载均衡器使用的后端地址池集中唯一的资源的名称。 此名称可用于访问资源。

properties.backendIPConfigurations

对网络接口中定义的 IP 地址的引用数组。

properties.drainPeriodInSeconds
  • integer

将 RESET 发送到客户端和后端地址之前,负载均衡器等待的秒数。

properties.inboundNatRules

对使用此后端地址池的入站 NAT 规则的引用数组。

properties.loadBalancerBackendAddresses

后端地址数组。

properties.loadBalancingRules

对使用此后端地址池的负载均衡规则的引用数组。

properties.location
  • string

后端地址池的位置。

properties.outboundRule

对使用此后端地址池的出站规则的引用。

properties.outboundRules

对使用此后端地址池的出站规则的引用数组。

properties.provisioningState

后端地址池资源的预配状态。

properties.tunnelInterfaces

网关负载均衡器隧道接口的数组。

type
  • string

资源的类型。

CloudError

服务的错误响应。

Name Type Description
error

云错误正文。

CloudErrorBody

服务的错误响应。

Name Type Description
code
  • string

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

details

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

message
  • string

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

target
  • string

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

CustomDnsConfigPropertiesFormat

包含来自客户的自定义 Dns 解析配置。

Name Type Description
fqdn
  • string

解析为专用终结点 IP 地址的 Fqdn。

ipAddresses
  • string[]

专用终结点的专用 IP 地址列表。

DdosSettings

包含公共 IP 的 DDoS 保护设置。

Name Type Description
ddosCustomPolicy

与公共 IP 关联的 DDoS 自定义策略。

protectedIP
  • boolean

在公共 IP 上启用 DDoS 保护。

protectionCoverage

公共 IP 的 DDoS 保护策略可自定义性。 只有标准覆盖范围才能进行自定义。

DdosSettingsProtectionCoverage

公共 IP 的 DDoS 保护策略可自定义性。 只有标准覆盖范围才能进行自定义。

Name Type Description
Basic
  • string
Standard
  • string

Delegation

详细说明子网委派到的服务。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

子网中唯一的资源的名称。 此名称可用于访问资源。

properties.actions
  • string[]

委派后允许对服务执行的操作。

properties.provisioningState

服务委派资源的预配状态。

properties.serviceName
  • string

应向其委托子网的服务的名称 (,例如 Microsoft.Sql/servers) 。

type
  • string

资源类型。

DeleteOptions

指定删除 VM 时公共 IP 地址会发生什么情况

Name Type Description
Delete
  • string
Detach
  • string

ExtendedLocation

ExtendedLocation 复杂类型。

Name Type Description
name
  • string

扩展位置的名称。

type

扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

Name Type Description
EdgeZone
  • string

FlowLog

流日志资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.enabled
  • boolean

用于启用/禁用流日志记录的标志。

properties.flowAnalyticsConfiguration

定义流量分析配置的参数。

properties.format

定义流日志格式的参数。

properties.provisioningState

流日志的预配状态。

properties.retentionPolicy

定义流日志保留策略的参数。

properties.storageId
  • string

用于存储流日志的存储帐户的 ID。

properties.targetResourceGuid
  • string

将向其应用流日志的网络安全组的 Guid。

properties.targetResourceId
  • string

将向其应用流日志的网络安全组的 ID。

tags
  • object

资源标记。

type
  • string

资源类型。

FlowLogFormatParameters

定义流日志格式的参数。

Name Type Default Value Description
type

流日志的文件类型。

version
  • integer
0

流日志的版本 () 。

FlowLogFormatType

流日志的文件类型。

Name Type Description
JSON
  • string

FrontendIPConfiguration

负载均衡器的前端 IP 地址。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

负载均衡器使用的前端 IP 配置集中唯一的资源的名称。 此名称可用于访问资源。

properties.gatewayLoadBalancer

对网关负载均衡器前端 IP 的引用。

properties.inboundNatPools

对使用此前端 IP 的入站池的引用数组。

properties.inboundNatRules

对使用此前端 IP 的入站规则的引用数组。

properties.loadBalancingRules

对使用此前端 IP 的负载均衡规则的引用数组。

properties.outboundRules

对使用此前端 IP 的出站规则的引用数组。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAddressVersion

特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值被视为 IPv4。

properties.privateIPAllocationMethod

专用 IP 分配方法。

properties.provisioningState

前端 IP 配置资源的预配状态。

properties.publicIPAddress

对公共 IP 资源的引用。

properties.publicIPPrefix

对公共 IP 前缀资源的引用。

properties.subnet

对子网资源的引用。

type
  • string

资源的类型。

zones
  • string[]

表示为资源分配的 IP 需要来自的可用性区域列表。

GatewayLoadBalancerTunnelInterface

负载均衡器后端地址池的网关负载均衡器隧道接口。

Name Type Description
identifier
  • integer

网关负载均衡器隧道接口的标识符。

port
  • integer

网关负载均衡器隧道接口的端口。

protocol

网关负载均衡器隧道接口的协议。

type

网关负载均衡器隧道接口的流量类型。

GatewayLoadBalancerTunnelInterfaceType

网关负载均衡器隧道接口的流量类型。

Name Type Description
External
  • string
Internal
  • string
None
  • string

GatewayLoadBalancerTunnelProtocol

网关负载均衡器隧道接口的协议。

Name Type Description
Native
  • string
None
  • string
VXLAN
  • string

InboundNatRule

负载均衡器的入站 NAT 规则。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

负载均衡器使用的入站 NAT 规则集内唯一的资源的名称。 此名称可用于访问资源。

properties.backendAddressPool

对 backendAddressPool 资源的引用。

properties.backendIPConfiguration

对 VM 网络接口上定义的专用 IP 地址的引用。 发送到每个前端 IP 配置的前端端口的流量将转发到后端 IP。

properties.backendPort
  • integer

用于内部终结点的端口。 可接受的值范围为 1 到 65535。

properties.enableFloatingIP
  • boolean

为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的终结点。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时,需要此设置。 创建终结点后,无法更改此设置。

properties.enableTcpReset
  • boolean

在 TCP 流空闲超时或意外的连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。

properties.frontendIPConfiguration

对前端 IP 地址的引用。

properties.frontendPort
  • integer

外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值范围为 1 到 65534。

properties.frontendPortRangeEnd
  • integer

外部终结点的端口范围结束。 此属性与 BackendAddressPool 和 FrontendPortRangeStart 一起使用。 将为 BackendAddressPool 中的每个后端地址创建单个入站 NAT 规则端口映射。 可接受的值范围为 1 到 65534。

properties.frontendPortRangeStart
  • integer

端口范围从外部终结点开始。 此属性与 BackendAddressPool 和 FrontendPortRangeEnd 一起使用。 将为 BackendAddressPool 中的每个后端地址创建单个入站 NAT 规则端口映射。 可接受的值范围为 1 到 65534。

properties.idleTimeoutInMinutes
  • integer

TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。

properties.protocol

对负载均衡规则使用的传输协议的引用。

properties.provisioningState

入站 NAT 规则资源的预配状态。

type
  • string

资源的类型。

IPAllocationMethod

IP 地址分配方法。

Name Type Description
Dynamic
  • string
Static
  • string

IPConfiguration

IP 配置。

Name Type Default Value Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAllocationMethod Dynamic

专用 IP 地址分配方法。

properties.provisioningState

IP 配置资源的预配状态。

properties.publicIPAddress

对公共 IP 资源的引用。

properties.subnet

对子网资源的引用。

IPConfigurationProfile

IP 配置文件子资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源的名称。 此名称可用于访问资源。

properties.provisioningState

IP 配置文件资源的预配状态。

properties.subnet

用于创建容器网络接口 IP 配置的子网资源的引用。

type
  • string

子资源类型。

IpTag

包含与对象关联的 IpTag。

Name Type Description
ipTagType
  • string

IP 标记类型。 示例:FirstPartyUsage。

tag
  • string

与公共 IP 关联的 IP 标记的值。 示例:SQL。

IPVersion

IP 地址版本。

Name Type Description
IPv4
  • string
IPv6
  • string

LoadBalancerBackendAddress

负载均衡器后端地址。

Name Type Description
name
  • string

后端地址的名称。

properties.adminState

一个管理状态列表,一旦设置可以替代运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。

properties.inboundNatRulesPortMapping

入站 NAT 规则端口映射的集合。

properties.ipAddress
  • string

属于引用虚拟网络的 IP 地址。

properties.loadBalancerFrontendIPConfiguration

对区域负载均衡器中定义的前端 IP 地址配置的引用。

properties.networkInterfaceIPConfiguration

对网络接口中定义的 IP 地址的引用。

properties.subnet

对现有子网的引用。

properties.virtualNetwork

对现有虚拟网络的引用。

LoadBalancerBackendAddressAdminState

一个管理状态列表,一旦设置可以替代运行状况探测,以便负载均衡器始终将新连接转发到后端,或拒绝新连接并重置现有连接。

Name Type Description
Down
  • string
Drain
  • string
None
  • string
Up
  • string

ManagedServiceIdentity

资源的标识。

Name Type Description
principalId
  • string

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

tenantId
  • string

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

type

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

userAssignedIdentities

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

NatGateway

Nat 网关资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.idleTimeoutInMinutes
  • integer

nat 网关的空闲超时。

properties.provisioningState

NAT 网关资源的预配状态。

properties.publicIpAddresses

与 nat 网关资源关联的公共 IP 地址数组。

properties.publicIpPrefixes

与 nat 网关资源关联的公共 IP 前缀数组。

properties.resourceGuid
  • string

NAT 网关资源的资源 GUID 属性。

properties.subnets

使用此 nat 网关资源引用子网的数组。

sku

nat 网关 SKU。

tags
  • object

资源标记。

type
  • string

资源类型。

zones
  • string[]

表示应在其中部署 Nat 网关的区域的可用性区域的列表。

NatGatewaySku

NAT 网关的 SKU。

Name Type Description
name

Nat 网关 SKU 的名称。

NatGatewaySkuName

Nat 网关 SKU 的名称。

Name Type Description
Standard
  • string

NatRulePortMapping

为后端池创建的入站 NAT 规则的单个端口映射。

Name Type Description
backendPort
  • integer

后端端口。

frontendPort
  • integer

前端端口。

inboundNatRuleName
  • string

入站 NAT 规则的名称。

NetworkInterface

资源组中的网络接口。

Name Type Description
etag
  • string

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

extendedLocation

网络接口的扩展位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.auxiliaryMode

网络接口资源的辅助模式。

properties.dnsSettings

网络接口中的 DNS 设置。

properties.dscpConfiguration

对网络接口链接到的 dscp 配置的引用。

properties.enableAcceleratedNetworking
  • boolean

如果将网络接口配置为加速网络。 不适用于需要加速网络的 VM 大小。

properties.enableIPForwarding
  • boolean

指示是否在此网络接口上启用 IP 转发。

properties.hostedWorkloads
  • string[]

链接的 BareMetal 资源的引用列表。

properties.ipConfigurations

网络接口的 IPConfiguration 列表。

properties.macAddress
  • string

网络接口的 MAC 地址。

properties.migrationPhase

网络接口资源的迁移阶段。

properties.networkSecurityGroup

对 NetworkSecurityGroup 资源的引用。

properties.nicType

网络接口资源的类型。

properties.primary
  • boolean

这是否是虚拟机上的主要网络接口。

properties.privateEndpoint

对网络接口链接到的专用终结点的引用。

properties.privateLinkService

网络接口资源的 Privatelinkservice。

properties.provisioningState

网络接口资源的预配状态。

properties.resourceGuid
  • string

网络接口资源的资源 GUID 属性。

properties.tapConfigurations

网络接口的 TapConfiguration 列表。

properties.virtualMachine

对虚拟机的引用。

properties.vnetEncryptionSupported
  • boolean

此 nic 是否附加到支持加密的虚拟机。

properties.workloadType
  • string

BareMetal 资源的 NetworkInterface 的 WorkloadType

tags
  • object

资源标记。

type
  • string

资源类型。

NetworkInterfaceAuxiliaryMode

网络接口资源的辅助模式。

Name Type Description
Floating
  • string
MaxConnections
  • string
None
  • string

NetworkInterfaceDnsSettings

网络接口的 DNS 设置。

Name Type Description
appliedDnsServers
  • string[]

如果使用此 NIC 的 VM 是可用性集的一部分,则此列表将包含属于可用性集的所有 NIC 中的所有 DNS 服务器的联合。 此属性是在其中每个 VM 上配置的。

dnsServers
  • string[]

DNS 服务器 IP 地址列表。 使用“AzureProvidedDNS”切换到 Azure 提供的 DNS 解析。 “AzureProvidedDNS”值不能与其他 IP 组合,它必须是 dnsServers 集合中的唯一值。

internalDnsNameLabel
  • string

此 NIC 的相对 DNS 名称,用于同一虚拟网络中的 VM 之间的内部通信。

internalDomainNameSuffix
  • string

即使未指定 internalDnsNameLabel,也会为 VM 的主 NIC 创建 DNS 条目。 可以通过将 VM 名称与 internalDomainNameSuffix 的值连接来构造此 DNS 名称。

internalFqdn
  • string

完全限定的 DNS 名称支持同一虚拟网络中的 VM 之间的内部通信。

NetworkInterfaceIPConfiguration

网络接口中的 IPConfiguration。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.applicationGatewayBackendAddressPools

对 ApplicationGatewayBackendAddressPool 资源的引用。

properties.applicationSecurityGroups

包含 IP 配置的应用程序安全组。

properties.gatewayLoadBalancer

对网关负载均衡器前端 IP 的引用。

properties.loadBalancerBackendAddressPools

对 LoadBalancerBackendAddressPool 资源的引用。

properties.loadBalancerInboundNatRules

LoadBalancerInboundNatRules 的引用列表。

properties.primary
  • boolean

这是否是网络接口上的主要客户地址。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAddressVersion

特定 IP 配置是 IPv4 还是 IPv6。 默认值为 IPv4。

properties.privateIPAllocationMethod

专用 IP 地址分配方法。

properties.privateLinkConnectionProperties

网络接口的 PrivateLinkConnection 属性。

properties.provisioningState

网络接口 IP 配置的预配状态。

properties.publicIPAddress

绑定到 IP 配置的公共 IP 地址。

properties.subnet

绑定到 IP 配置的子网。

properties.virtualNetworkTaps

对虚拟网络点击的引用。

type
  • string

资源类型。

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

网络接口的 PrivateLinkConnection 属性。

Name Type Description
fqdns
  • string[]

当前专用链接连接的 FQDN 列表。

groupId
  • string

当前专用链接连接的组 ID。

requiredMemberName
  • string

当前专用链接连接所需的成员名称。

NetworkInterfaceMigrationPhase

网络接口资源的迁移阶段。

Name Type Description
Abort
  • string
Commit
  • string
Committed
  • string
None
  • string
Prepare
  • string

NetworkInterfaceNicType

网络接口资源的类型。

Name Type Description
Elastic
  • string
Standard
  • string

NetworkInterfaceTapConfiguration

点击网络接口中的配置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.provisioningState

网络接口点击配置资源的预配状态。

properties.virtualNetworkTap

对虚拟网络 Tap 资源的引用。

type
  • string

子资源类型。

NetworkSecurityGroup

NetworkSecurityGroup 资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.defaultSecurityRules

网络安全组的默认安全规则。

properties.flowLogs

对流日志资源的引用集合。

properties.flushConnection
  • boolean

启用后,从网络安全组连接创建的流将在更新规则时重新评估。 初始启用将触发重新评估。

properties.networkInterfaces

对网络接口的引用的集合。

properties.provisioningState

网络安全组资源的预配状态。

properties.resourceGuid
  • string

网络安全组资源的资源 GUID 属性。

properties.securityRules

网络安全组的安全规则集合。

properties.subnets

对子网的引用集合。

tags
  • object

资源标记。

type
  • string

资源类型。

PrivateEndpoint

专用终结点资源。

Name Type Description
etag
  • string

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

extendedLocation

负载均衡器的扩展位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.applicationSecurityGroups

包含专用终结点 IP 配置的应用程序安全组。

properties.customDnsConfigs

自定义 DNS 配置的数组。

properties.customNetworkInterfaceName
  • string

附加到专用终结点的网络接口的自定义名称。

properties.ipConfigurations

专用终结点的 IP 配置列表。 这将用于映射到第一方服务的终结点。

properties.manualPrivateLinkServiceConnections

有关与远程资源的连接的信息分组。 当网络管理员无权批准与远程资源的连接时使用。

properties.networkInterfaces

对此专用终结点创建的网络接口的引用数组。

properties.privateLinkServiceConnections

有关与远程资源的连接的信息分组。

properties.provisioningState

专用终结点资源的预配状态。

properties.subnet

将从中分配专用 IP 的子网的 ID。

tags
  • object

资源标记。

type
  • string

资源类型。

PrivateEndpointConnection

PrivateEndpointConnection 资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.linkIdentifier
  • string

使用者链接 ID。

properties.privateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

properties.provisioningState

专用终结点连接资源的预配状态。

type
  • string

资源类型。

PrivateEndpointIPConfiguration

专用终结点的 IP 配置。

Name Type Description
etag
  • string

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

name
  • string

资源组中唯一的资源的名称。

properties.groupId
  • string

从此专用终结点应连接到的远程资源获取的组的 ID。

properties.memberName
  • string

从此专用终结点应连接到的远程资源获取的组的成员名称。

properties.privateIPAddress
  • string

从专用终结点子网获取的专用 IP 地址。

type
  • string

资源类型。

PrivateLinkService

专用链接服务资源。

Name Type Description
etag
  • string

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

extendedLocation

负载均衡器的扩展位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.alias
  • string

专用链接服务的别名。

properties.autoApproval

专用链接服务的自动审批列表。

properties.enableProxyProtocol
  • boolean

是否为代理协议启用了专用链接服务。

properties.fqdns
  • string[]

Fqdn 的列表。

properties.ipConfigurations

专用链接服务 IP 配置的数组。

properties.loadBalancerFrontendIpConfigurations

对负载均衡器 IP 配置的引用数组。

properties.networkInterfaces

对此专用链接服务创建的网络接口的引用数组。

properties.privateEndpointConnections

有关连接到专用终结点的列表数组。

properties.provisioningState

专用链接服务资源的预配状态。

properties.visibility

专用链接服务的可见性列表。

tags
  • object

资源标记。

type
  • string

资源类型。

PrivateLinkServiceConnection

PrivateLinkServiceConnection 资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.groupIds
  • string[]

从此专用终结点应连接到的远程资源获取的组的 ID (组) () 。

properties.privateLinkServiceConnectionState

有关与远程资源的连接状态的只读信息的集合。

properties.privateLinkServiceId
  • string

专用链接服务的资源 ID。

properties.provisioningState

专用链接服务连接资源的预配状态。

properties.requestMessage
  • string

使用此连接请求传递给远程资源的所有者的消息。 限制为 140 个字符。

type
  • string

资源类型。

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

Name Type Description
actionsRequired
  • string

一条消息,指示服务提供商上的更改是否需要对使用者进行任何更新。

description
  • string

批准/拒绝连接的原因。

status
  • string

指示连接是否已由服务的所有者批准/拒绝/删除。

PrivateLinkServiceIpConfiguration

专用链接服务 IP 配置。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

专用链接服务 IP 配置的名称。

properties.primary
  • boolean

IP 配置是否为主要配置。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAddressVersion

特定 IP 配置是 IPv4 还是 IPv6。 默认值为 IPv4。

properties.privateIPAllocationMethod

专用 IP 地址分配方法。

properties.provisioningState

专用链接服务 IP 配置资源的预配状态。

properties.subnet

对子网资源的引用。

type
  • string

资源类型。

ProvisioningState

当前预配状态。

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

PublicIPAddress

公共 IP 地址资源。

Name Type Description
etag
  • string

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

extendedLocation

公共 IP 地址的扩展位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.ddosSettings

与公共 IP 地址关联的 DDoS 保护自定义策略。

properties.deleteOption

指定删除 VM 时公共 IP 地址会发生什么情况

properties.dnsSettings

与公共 IP 地址关联的 DNS 记录的 FQDN。

properties.idleTimeoutInMinutes
  • integer

公共 IP 地址的空闲超时。

properties.ipAddress
  • string

与公共 IP 地址资源关联的 IP 地址。

properties.ipConfiguration

与公共 IP 地址关联的 IP 配置。

properties.ipTags

与公共 IP 地址关联的标记列表。

properties.linkedPublicIPAddress

公共 IP 地址资源的链接公共 IP 地址。

properties.migrationPhase

公共 IP 地址的迁移阶段。

properties.natGateway

公共 IP 地址的 NatGateway。

properties.provisioningState

公共 IP 地址资源的预配状态。

properties.publicIPAddressVersion

公共 IP 地址版本。

properties.publicIPAllocationMethod

公共 IP 地址分配方法。

properties.publicIPPrefix

应从中分配此公共 IP 地址的公共 IP 前缀。

properties.resourceGuid
  • string

公共 IP 地址资源的资源 GUID 属性。

properties.servicePublicIPAddress

公共 IP 地址资源的服务公共 IP 地址。

sku

公共 IP 地址 SKU。

tags
  • object

资源标记。

type
  • string

资源类型。

zones
  • string[]

表示为资源分配的 IP 需要来自的可用性区域列表。

PublicIPAddressDnsSettings

包含与公共 IP 地址关联的 DNS 记录的 FQDN。

Name Type Description
domainNameLabel
  • string

域名标签。 域名标签与区域化 DNS 区域的串联形式构成了与公共 IP 地址关联的完全限定域名。 如果指定了域名标签,则会在 Microsoft Azure DNS 系统中为公共 IP 创建 DNS 记录。

fqdn
  • string

与公共 IP 关联的 A DNS 记录的完全限定域名。 这是 domainNameLabel 和区域化 DNS 区域的串联。

reverseFqdn
  • string

反向 FQDN。 解析为此公共 IP 地址的用户可见完全限定域名。 如果指定了 reverseFqdn,则会创建从 in-addr.arpa 域中的 IP 地址指向反向 FQDN 的 DNS PTR 记录。

PublicIPAddressMigrationPhase

公共 IP 地址的迁移阶段。

Name Type Description
Abort
  • string
Commit
  • string
Committed
  • string
None
  • string
Prepare
  • string

PublicIPAddressSku

公共 IP 地址的 SKU。

Name Type Description
name

公共 IP 地址 SKU 的名称。

tier

公共 IP 地址 SKU 的层。

PublicIPAddressSkuName

公共 IP 地址 SKU 的名称。

Name Type Description
Basic
  • string
Standard
  • string

PublicIPAddressSkuTier

公共 IP 地址 SKU 的层。

Name Type Description
Global
  • string
Regional
  • string

ResourceIdentityType

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

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

ResourceNavigationLink 资源。

Name Type Description
etag
  • string

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

id
  • string

资源导航链接标识符。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.link
  • string

链接到外部资源。

properties.linkedResourceType
  • string

链接资源的资源类型。

properties.provisioningState

资源导航链接资源的预配状态。

type
  • string

资源类型。

RetentionPolicyParameters

定义流日志保留策略的参数。

Name Type Default Value Description
days
  • integer
0

保留流日志记录的天数。

enabled
  • boolean
False

启用/禁用保留的标志。

Route

路由资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.addressPrefix
  • string

路由应用到的目标 CIDR。

properties.hasBgpOverride
  • boolean

一个值,该值指示此路由是否替代重叠的 BGP 路由,而不考虑 LPM。

properties.nextHopIpAddress
  • string

IP 地址数据包应转发到。 下一跃点值仅在下一跃点类型为 VirtualAppliance 的路由中允许。

properties.nextHopType

数据包应发送到的 Azure 跃点的类型。

properties.provisioningState

路由资源的预配状态。

type
  • string

资源类型。

RouteNextHopType

数据包应发送到的 Azure 跃点的类型。

Name Type Description
Internet
  • string
None
  • string
VirtualAppliance
  • string
VirtualNetworkGateway
  • string
VnetLocal
  • string

RouteTable

路由表资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.disableBgpRoutePropagation
  • boolean

是否禁用 BGP 在该路由表上学习的路由。 True 表示禁用。

properties.provisioningState

路由表资源的预配状态。

properties.resourceGuid
  • string

路由表的资源 GUID 属性。

properties.routes

路由表中包含的路由的集合。

properties.subnets

对子网的引用集合。

tags
  • object

资源标记。

type
  • string

资源类型。

SecurityRule

网络安全规则。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.access

允许或拒绝网络流量。

properties.description
  • string

此规则的说明。 限制为 140 个字符。

properties.destinationAddressPrefix
  • string

目标地址前缀。 CIDR 或目标 IP 范围。 也可以使用星号“*”来匹配所有源 IP。 也可以使用“VirtualNetwork”、“AzureLoadBalancer”和“Internet”等默认标记。

properties.destinationAddressPrefixes
  • string[]

目标地址前缀。 CIDR 或目标 IP 范围。

properties.destinationApplicationSecurityGroups

指定为目标的应用程序安全组。

properties.destinationPortRange
  • string

目标端口或范围。 介于 0 和 65535 之间的整数或范围。 星号“*”还可用于匹配所有端口。

properties.destinationPortRanges
  • string[]

目标端口范围。

properties.direction

规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。

properties.priority
  • integer

规则的优先级。 该值可以是 100 到 4096。 对于集合中的每个规则,优先级编号必须是唯一的。 优先级编号越低,规则优先级越高。

properties.protocol

此规则应用到的网络协议。

properties.provisioningState

安全规则资源的预配状态。

properties.sourceAddressPrefix
  • string

CIDR 或源 IP 范围。 也可以使用星号“*”来匹配所有源 IP。 也可以使用“VirtualNetwork”、“AzureLoadBalancer”和“Internet”等默认标记。 如果这是入口规则,则指定网络流量的来源。

properties.sourceAddressPrefixes
  • string[]

CIDR 或源 IP 范围。

properties.sourceApplicationSecurityGroups

指定为源的应用程序安全组。

properties.sourcePortRange
  • string

源端口或范围。 介于 0 和 65535 之间的整数或范围。 星号“*”还可用于匹配所有端口。

properties.sourcePortRanges
  • string[]

源端口范围。

type
  • string

资源类型。

SecurityRuleAccess

是允许还是拒绝网络流量。

Name Type Description
Allow
  • string
Deny
  • string

SecurityRuleDirection

规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。

Name Type Description
Inbound
  • string
Outbound
  • string

SecurityRuleProtocol

此规则应用到的网络协议。

Name Type Description
*
  • string
Ah
  • string
Esp
  • string
Icmp
  • string
Tcp
  • string
Udp
  • string

ServiceAssociationLink 资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.allowDelete
  • boolean

如果为 true,则可以删除资源。

properties.link
  • string

链接到外部资源。

properties.linkedResourceType
  • string

链接资源的资源类型。

properties.locations
  • string[]

位置列表。

properties.provisioningState

服务关联链接资源的预配状态。

type
  • string

资源类型。

ServiceEndpointPolicy

服务终结点策略资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

kind
  • string

服务终结点策略的类型。 这是用于Azure 门户体验的元数据。

location
  • string

资源位置。

name
  • string

资源名称。

properties.contextualServiceEndpointPolicies
  • string[]

上下文服务终结点策略的集合。

properties.provisioningState

服务终结点策略资源的预配状态。

properties.resourceGuid
  • string

服务终结点策略资源的资源 GUID 属性。

properties.serviceAlias
  • string

指示策略是否属于服务的别名

properties.serviceEndpointPolicyDefinitions

服务终结点策略的服务终结点策略定义的集合。

properties.subnets

对子网的引用集合。

tags
  • object

资源标记。

type
  • string

资源类型。

ServiceEndpointPolicyDefinition

服务终结点策略定义。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.description
  • string

此规则的说明。 限制为 140 个字符。

properties.provisioningState

服务终结点策略定义资源的预配状态。

properties.service
  • string

服务终结点名称。

properties.serviceResources
  • string[]

服务资源列表。

type
  • string

资源类型。

ServiceEndpointPropertiesFormat

服务终结点属性。

Name Type Description
locations
  • string[]

位置列表。

provisioningState

服务终结点资源的预配状态。

service
  • string

终结点服务的类型。

Subnet

虚拟网络资源中的子网。

Name Type Default Value Description
etag
  • string

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

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.addressPrefix
  • string

子网的地址前缀。

properties.addressPrefixes
  • string[]

子网的地址前缀列表。

properties.applicationGatewayIpConfigurations

虚拟网络资源的应用程序网关 IP 配置。

properties.delegations

对子网上的委派的引用数组。

properties.ipAllocations

引用此子网的 IpAllocation 数组。

properties.ipConfigurationProfiles

引用此子网的 IP 配置文件数组。

properties.ipConfigurations

使用子网引用网络接口 IP 配置的数组。

properties.natGateway

与此子网关联的 Nat 网关。

properties.networkSecurityGroup

对 NetworkSecurityGroup 资源的引用。

properties.privateEndpointNetworkPolicies Disabled

在子网中的专用终结点上启用或禁用应用网络策略。

properties.privateEndpoints

对专用终结点的引用数组。

properties.privateLinkServiceNetworkPolicies Enabled

在子网中的专用链接服务上启用或禁用应用网络策略。

properties.provisioningState

子网资源的预配状态。

properties.purpose
  • string

一个只读字符串,用于根据委托和其他用户定义的属性标识此子网的用途。

properties.resourceNavigationLinks

使用子网引用外部资源的数组。

properties.routeTable

对 RouteTable 资源的引用。

properties.serviceAssociationLinks

对注入此子网的服务的引用数组。

properties.serviceEndpointPolicies

服务终结点策略数组。

properties.serviceEndpoints

服务终结点数组。

type
  • string

资源类型。

SubResource

对另一个子资源的引用。

Name Type Description
id
  • string

资源 ID。

TrafficAnalyticsConfigurationProperties

定义流量分析配置的参数。

Name Type Description
enabled
  • boolean

用于启用/禁用流量分析的标志。

trafficAnalyticsInterval
  • integer

将决定 TA 服务执行流分析的频率的间隔(以分钟为单位)。

workspaceId
  • string

附加工作区的资源 guid。

workspaceRegion
  • string

附加工作区的位置。

workspaceResourceId
  • string

附加工作区的资源 ID。

TrafficAnalyticsProperties

定义流量分析配置的参数。

Name Type Description
networkWatcherFlowAnalyticsConfiguration

定义流量分析配置的参数。

TransportProtocol

终结点的传输协议。

Name Type Description
All
  • string
Tcp
  • string
Udp
  • string

UserAssignedIdentities

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

Name Type Description

VirtualNetworkPrivateEndpointNetworkPolicies

在子网中的专用终结点上启用或禁用应用网络策略。

Name Type Description
Disabled
  • string
Enabled
  • string

VirtualNetworkPrivateLinkServiceNetworkPolicies

在子网中的专用链接服务上启用或禁用应用网络策略。

Name Type Description
Disabled
  • string
Enabled
  • string

VirtualNetworkTap

虚拟网络点击资源。

Name Type Description
etag
  • string

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

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.destinationLoadBalancerFrontEndIPConfiguration

对内部负载均衡器上将接收点击的专用 IP 地址的引用。

properties.destinationNetworkInterfaceIPConfiguration

对将接收点击的收集器 nic 的专用 IP 地址的引用。

properties.destinationPort
  • integer

将接收点击流量的 VXLAN 目标端口。

properties.networkInterfaceTapConfigurations

指定需要点击的网络接口 IP 配置的资源 ID 列表。

properties.provisioningState

虚拟网络点击资源的预配状态。

properties.resourceGuid
  • string

虚拟网络的资源 GUID 属性点击资源。

tags
  • object

资源标记。

type
  • string

资源类型。

Visibility

专用链接服务的可见性列表。

Name Type Description
subscriptions
  • string[]

订阅列表。