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

Application Gateways - Create Or Update

服务:: Application Gateway

API 版本:: 2024-10-01

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

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

URI 参数

名称	在	必需	类型	说明
applicationGatewayName	path	True	string	应用程序网关的名称。
resourceGroupName	path	True	string	资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
id	string	资源 ID。
identity	ManagedServiceIdentity	应用程序网关的标识（如果已配置）。
location	string	资源位置。
properties.authenticationCertificates	ApplicationGatewayAuthenticationCertificate[]	应用程序网关资源的身份验证证书。有关默认限制，请参阅应用程序网关限制。
properties.autoscaleConfiguration	ApplicationGatewayAutoscaleConfiguration	自动缩放配置。
properties.backendAddressPools	ApplicationGatewayBackendAddressPool[]	应用程序网关资源的后端地址池。有关默认限制，请参阅应用程序网关限制。
properties.backendHttpSettingsCollection	ApplicationGatewayBackendHttpSettings[]	应用程序网关资源的后端 http 设置。有关默认限制，请参阅应用程序网关限制。
properties.backendSettingsCollection	ApplicationGatewayBackendSettings[]	应用程序网关资源的后端设置。有关默认限制，请参阅应用程序网关限制。
properties.customErrorConfigurations	ApplicationGatewayCustomError[]	应用程序网关资源的自定义错误配置。
properties.enableFips	boolean	是否在应用程序网关资源上启用了 FIPS。
properties.enableHttp2	boolean	是否在应用程序网关资源上启用了 HTTP2。
properties.firewallPolicy	SubResource	对 FirewallPolicy 资源的引用。
properties.forceFirewallPolicyAssociation	boolean	如果为 true，则将防火墙策略与应用程序网关相关联，无论该策略是否与 WAF 配置不同。
properties.frontendIPConfigurations	ApplicationGatewayFrontendIPConfiguration[]	应用程序网关资源的前端 IP 地址。有关默认限制，请参阅应用程序网关限制。
properties.frontendPorts	ApplicationGatewayFrontendPort[]	应用程序网关资源的前端端口。有关默认限制，请参阅应用程序网关限制。
properties.gatewayIPConfigurations	ApplicationGatewayIPConfiguration[]	应用程序网关资源的子网。有关默认限制，请参阅应用程序网关限制。
properties.globalConfiguration	ApplicationGatewayGlobalConfiguration	全局配置。
properties.httpListeners	ApplicationGatewayHttpListener[]	应用程序网关资源的 Http 侦听器。有关默认限制，请参阅应用程序网关限制。
properties.listeners	ApplicationGatewayListener[]	应用程序网关资源的侦听器。有关默认限制，请参阅应用程序网关限制。
properties.loadDistributionPolicies	ApplicationGatewayLoadDistributionPolicy[]	应用程序网关资源的负载分配策略。
properties.privateLinkConfigurations	ApplicationGatewayPrivateLinkConfiguration[]	应用程序网关上的 PrivateLink 配置。
properties.probes	ApplicationGatewayProbe[]	应用程序网关资源的探测。
properties.redirectConfigurations	ApplicationGatewayRedirectConfiguration[]	重定向应用程序网关资源的配置。有关默认限制，请参阅应用程序网关限制。
properties.requestRoutingRules	ApplicationGatewayRequestRoutingRule[]	请求应用程序网关资源的路由规则。
properties.rewriteRuleSets	ApplicationGatewayRewriteRuleSet[]	重写应用程序网关资源的规则。
properties.routingRules	ApplicationGatewayRoutingRule[]	应用程序网关资源的路由规则。
properties.sku	ApplicationGatewaySku	应用程序网关资源的 SKU。
properties.sslCertificates	ApplicationGatewaySslCertificate[]	应用程序网关资源的 SSL 证书。有关默认限制，请参阅应用程序网关限制。
properties.sslPolicy	ApplicationGatewaySslPolicy	应用程序网关资源的 SSL 策略。
properties.sslProfiles	ApplicationGatewaySslProfile[]	应用程序网关资源的 SSL 配置文件。有关默认限制，请参阅应用程序网关限制。
properties.trustedClientCertificates	ApplicationGatewayTrustedClientCertificate[]	应用程序网关资源的受信任客户端证书。有关默认限制，请参阅应用程序网关限制。
properties.trustedRootCertificates	ApplicationGatewayTrustedRootCertificate[]	应用程序网关资源的受信任根证书。有关默认限制，请参阅应用程序网关限制。
properties.urlPathMaps	ApplicationGatewayUrlPathMap[]	应用程序网关资源的 URL 路径映射。有关默认限制，请参阅应用程序网关限制。
properties.webApplicationFirewallConfiguration	ApplicationGatewayWebApplicationFirewallConfiguration	Web 应用程序防火墙配置。
tags	object	资源标记。
zones	string[]	一个可用性区域列表，表示资源需要来自何处。

响应

名称	类型	说明
200 OK	ApplicationGateway	更新成功。该作将返回生成的 ApplicationGateway 资源。
201 Created	ApplicationGateway	创造成功。该作将返回生成的 ApplicationGateway 资源。
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Create Application Gateway

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw?api-version=2024-10-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": [
            {
              "ipAddress": "10.0.0.1"
            },
            {
              "ipAddress": "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"
        }
      }
    ],
    "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"
          }
        }
      }
    ],
    "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"
                }
              }
            }
          ]
        }
      }
    ],
    "globalConfiguration": {
      "enableRequestBuffering": true,
      "enableResponseBuffering": true
    }
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/ApplicationGatewayCreate.json
// this example is just showing the usage of "ApplicationGateways_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ApplicationGatewayResource
ApplicationGatewayCollection collection = resourceGroupResource.GetApplicationGateways();

// invoke the operation
string applicationGatewayName = "appgw";
ApplicationGatewayData data = new ApplicationGatewayData
{
    Identity = new ManagedServiceIdentity("UserAssigned")
    {
        UserAssignedIdentities =
        {
        [new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1")] = new UserAssignedIdentity()
        },
    },
    Sku = new ApplicationGatewaySku
    {
        Name = ApplicationGatewaySkuName.StandardV2,
        Tier = ApplicationGatewayTier.StandardV2,
        Capacity = 3,
    },
    GatewayIPConfigurations = {new ApplicationGatewayIPConfiguration
    {
    SubnetId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet"),
    Name = "appgwipc",
    }},
    TrustedRootCertificates = {new ApplicationGatewayTrustedRootCertificate
    {
    Data = BinaryData.FromObjectAsJson("****"),
    Name = "rootcert",
    }, new ApplicationGatewayTrustedRootCertificate
    {
    KeyVaultSecretId = "https://kv/secret",
    Name = "rootcert1",
    }},
    TrustedClientCertificates = {new ApplicationGatewayTrustedClientCertificate
    {
    Data = BinaryData.FromObjectAsJson("****"),
    Name = "clientcert",
    }},
    SslCertificates = {new ApplicationGatewaySslCertificate
    {
    Data = BinaryData.FromObjectAsJson("****"),
    Password = "****",
    Name = "sslcert",
    }, new ApplicationGatewaySslCertificate
    {
    KeyVaultSecretId = "https://kv/secret",
    Name = "sslcert2",
    }},
    FrontendIPConfigurations = {new ApplicationGatewayFrontendIPConfiguration
    {
    PublicIPAddressId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"),
    Name = "appgwfip",
    }},
    FrontendPorts = {new ApplicationGatewayFrontendPort
    {
    Port = 443,
    Name = "appgwfp",
    }, new ApplicationGatewayFrontendPort
    {
    Port = 80,
    Name = "appgwfp80",
    }},
    BackendAddressPools = {new ApplicationGatewayBackendAddressPool
    {
    BackendAddresses = {new ApplicationGatewayBackendAddress
    {
    IPAddress = "10.0.1.1",
    }, new ApplicationGatewayBackendAddress
    {
    IPAddress = "10.0.1.2",
    }},
    Name = "appgwpool",
    }, new ApplicationGatewayBackendAddressPool
    {
    BackendAddresses = {new ApplicationGatewayBackendAddress
    {
    IPAddress = "10.0.0.1",
    }, new ApplicationGatewayBackendAddress
    {
    IPAddress = "10.0.0.2",
    }},
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1"),
    Name = "appgwpool1",
    }},
    BackendHttpSettingsCollection = {new ApplicationGatewayBackendHttpSettings
    {
    Port = 80,
    Protocol = ApplicationGatewayProtocol.Http,
    CookieBasedAffinity = ApplicationGatewayCookieBasedAffinity.Disabled,
    RequestTimeoutInSeconds = 30,
    Name = "appgwbhs",
    }},
    HttpListeners = {new ApplicationGatewayHttpListener
    {
    FrontendIPConfigurationId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"),
    FrontendPortId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"),
    Protocol = ApplicationGatewayProtocol.Https,
    SslCertificateId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"),
    SslProfileId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1"),
    RequireServerNameIndication = false,
    Name = "appgwhl",
    }, new ApplicationGatewayHttpListener
    {
    FrontendIPConfigurationId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"),
    FrontendPortId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"),
    Protocol = ApplicationGatewayProtocol.Http,
    Name = "appgwhttplistener",
    }},
    SslProfiles = {new ApplicationGatewaySslProfile
    {
    TrustedClientCertificates = {new WritableSubResource
    {
    Id = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert"),
    }},
    SslPolicy = new ApplicationGatewaySslPolicy
    {
    PolicyType = ApplicationGatewaySslPolicyType.Custom,
    CipherSuites = {ApplicationGatewaySslCipherSuite.TlsECDiffieHellmanRsaWithAes128CbcSha256},
    MinProtocolVersion = ApplicationGatewaySslProtocol.Tls1_1,
    },
    ClientAuthConfiguration = new ApplicationGatewayClientAuthConfiguration
    {
    VerifyClientCertIssuerDN = true,
    },
    Name = "sslProfile1",
    }},
    RequestRoutingRules = {new ApplicationGatewayRequestRoutingRule
    {
    RuleType = ApplicationGatewayRequestRoutingRuleType.Basic,
    Priority = 10,
    BackendAddressPoolId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"),
    BackendHttpSettingsId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"),
    HttpListenerId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"),
    RewriteRuleSetId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"),
    Name = "appgwrule",
    }},
    RewriteRuleSets = {new ApplicationGatewayRewriteRuleSet
    {
    RewriteRules = {new ApplicationGatewayRewriteRule
    {
    Name = "Set X-Forwarded-For",
    RuleSequence = 102,
    Conditions = {new ApplicationGatewayRewriteRuleCondition
    {
    Variable = "http_req_Authorization",
    Pattern = "^Bearer",
    IgnoreCase = true,
    Negate = false,
    }},
    ActionSet = new ApplicationGatewayRewriteRuleActionSet
    {
    RequestHeaderConfigurations = {new ApplicationGatewayHeaderConfiguration
    {
    HeaderName = "X-Forwarded-For",
    HeaderValue = "{var_add_x_forwarded_for_proxy}",
    }},
    ResponseHeaderConfigurations = {new ApplicationGatewayHeaderConfiguration
    {
    HeaderName = "Strict-Transport-Security",
    HeaderValue = "max-age=31536000",
    }},
    UrlConfiguration = new ApplicationGatewayUrlConfiguration
    {
    ModifiedPath = "/abc",
    },
    },
    }},
    Name = "rewriteRuleSet1",
    }},
    GlobalConfiguration = new ApplicationGatewayGlobalConfiguration
    {
        EnableRequestBuffering = true,
        EnableResponseBuffering = true,
    },
    Location = new AzureLocation("eastus"),
};
ArmOperation<ApplicationGatewayResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, applicationGatewayName, data);
ApplicationGatewayResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApplicationGatewayData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 201

{
  "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": [
            {
              "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": {
          "provisioningState": "Succeeded",
          "backendAddresses": [
            {
              "ipAddress": "10.0.0.1"
            },
            {
              "ipAddress": "10.0.0.2"
            }
          ]
        }
      }
    ],
    "loadDistributionPolicies": [],
    "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,
            "verifyClientRevocation": "OCSP"
          },
          "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"
        }
      }
    ],
    "listeners": [],
    "urlPathMaps": [],
    "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"
          }
        }
      }
    ],
    "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
                }
              }
            }
          ]
        }
      }
    ],
    "routingRules": [],
    "probes": [],
    "redirectConfigurations": [],
    "privateEndpointConnections": [],
    "globalConfiguration": {
      "enableRequestBuffering": true,
      "enableResponseBuffering": true
    }
  }
}

状态代码:: 200

{
  "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": [
            {
              "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": {
          "provisioningState": "Succeeded",
          "backendAddresses": [
            {
              "ipAddress": "10.0.0.1"
            },
            {
              "ipAddress": "10.0.0.2"
            }
          ]
        }
      }
    ],
    "loadDistributionPolicies": [],
    "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"
        }
      }
    ],
    "listeners": [],
    "urlPathMaps": [],
    "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"
          }
        }
      }
    ],
    "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"
                }
              }
            }
          ]
        }
      }
    ],
    "routingRules": [],
    "probes": [],
    "redirectConfigurations": [],
    "privateEndpointConnections": [],
    "globalConfiguration": {
      "enableRequestBuffering": true,
      "enableResponseBuffering": true
    }
  }
}

定义

名称	说明
ApplicationGateway	应用程序网关资源。
ApplicationGatewayAuthenticationCertificate	应用程序网关的身份验证证书。
ApplicationGatewayAutoscaleConfiguration	应用程序网关自动缩放配置。
ApplicationGatewayBackendAddress	应用程序网关的后端地址。
ApplicationGatewayBackendAddressPool	应用程序网关的后端地址池。
ApplicationGatewayBackendHttpSettings	应用程序网关的后端地址池设置。
ApplicationGatewayBackendSettings	应用程序网关的后端地址池设置。
ApplicationGatewayClientAuthConfiguration	应用程序网关客户端身份验证配置。
ApplicationGatewayClientRevocationOptions	验证客户端证书吊销状态。
ApplicationGatewayConnectionDraining	连接清空允许在后端服务器从配置中删除后，与后端服务器的打开连接在指定时间内处于活动状态。
ApplicationGatewayCookieBasedAffinity	基于 Cookie 的亲和力。
ApplicationGatewayCustomError	应用程序网关的自定义错误。
ApplicationGatewayCustomErrorStatusCode	应用程序网关自定义错误的状态代码。
ApplicationGatewayFirewallDisabledRuleGroup	允许禁用规则组或整个规则组中的规则。
ApplicationGatewayFirewallExclusion	允许排除一些满足 WAF 检查条件的变量。
ApplicationGatewayFirewallMode	Web 应用程序防火墙模式。
ApplicationGatewayFrontendIPConfiguration	应用程序网关的前端 IP 配置。
ApplicationGatewayFrontendPort	应用程序网关的前端端口。
ApplicationGatewayGlobalConfiguration	应用程序网关全局配置。
ApplicationGatewayHeaderConfiguration	应用程序网关中设置的作的标头配置。
ApplicationGatewayHttpListener	应用程序网关的 Http 侦听器。
ApplicationGatewayIPConfiguration	应用程序网关的 IP 配置。目前允许 1 个公共 IP 和 1 个私有 IP 配置。
ApplicationGatewayListener	应用程序网关的侦听器。
ApplicationGatewayLoadDistributionAlgorithm	加载应用程序网关的 Load Distribution Targets 资源。
ApplicationGatewayLoadDistributionPolicy	应用程序网关的负载分配策略。
ApplicationGatewayLoadDistributionTarget	应用程序网关的负载分布目标。
ApplicationGatewayOperationalState	应用程序网关资源的作状态。
ApplicationGatewayPathRule	应用程序网关的 URL 路径映射的路径规则。
ApplicationGatewayPrivateEndpointConnection	应用程序网关上的专用终结点连接。
ApplicationGatewayPrivateLinkConfiguration	应用程序网关上的专用链接配置。
ApplicationGatewayPrivateLinkIpConfiguration	应用程序网关专用链接 IP 配置。
ApplicationGatewayProbe	应用程序网关的探测。
ApplicationGatewayProbeHealthResponseMatch	应用程序网关探测运行状况响应匹配。
ApplicationGatewayProtocol	应用程序网关协议。
ApplicationGatewayRedirectConfiguration	重定向应用程序网关的配置。
ApplicationGatewayRedirectType	HTTP 重定向类型。
ApplicationGatewayRequestRoutingRule	应用程序网关的请求路由规则。
ApplicationGatewayRequestRoutingRuleType	规则类型。
ApplicationGatewayRewriteRule	应用程序网关的重写规则。
ApplicationGatewayRewriteRuleActionSet	应用程序网关中重写规则中的作集。
ApplicationGatewayRewriteRuleCondition	应用程序网关中重写规则中的条件集。
ApplicationGatewayRewriteRuleSet	重写应用程序网关的规则集。
ApplicationGatewayRoutingRule	应用程序网关的路由规则。
ApplicationGatewaySku	应用程序网关的 SKU。
ApplicationGatewaySkuFamily	应用程序网关 SKU 系列。
ApplicationGatewaySkuName	应用程序网关 SKU 的名称。
ApplicationGatewaySslCertificate	应用程序网关的 SSL 证书。
ApplicationGatewaySslCipherSuite	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 防护设置。
DdosSettingsProtectionMode	公共 IP 的 DDoS 保护模式
Delegation	详细说明子网委派到的服务。
DeleteOptions	指定删除 VM 时公共 IP 地址会发生什么情况
ExtendedLocation	ExtendedLocation 复杂类型。
ExtendedLocationTypes	扩展位置的类型。
FlowLog	流日志资源。
FlowLogFormatParameters	定义流日志格式的参数。
FlowLogFormatType	流日志的文件类型。
FrontendIPConfiguration	负载均衡器的前端 IP 地址。
GatewayLoadBalancerTunnelInterface	负载均衡器后端地址池的网关负载均衡器隧道接口。
GatewayLoadBalancerTunnelInterfaceType	网关负载均衡器隧道接口的流量类型。
GatewayLoadBalancerTunnelProtocol	网关负载均衡器隧道接口的协议。
HeaderValueMatcher	“重写作”下的可选字段。当存在具有相同名称的多个标头时，它允许捕获和修改特定标头的值。当前仅支持 Set-Cookie 响应标头。有关更多详细信息，请访问 https://aka.ms/appgwheadercrud
InboundNatRule	负载均衡器的入站 NAT 规则。
IPAllocationMethod	IP 地址分配方法。
IpamPoolPrefixAllocation	IpamPool 前缀分配引用。
IPConfiguration	IP 配置。
IPConfigurationProfile	IP 配置文件子资源。
IpTag	包含与对象关联的 IpTag。
IPVersion	IP 地址版本。
LoadBalancerBackendAddress	负载均衡器后端地址。
LoadBalancerBackendAddressAdminState	一个管理状态列表，一旦设置即可替代运行状况探测，以便负载均衡器始终将新连接转发到后端，或拒绝新连接并重置现有连接。
ManagedServiceIdentity	资源的标识。
NatGateway	Nat Gateway 资源。
NatGatewaySku	nat 网关的 SKU。
NatGatewaySkuName	Nat 网关 SKU 的名称。
NatRulePortMapping	为后端池创建的入站 NAT 规则的单个端口映射。
NetworkInterface	资源组中的网络接口。
NetworkInterfaceAuxiliaryMode	网络接口资源的辅助模式。
NetworkInterfaceAuxiliarySku	网络接口资源的辅助 SKU。
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。
PublicIpAddressDnsSettingsDomainNameLabelScope	域名标签范围。如果指定了域名标签和域名标签范围，则会为 Microsoft Azure DNS 系统中的公共 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	规则的方向。该方向指定在传入或传出流量上是否评估规则。
SecurityRuleProtocol	此规则适用于的网络协议。
ServiceAssociationLink	ServiceAssociationLink 资源。
ServiceEndpointPolicy	服务终结点策略资源。
ServiceEndpointPolicyDefinition	服务终结点策略定义。
ServiceEndpointPropertiesFormat	服务终结点属性。
SharingScope	将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。
Subnet	虚拟网络资源中的子网。
SubResource	对另一个子资源的引用。
SyncMode	后端池的后端地址同步模式
TrafficAnalyticsConfigurationProperties	定义流量分析配置的参数。
TrafficAnalyticsProperties	定义流量分析配置的参数。
TransportProtocol	终结点的传输协议。
UserAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
VirtualNetworkPrivateEndpointNetworkPolicies	在子网中的专用终结点上启用或禁用应用网络策略。
VirtualNetworkPrivateLinkServiceNetworkPolicies	在子网中的专用链接服务上启用或禁用应用网络策略。
VirtualNetworkTap	虚拟网络 Tap 资源。
Visibility	专用链接服务的可见性列表。

ApplicationGateway

Object

应用程序网关资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
identity	ManagedServiceIdentity	应用程序网关的标识（如果已配置）。
location	string	资源位置。
name	string	资源名称。
properties.authenticationCertificates	ApplicationGatewayAuthenticationCertificate[]	应用程序网关资源的身份验证证书。有关默认限制，请参阅应用程序网关限制。
properties.autoscaleConfiguration	ApplicationGatewayAutoscaleConfiguration	自动缩放配置。
properties.backendAddressPools	ApplicationGatewayBackendAddressPool[]	应用程序网关资源的后端地址池。有关默认限制，请参阅应用程序网关限制。
properties.backendHttpSettingsCollection	ApplicationGatewayBackendHttpSettings[]	应用程序网关资源的后端 http 设置。有关默认限制，请参阅应用程序网关限制。
properties.backendSettingsCollection	ApplicationGatewayBackendSettings[]	应用程序网关资源的后端设置。有关默认限制，请参阅应用程序网关限制。
properties.customErrorConfigurations	ApplicationGatewayCustomError[]	应用程序网关资源的自定义错误配置。
properties.defaultPredefinedSslPolicy	ApplicationGatewaySslPolicyName	应用于应用程序网关资源的默认预定义 SSL 策略。
properties.enableFips	boolean	是否在应用程序网关资源上启用了 FIPS。
properties.enableHttp2	boolean	是否在应用程序网关资源上启用了 HTTP2。
properties.firewallPolicy	SubResource	对 FirewallPolicy 资源的引用。
properties.forceFirewallPolicyAssociation	boolean	如果为 true，则将防火墙策略与应用程序网关相关联，无论该策略是否与 WAF 配置不同。
properties.frontendIPConfigurations	ApplicationGatewayFrontendIPConfiguration[]	应用程序网关资源的前端 IP 地址。有关默认限制，请参阅应用程序网关限制。
properties.frontendPorts	ApplicationGatewayFrontendPort[]	应用程序网关资源的前端端口。有关默认限制，请参阅应用程序网关限制。
properties.gatewayIPConfigurations	ApplicationGatewayIPConfiguration[]	应用程序网关资源的子网。有关默认限制，请参阅应用程序网关限制。
properties.globalConfiguration	ApplicationGatewayGlobalConfiguration	全局配置。
properties.httpListeners	ApplicationGatewayHttpListener[]	应用程序网关资源的 Http 侦听器。有关默认限制，请参阅应用程序网关限制。
properties.listeners	ApplicationGatewayListener[]	应用程序网关资源的侦听器。有关默认限制，请参阅应用程序网关限制。
properties.loadDistributionPolicies	ApplicationGatewayLoadDistributionPolicy[]	应用程序网关资源的负载分配策略。
properties.operationalState	ApplicationGatewayOperationalState	应用程序网关资源的作状态。
properties.privateEndpointConnections	ApplicationGatewayPrivateEndpointConnection[]	应用程序网关上的专用终结点连接。
properties.privateLinkConfigurations	ApplicationGatewayPrivateLinkConfiguration[]	应用程序网关上的 PrivateLink 配置。
properties.probes	ApplicationGatewayProbe[]	应用程序网关资源的探测。
properties.provisioningState	ProvisioningState	应用程序网关资源的预配状态。
properties.redirectConfigurations	ApplicationGatewayRedirectConfiguration[]	重定向应用程序网关资源的配置。有关默认限制，请参阅应用程序网关限制。
properties.requestRoutingRules	ApplicationGatewayRequestRoutingRule[]	请求应用程序网关资源的路由规则。
properties.resourceGuid	string	应用程序网关资源的资源 GUID 属性。
properties.rewriteRuleSets	ApplicationGatewayRewriteRuleSet[]	重写应用程序网关资源的规则。
properties.routingRules	ApplicationGatewayRoutingRule[]	应用程序网关资源的路由规则。
properties.sku	ApplicationGatewaySku	应用程序网关资源的 SKU。
properties.sslCertificates	ApplicationGatewaySslCertificate[]	应用程序网关资源的 SSL 证书。有关默认限制，请参阅应用程序网关限制。
properties.sslPolicy	ApplicationGatewaySslPolicy	应用程序网关资源的 SSL 策略。
properties.sslProfiles	ApplicationGatewaySslProfile[]	应用程序网关资源的 SSL 配置文件。有关默认限制，请参阅应用程序网关限制。
properties.trustedClientCertificates	ApplicationGatewayTrustedClientCertificate[]	应用程序网关资源的受信任客户端证书。有关默认限制，请参阅应用程序网关限制。
properties.trustedRootCertificates	ApplicationGatewayTrustedRootCertificate[]	应用程序网关资源的受信任根证书。有关默认限制，请参阅应用程序网关限制。
properties.urlPathMaps	ApplicationGatewayUrlPathMap[]	应用程序网关资源的 URL 路径映射。有关默认限制，请参阅应用程序网关限制。
properties.webApplicationFirewallConfiguration	ApplicationGatewayWebApplicationFirewallConfiguration	Web 应用程序防火墙配置。
tags	object	资源标记。
type	string	资源类型。
zones	string[]	一个可用性区域列表，表示资源需要来自何处。

ApplicationGatewayAuthenticationCertificate

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的身份验证证书的名称。
properties.data	string	证书公共数据。
properties.provisioningState	ProvisioningState	身份验证证书资源的预配状态。
type	string	资源的类型。

ApplicationGatewayAutoscaleConfiguration

Object

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

名称	类型	说明
maxCapacity	integer (int32) minimum: 2 exclusiveMinimum: False	应用程序网关容量数量的上限。
minCapacity	integer (int32) minimum: 0 exclusiveMinimum: False	应用程序网关容量数的下限。

ApplicationGatewayBackendAddress

Object

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

名称	类型	说明
fqdn	string	完全限定的域名 (FQDN)。
ipAddress	string	IP地址。

ApplicationGatewayBackendAddressPool

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的后端地址池的名称。
properties.backendAddresses	ApplicationGatewayBackendAddress[]	后端地址。
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	对网络接口中定义的 IP 的引用集合。
properties.provisioningState	ProvisioningState	后端地址池资源的预配状态。
type	string	资源的类型。

ApplicationGatewayBackendHttpSettings

Object

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

名称	类型	默认值	说明
etag	string		一个唯一的只读字符串，每当更新资源时更改。
id	string		资源 ID。
name	string		应用程序网关中唯一的后端 http 设置的名称。
properties.affinityCookieName	string		用于关联 Cookie 的 Cookie 名称。
properties.authenticationCertificates	SubResource[]		对应用程序网关身份验证证书的引用数组。
properties.connectionDraining	ApplicationGatewayConnectionDraining		后端 http 设置资源的连接耗尽。
properties.cookieBasedAffinity	ApplicationGatewayCookieBasedAffinity		基于 Cookie 的亲和力。
properties.dedicatedBackendConnection	boolean		为每个后端服务器启用或禁用专用连接。默认值设置为 false。
properties.hostName	string		要发送到后端服务器的主机标头。
properties.path	string		应用作所有 HTTP 请求前缀的路径。 Null 表示不会为任何路径添加前缀。默认值为 null。
properties.pickHostNameFromBackendAddress	boolean		是否选择主机头应从后端服务器的主机名中选择。默认值为 false。
properties.port	integer (int32)		后端的目标端口。
properties.probe	SubResource		探测应用程序网关的资源。
properties.probeEnabled	boolean		探测是否已启用。默认值为 false。
properties.protocol	ApplicationGatewayProtocol		用于与后端通信的协议。
properties.provisioningState	ProvisioningState		后端 HTTP 设置资源的预配状态。
properties.requestTimeout	integer (int32)		请求超时（以秒为单位）。如果在 RequestTimeout 内未收到响应，应用程序网关将使请求失败。可接受的值为 1 秒到 86400 秒。
properties.sniName	string		指定一个 SNI 值以匹配后端证书的公用名。默认情况下，应用程序网关使用传入请求的主机头作为 SNI。默认值为 null。
properties.trustedRootCertificates	SubResource[]		对应用程序网关受信任的根证书的引用数组。
properties.validateCertChainAndExpiry	boolean	True	验证或跳过后端服务器上证书的链式验证和到期验证。默认值设置为 true。
properties.validateSNI	boolean	True	启用后，验证后端服务器提供的证书的公用名是否与服务器名称指示（SNI）值匹配。默认值为 true。
type	string		资源的类型。

ApplicationGatewayBackendSettings

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的后端设置的名称。
properties.hostName	string	服务器名称指示发送到后端服务器以进行 Tls 协议。
properties.pickHostNameFromBackendAddress	boolean	是否从 Tls 协议的后端服务器主机名中选择服务器名称指示。默认值为 false。
properties.port	integer (int32)	后端的目标端口。
properties.probe	SubResource	探测应用程序网关的资源。
properties.protocol	ApplicationGatewayProtocol	用于与后端通信的协议。
properties.provisioningState	ProvisioningState	后端 HTTP 设置资源的预配状态。
properties.timeout	integer (int32)	连接超时（以秒为单位）。如果在 ConnectionTimeout 中未收到响应，则应用程序网关将使请求失败。可接受的值为 1 秒到 86400 秒。
properties.trustedRootCertificates	SubResource[]	对应用程序网关受信任的根证书的引用数组。
type	string	资源的类型。

ApplicationGatewayClientAuthConfiguration

Object

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

名称	类型	说明
verifyClientCertIssuerDN	boolean	验证应用程序网关上的客户端证书颁发者名称。
verifyClientRevocation	ApplicationGatewayClientRevocationOptions	验证客户端证书吊销状态。

ApplicationGatewayClientRevocationOptions

枚举

验证客户端证书吊销状态。

值	说明
None
OCSP

ApplicationGatewayConnectionDraining

Object

连接清空允许在后端服务器从配置中删除后，与后端服务器的打开连接在指定时间内处于活动状态。

名称	类型	说明
drainTimeoutInSec	integer (int32) minimum: 1 maximum: 3600 exclusiveMinimum: False exclusiveMaximum: False	连接排出的秒数处于活动状态。可接受的值为 1 秒到 3600 秒。
enabled	boolean	是否启用连接清空。

ApplicationGatewayCookieBasedAffinity

枚举

基于 Cookie 的亲和力。

值	说明
Enabled
Disabled

ApplicationGatewayCustomError

Object

应用程序网关的自定义错误。

名称	类型	说明
customErrorPageUrl	string	应用程序网关自定义错误的错误页 URL。
statusCode	ApplicationGatewayCustomErrorStatusCode	应用程序网关自定义错误的状态代码。

ApplicationGatewayCustomErrorStatusCode

枚举

应用程序网关自定义错误的状态代码。

值	说明
HttpStatus400
HttpStatus403
HttpStatus404
HttpStatus405
HttpStatus408
HttpStatus500
HttpStatus502
HttpStatus503
HttpStatus504

ApplicationGatewayFirewallDisabledRuleGroup

Object

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

名称	类型	说明
ruleGroupName	string	将禁用的规则组的名称。
rules	integer[] (int32)	将禁用的规则列表。如果为 null，则将禁用规则组的所有规则。

ApplicationGatewayFirewallExclusion

Object

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

名称	类型	说明
matchVariable	string	要排除的变量。
selector	string	当 matchVariable 是集合时，运算符用于指定此排除项适用于集合中的哪些元素。
selectorMatchOperator	string	当 matchVariable 是一个集合时，对选择器进行作以指定此排除项适用于集合中的哪些元素。

ApplicationGatewayFirewallMode

枚举

Web 应用程序防火墙模式。

值	说明
Detection
Prevention

ApplicationGatewayFrontendIPConfiguration

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的前端 IP 配置的名称。
properties.privateIPAddress	string	PrivateIP网络接口 IP 配置的地址。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 地址分配方法。
properties.privateLinkConfiguration	SubResource	对应用程序网关专用链接配置的引用。
properties.provisioningState	ProvisioningState	前端 IP 配置资源的预配状态。
properties.publicIPAddress	SubResource	对 PublicIP 资源的引用。
properties.subnet	SubResource	对子网资源的引用。
type	string	资源的类型。

ApplicationGatewayFrontendPort

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的前端端口的名称。
properties.port	integer (int32)	前端端口。
properties.provisioningState	ProvisioningState	前端端口资源的预配状态。
type	string	资源的类型。

ApplicationGatewayGlobalConfiguration

Object

应用程序网关全局配置。

名称	类型	说明
enableRequestBuffering	boolean	启用请求缓冲。
enableResponseBuffering	boolean	启用响应缓冲。

ApplicationGatewayHeaderConfiguration

Object

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

名称	类型	说明
headerName	string	标头配置的标头名称。
headerValue	string	标头配置的标头值。
headerValueMatcher	HeaderValueMatcher	“重写作”下的可选字段。当存在具有相同名称的多个标头时，它允许捕获和修改特定标头的值。当前仅支持 Set-Cookie 响应标头。有关更多详细信息，请访问 https://aka.ms/appgwheadercrud

ApplicationGatewayHttpListener

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的 HTTP 侦听器的名称。
properties.customErrorConfigurations	ApplicationGatewayCustomError[]	HTTP 侦听器的自定义错误配置。
properties.firewallPolicy	SubResource	对 FirewallPolicy 资源的引用。
properties.frontendIPConfiguration	SubResource	应用程序网关的前端 IP 配置资源。
properties.frontendPort	SubResource	应用程序网关的前端端口资源。
properties.hostName	string	HTTP 侦听器的主机名。
properties.hostNames	string[]	HTTP 侦听器的主机名列表，也允许特殊通配符。
properties.protocol	ApplicationGatewayProtocol	HTTP 侦听器的协议。
properties.provisioningState	ProvisioningState	HTTP 侦听器资源的预配状态。
properties.requireServerNameIndication	boolean	仅当协议为 https 时才适用。为多主机启用 SNI。
properties.sslCertificate	SubResource	应用程序网关的 SSL 证书资源。
properties.sslProfile	SubResource	应用程序网关的 SSL 配置文件资源。
type	string	资源的类型。

ApplicationGatewayIPConfiguration

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的 IP 配置的名称。
properties.provisioningState	ProvisioningState	应用程序网关 IP 配置资源的预配状态。
properties.subnet	SubResource	对子网资源的引用。应用程序网关从中获取其专用地址的子网。
type	string	资源的类型。

ApplicationGatewayListener

Object

应用程序网关的侦听器。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的侦听器的名称。
properties.frontendIPConfiguration	SubResource	应用程序网关的前端 IP 配置资源。
properties.frontendPort	SubResource	应用程序网关的前端端口资源。
properties.hostNames	string[]	TLS 多站点侦听器的服务器名称指示（SNI）列表，也允许特殊通配符。
properties.protocol	ApplicationGatewayProtocol	侦听器的协议。
properties.provisioningState	ProvisioningState	侦听器资源的预配状态。
properties.sslCertificate	SubResource	应用程序网关的 SSL 证书资源。
properties.sslProfile	SubResource	应用程序网关的 SSL 配置文件资源。
type	string	资源的类型。

ApplicationGatewayLoadDistributionAlgorithm

枚举

加载应用程序网关的 Load Distribution Targets 资源。

值	说明
RoundRobin
LeastConnections
IpHash

ApplicationGatewayLoadDistributionPolicy

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的负载分配策略的名称。
properties.loadDistributionAlgorithm	ApplicationGatewayLoadDistributionAlgorithm	加载应用程序网关的 Load Distribution Targets 资源。
properties.loadDistributionTargets	ApplicationGatewayLoadDistributionTarget[]	加载应用程序网关的 Load Distribution Targets 资源。
properties.provisioningState	ProvisioningState	负载分配策略资源的预配状态。
type	string	资源的类型。

ApplicationGatewayLoadDistributionTarget

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的负载分配策略的名称。
properties.backendAddressPool	SubResource	应用程序网关的后端地址池资源。
properties.weightPerServer	integer (int32) minimum: 1 maximum: 100 exclusiveMinimum: False exclusiveMaximum: False	每台服务器的重量。范围在 1 到 100 之间。
type	string	资源的类型。

ApplicationGatewayOperationalState

枚举

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

值	说明
Stopped
Starting
Running
Stopping

ApplicationGatewayPathRule

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的路径规则的名称。
properties.backendAddressPool	SubResource	URL 路径映射路径规则的后端地址池资源。
properties.backendHttpSettings	SubResource	URL 路径映射路径规则的后端 http 设置资源。
properties.firewallPolicy	SubResource	对 FirewallPolicy 资源的引用。
properties.loadDistributionPolicy	SubResource	加载 URL 路径映射路径规则的分发策略资源。
properties.paths	string[]	URL 路径映射的路径规则。
properties.provisioningState	ProvisioningState	路径规则资源的预配状态。
properties.redirectConfiguration	SubResource	URL 路径映射路径规则的重定向配置资源。
properties.rewriteRuleSet	SubResource	重写 URL 路径映射路径规则的规则集资源。
type	string	资源的类型。

ApplicationGatewayPrivateEndpointConnection

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关上专用终结点连接的名称。
properties.linkIdentifier	string	使用者链路 ID。
properties.privateEndpoint	PrivateEndpoint	专用终结点的资源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
properties.provisioningState	ProvisioningState	应用程序网关专用终结点连接资源的预配状态。
type	string	资源的类型。

ApplicationGatewayPrivateLinkConfiguration

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的专用链接配置的名称。
properties.ipConfigurations	ApplicationGatewayPrivateLinkIpConfiguration[]	应用程序网关专用链接 IP 配置的数组。
properties.provisioningState	ProvisioningState	应用程序网关专用链接配置的预配状态。
type	string	资源的类型。

ApplicationGatewayPrivateLinkIpConfiguration

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关专用链接 IP 配置的名称。
properties.primary	boolean	IP 配置是否为主要配置。
properties.privateIPAddress	string	IP 配置的专用 IP 地址。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 地址分配方法。
properties.provisioningState	ProvisioningState	应用程序网关专用链接 IP 配置的预配状态。
properties.subnet	SubResource	对子网资源的引用。
type	string	资源类型。

ApplicationGatewayProbe

Object

应用程序网关的探测。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的探测的名称。
properties.host	string	要将探测发送到的主机名。
properties.interval	integer (int32)	探测间隔（以秒为单位）。这是两个连续探测之间的时间间隔。可接受的值为 1 秒到 86400 秒。
properties.match	ApplicationGatewayProbeHealthResponseMatch	对健康探针反应进行分类的标准。
properties.minServers	integer (int32)	始终标记为正常的最小服务器数。默认值为 0 。
properties.path	string	探头的相对路径。有效路径从 '/' 开始。探测被发送到 <Protocol>：//host<：><port><path>。
properties.pickHostNameFromBackendHttpSettings	boolean	是否应从后端 http 设置中选择主机标头。默认值为 false。
properties.pickHostNameFromBackendSettings	boolean	是否应从 Tls 协议的后端设置中选择服务器名称指示。默认值为 false。
properties.port	integer (int32) minimum: 1 maximum: 65535	将用于探测后端服务器的自定义端口。有效值范围为 1 到 65535。如果未设置，将使用 http 设置中的端口。此属性仅对 Basic、Standard_v2 和 WAF_v2 有效。
properties.protocol	ApplicationGatewayProtocol	用于探测的协议。
properties.provisioningState	ProvisioningState	探测资源的预配状态。
properties.timeout	integer (int32)	探测超时（以秒为单位）。如果在此超时期间未收到有效响应，则探测标记为失败。可接受的值为 1 秒到 86400 秒。
properties.unhealthyThreshold	integer (int32)	探测重试计数。在连续探测失败计数达到 UnhealthyThreshold 后，后端服务器被标记为关闭。可接受的值为 1 秒到 20。
type	string	资源的类型。

ApplicationGatewayProbeHealthResponseMatch

Object

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

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

ApplicationGatewayProtocol

枚举

应用程序网关协议。

值	说明
Http	支持 httpListeners 和 backendHttpSettingsCollection 属性。
Https	支持 httpListeners 和 backendHttpSettingsCollection 属性。
Tcp	支持侦听器和 backendSettingsCollection 属性。
Tls	支持侦听器和 backendSettingsCollection 属性。

ApplicationGatewayRedirectConfiguration

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的重定向配置的名称。
properties.includePath	boolean	在重定向 URL 中包含路径。
properties.includeQueryString	boolean	在重定向 URL 中包含查询字符串。
properties.pathRules	SubResource[]	指定重定向配置的路径规则。
properties.redirectType	ApplicationGatewayRedirectType	HTTP 重定向类型。
properties.requestRoutingRules	SubResource[]	指定重定向配置的请求路由。
properties.targetListener	SubResource	引用要将请求重定向到的侦听器。
properties.targetUrl	string	要将请求重定向到的 URL。
properties.urlPathMaps	SubResource[]	指定默认重定向配置的 URL 路径映射。
type	string	资源的类型。

ApplicationGatewayRedirectType

枚举

HTTP 重定向类型。

值	说明
Permanent
Found
SeeOther
Temporary

ApplicationGatewayRequestRoutingRule

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的请求路由规则的名称。
properties.backendAddressPool	SubResource	应用程序网关的后端地址池资源。
properties.backendHttpSettings	SubResource	应用程序网关的后端 http 设置资源。
properties.httpListener	SubResource	应用程序网关的 Http 侦听器资源。
properties.loadDistributionPolicy	SubResource	加载应用程序网关的“分发策略”资源。
properties.priority	integer (int32) minimum: 1 maximum: 20000 exclusiveMinimum: False exclusiveMaximum: False	请求路由规则的优先级。
properties.provisioningState	ProvisioningState	请求路由规则资源的预配状态。
properties.redirectConfiguration	SubResource	重定向应用程序网关的配置资源。
properties.rewriteRuleSet	SubResource	重写应用程序网关的基本规则中的规则集资源。
properties.ruleType	ApplicationGatewayRequestRoutingRuleType	规则类型。
properties.urlPathMap	SubResource	应用程序网关的 URL 路径映射资源。
type	string	资源的类型。

ApplicationGatewayRequestRoutingRuleType

枚举

规则类型。

值	说明
Basic
PathBasedRouting

ApplicationGatewayRewriteRule

Object

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

名称	类型	说明
actionSet	ApplicationGatewayRewriteRuleActionSet	作为重写规则的一部分要执行的一组作。
conditions	ApplicationGatewayRewriteRuleCondition[]	评估作集执行所依据的条件。
name	string	应用程序网关中唯一的重写规则的名称。
ruleSequence	integer	重写规则的规则序列，用于确定 RewriteRuleSet 中特定规则的执行顺序。

ApplicationGatewayRewriteRuleActionSet

Object

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

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

ApplicationGatewayRewriteRuleCondition

Object

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

名称	类型	说明
ignoreCase	boolean	将此参数设置为真值，强制模式进行区分大小写的比较。
negate	boolean	将此值设置为真值将强制检查用户给出的条件的否定。
pattern	string	评估条件真实性的模式，固定字符串或正则表达式。
variable	string	RewriteRuleCondition 的条件参数。

ApplicationGatewayRewriteRuleSet

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	在应用程序网关中唯一的重写规则集的名称。
properties.provisioningState	ProvisioningState	重写规则集资源的预配状态。
properties.rewriteRules	ApplicationGatewayRewriteRule[]	重写规则集中的重写规则。

ApplicationGatewayRoutingRule

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的路由规则的名称。
properties.backendAddressPool	SubResource	应用程序网关的后端地址池资源。
properties.backendSettings	SubResource	应用程序网关的后端设置资源。
properties.listener	SubResource	应用程序网关的侦听器资源。
properties.priority	integer (int32) minimum: 1 maximum: 20000 exclusiveMinimum: False exclusiveMaximum: False	路由规则的优先级。
properties.provisioningState	ProvisioningState	请求路由规则资源的预配状态。
properties.ruleType	ApplicationGatewayRequestRoutingRuleType	规则类型。
type	string	资源的类型。

ApplicationGatewaySku

Object

应用程序网关的 SKU。

名称	类型	说明
capacity	integer (int32)	应用程序网关的容量（实例计数）。
family	ApplicationGatewaySkuFamily	应用程序网关 SKU 系列。
name	ApplicationGatewaySkuName	应用程序网关 SKU 的名称。
tier	ApplicationGatewayTier	应用程序网关的层。

ApplicationGatewaySkuFamily

枚举

应用程序网关 SKU 系列。

值	说明
Generation_1
Generation_2

ApplicationGatewaySkuName

枚举

应用程序网关 SKU 的名称。

值	说明
Standard_Small
Standard_Medium
Standard_Large
WAF_Medium
WAF_Large
Standard_v2
WAF_v2
Basic

ApplicationGatewaySslCertificate

Object

应用程序网关的 SSL 证书。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的 SSL 证书的名称。
properties.data	string	Base-64 编码的 pfx 证书。仅适用于 PUT 请求。
properties.keyVaultSecretId	string	存储在 KeyVault 中的“Secret”或“Certificate”对象的机密 ID（base-64 编码的未加密 pfx）。
properties.password	string	数据中指定的 pfx 文件的密码。仅适用于 PUT 请求。
properties.provisioningState	ProvisioningState	SSL 证书资源的预配状态。
properties.publicCertData	string	与数据中指定的 pfx 对应的 Base-64 编码的公共证书数据。仅适用于 GET 请求。
type	string	资源的类型。

ApplicationGatewaySslCipherSuite

枚举

Ssl 密码套件将按指定顺序启用到应用程序网关。

值	说明
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

ApplicationGatewaySslPolicy

Object

应用程序网关 Ssl 策略。

名称	类型	说明
cipherSuites	ApplicationGatewaySslCipherSuite[]	Ssl 密码套件将按指定顺序启用到应用程序网关。
disabledSslProtocols	ApplicationGatewaySslProtocol[]	要在应用程序网关上禁用的 Ssl 协议。
minProtocolVersion	ApplicationGatewaySslProtocol	应用程序网关支持的最低版本的 Ssl 协议。
policyName	ApplicationGatewaySslPolicyName	Ssl 预定义策略的名称。
policyType	ApplicationGatewaySslPolicyType	SSL 策略的类型。

ApplicationGatewaySslPolicyName

枚举

Ssl 预定义策略的名称。

值	说明
AppGwSslPolicy20150501
AppGwSslPolicy20170401
AppGwSslPolicy20170401S
AppGwSslPolicy20220101
AppGwSslPolicy20220101S

ApplicationGatewaySslPolicyType

枚举

SSL 策略的类型。

值	说明
Predefined
Custom
CustomV2

ApplicationGatewaySslProfile

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的 SSL 配置文件的名称。
properties.clientAuthConfiguration	ApplicationGatewayClientAuthConfiguration	应用程序网关资源的客户端身份验证配置。
properties.provisioningState	ProvisioningState	HTTP 侦听器资源的预配状态。
properties.sslPolicy	ApplicationGatewaySslPolicy	应用程序网关资源的 SSL 策略。
properties.trustedClientCertificates	SubResource[]	对应用程序网关受信任的客户端证书的引用数组。
type	string	资源的类型。

ApplicationGatewaySslProtocol

枚举

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

值	说明
TLSv1_0
TLSv1_1
TLSv1_2
TLSv1_3

ApplicationGatewayTier

枚举

应用程序网关的层。

值	说明
Standard
WAF
Standard_v2
WAF_v2
Basic

ApplicationGatewayTrustedClientCertificate

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	在应用程序网关中唯一的受信任客户端证书的名称。
properties.clientCertIssuerDN	string	客户端证书颁发者的专有名称。
properties.data	string	证书公共数据。
properties.provisioningState	ProvisioningState	受信任的客户端证书资源的预配状态。
properties.validatedCertData	string	经过验证的证书数据。
type	string	资源的类型。

ApplicationGatewayTrustedRootCertificate

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	在应用程序网关中唯一的受信任根证书的名称。
properties.data	string	证书公共数据。
properties.keyVaultSecretId	string	存储在 KeyVault 中的“Secret”或“Certificate”对象的机密 ID（base-64 编码的未加密 pfx）。
properties.provisioningState	ProvisioningState	受信任的根证书资源的预配状态。
type	string	资源的类型。

ApplicationGatewayUrlConfiguration

Object

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

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

ApplicationGatewayUrlPathMap

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的 URL 路径映射的名称。
properties.defaultBackendAddressPool	SubResource	URL路径映射的默认后端地址池资源。
properties.defaultBackendHttpSettings	SubResource	URL 路径映射的默认后端 http 设置资源。
properties.defaultLoadDistributionPolicy	SubResource	URL 路径映射的默认负载分配策略资源。
properties.defaultRedirectConfiguration	SubResource	URL 路径映射的默认重定向配置资源。
properties.defaultRewriteRuleSet	SubResource	URL 路径映射的默认重写规则集资源。
properties.pathRules	ApplicationGatewayPathRule[]	URL 路径映射资源的路径规则。
properties.provisioningState	ProvisioningState	URL 路径映射资源的预配状态。
type	string	资源的类型。

ApplicationGatewayWebApplicationFirewallConfiguration

Object

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

名称	类型	说明
disabledRuleGroups	ApplicationGatewayFirewallDisabledRuleGroup[]	禁用的规则组。
enabled	boolean	是否启用了 Web 应用程序防火墙。
exclusions	ApplicationGatewayFirewallExclusion[]	排除列表。
fileUploadLimitInMb	integer (int32) minimum: 0 exclusiveMinimum: False	WAF 的最大文件上传大小（以 Mb 为单位）。
firewallMode	ApplicationGatewayFirewallMode	Web 应用程序防火墙模式。
maxRequestBodySize	integer (int32) minimum: 8 maximum: 128 exclusiveMinimum: False exclusiveMaximum: False	WAF 的最大请求正文大小。
maxRequestBodySizeInKb	integer (int32) minimum: 8 maximum: 128 exclusiveMinimum: False exclusiveMaximum: False	WAF 的最大请求正文大小（以 Kb 为单位）。
requestBodyCheck	boolean	是否允许 WAF 检查请求正文。
ruleSetType	string	Web 应用程序防火墙规则集的类型。可能的值为：“OWASP”。
ruleSetVersion	string	规则集类型的版本。

ApplicationSecurityGroup

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.provisioningState	ProvisioningState	应用程序安全组资源的预配状态。
properties.resourceGuid	string	应用程序安全组资源的资源 GUID 属性。它唯一标识资源，即使用户更改其名称或跨订阅或资源组迁移资源也是如此。
tags	object	资源标记。
type	string	资源类型。

AutoApproval

Object

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

名称	类型	说明
subscriptions	string[]	订阅列表。

BackendAddressPool

Object

后端 IP 地址池。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	负载均衡器使用的后端地址池集中唯一的资源的名称。此名称可用于访问资源。
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	对网络接口中定义的 IP 地址的引用数组。
properties.drainPeriodInSeconds	integer (int32)	将 RESET 发送到客户端和后端地址之前，负载均衡器等待的秒数。
properties.inboundNatRules	SubResource[]	对使用此后端地址池的入站 NAT 规则的引用数组。
properties.loadBalancerBackendAddresses	LoadBalancerBackendAddress[]	后端地址数组。
properties.loadBalancingRules	SubResource[]	使用此后端地址池的负载均衡规则的引用数组。
properties.location	string	后端地址池的位置。
properties.outboundRule	SubResource	对使用此后端地址池的出站规则的引用。
properties.outboundRules	SubResource[]	对使用此后端地址池的出站规则的引用数组。
properties.provisioningState	ProvisioningState	后端地址池资源的预配状态。
properties.syncMode	SyncMode	后端池的后端地址同步模式
properties.tunnelInterfaces	GatewayLoadBalancerTunnelInterface[]	网关负载均衡器隧道接口的数组。
properties.virtualNetwork	SubResource	对虚拟网络的引用。
type	string	资源的类型。

CloudError

Object

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	云错误正文。

CloudErrorBody

Object

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

CustomDnsConfigPropertiesFormat

Object

包含来自客户的自定义 Dns 分辨率配置。

名称	类型	说明
fqdn	string	解析为专用终结点 IP 地址的 Fqdn。
ipAddresses	string[]	专用终结点的专用 IP 地址列表。

DdosSettings

Object

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

名称	类型	说明
ddosProtectionPlan	SubResource	与公共 IP 关联的 DDoS 保护计划。仅当 ProtectionMode 已启用时才能设置
protectionMode	DdosSettingsProtectionMode	公共 IP 的 DDoS 保护模式

DdosSettingsProtectionMode

枚举

公共 IP 的 DDoS 保护模式

值	说明
VirtualNetworkInherited
Enabled
Disabled

Delegation

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	子网中唯一的资源的名称。此名称可用于访问资源。
properties.actions	string[]	授权后允许服务采取的行动。
properties.provisioningState	ProvisioningState	服务委派资源的预配状态。
properties.serviceName	string	应向其委托子网的服务的名称（例如Microsoft.Sql/servers）。
type	string	资源类型。

DeleteOptions

枚举

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

值	说明
Delete
Detach

ExtendedLocation

Object

ExtendedLocation 复杂类型。

名称	类型	说明
name	string	扩展位置的名称。
type	ExtendedLocationTypes	扩展位置的类型。

ExtendedLocationTypes

枚举

扩展位置的类型。

值	说明
EdgeZone

FlowLog

Object

流日志资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
identity	ManagedServiceIdentity	FlowLog 资源托管标识
location	string	资源位置。
name	string	资源名称。
properties.enabled	boolean	用于启用/禁用流日志记录的标志。
properties.enabledFilteringCriteria	string	可选字段，用于根据 SrcIP、SrcPort、DstIP、DstPort、协议、加密、方向和作过滤网络流量日志。如果未指定，则将记录所有网络流量。
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	定义流量分析配置的参数。
properties.format	FlowLogFormatParameters	定义流日志格式的参数。
properties.provisioningState	ProvisioningState	流日志的预配状态。
properties.retentionPolicy	RetentionPolicyParameters	定义流日志保留策略的参数。
properties.storageId	string	用于存储流日志的存储帐户的 ID。
properties.targetResourceGuid	string	将应用流日志的网络安全组的 Guid。
properties.targetResourceId	string	将向其应用流日志的网络安全组的 ID。
tags	object	资源标记。
type	string	资源类型。

FlowLogFormatParameters

Object

定义流日志格式的参数。

名称	类型	默认值	说明
type	FlowLogFormatType		流日志的文件类型。
version	integer (int32)	0	流日志的版本（修订版）。

FlowLogFormatType

枚举

流日志的文件类型。

值	说明
JSON

FrontendIPConfiguration

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	负载均衡器使用的前端 IP 配置集中唯一的资源的名称。此名称可用于访问资源。
properties.gatewayLoadBalancer	SubResource	对网关负载均衡器前端 IP 的引用。
properties.inboundNatPools	SubResource[]	使用此前端 IP 的入站池的引用数组。
properties.inboundNatRules	SubResource[]	对使用此前端 IP 的入站规则的引用数组。
properties.loadBalancingRules	SubResource[]	使用此前端 IP 的负载平衡规则的引用数组。
properties.outboundRules	SubResource[]	对使用此前端 IP 的出站规则的引用数组。
properties.privateIPAddress	string	IP 配置的专用 IP 地址。
properties.privateIPAddressVersion	IPVersion	特定 ipconfiguration 是 IPv4 还是 IPv6。默认值被视为 IPv4。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 分配方法。
properties.provisioningState	ProvisioningState	前端 IP 配置资源的预配状态。
properties.publicIPAddress	PublicIPAddress	对公共 IP 资源的引用。
properties.publicIPPrefix	SubResource	对公共 IP 前缀资源的引用。
properties.subnet	Subnet	对子网资源的引用。
type	string	资源的类型。
zones	string[]	表示为资源分配的 IP 需要来自的可用性区域列表。

GatewayLoadBalancerTunnelInterface

Object

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

名称	类型	说明
identifier	integer (int32)	网关负载均衡器隧道接口的标识符。
port	integer (int32)	网关负载均衡器隧道接口的端口。
protocol	GatewayLoadBalancerTunnelProtocol	网关负载均衡器隧道接口的协议。
type	GatewayLoadBalancerTunnelInterfaceType	网关负载均衡器隧道接口的流量类型。

GatewayLoadBalancerTunnelInterfaceType

枚举

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

值	说明
None
Internal
External

GatewayLoadBalancerTunnelProtocol

枚举

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

值	说明
None
Native
VXLAN

HeaderValueMatcher

Object

“重写作”下的可选字段。当存在具有相同名称的多个标头时，它允许捕获和修改特定标头的值。当前仅支持 Set-Cookie 响应标头。有关更多详细信息，请访问 https://aka.ms/appgwheadercrud

名称	类型	说明
ignoreCase	boolean	将此参数设置为真值，强制模式进行区分大小写的比较。
negate	boolean	将此值设置为真值将强制检查用户在模式字段中给出的条件的否定。
pattern	string	该模式（固定字符串或正则表达式）用于评估是否应选择标头值进行重写。

InboundNatRule

Object

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	负载均衡器使用的入站 NAT 规则集中唯一的资源的名称。此名称可用于访问资源。
properties.backendAddressPool	SubResource	对 backendAddressPool 资源的引用。
properties.backendIPConfiguration	NetworkInterfaceIPConfiguration	对 VM 网络接口上定义的专用 IP 地址的引用。发送到每个前端 IP 配置的前端端口的流量将转发到后端 IP。
properties.backendPort	integer (int32)	用于内部终结点的端口。可接受值，范围从 1 到 65535。
properties.enableFloatingIP	boolean	为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的终结点。在 SQL Server 中使用 SQL AlwaysOn 可用性组时，需要此设置。创建终结点后，无法更改此设置。
properties.enableTcpReset	boolean	在 TCP 流空闲超时或意外的连接终止时接收双向 TCP 重置。仅当协议设置为 TCP 时，才使用此元素。
properties.frontendIPConfiguration	SubResource	对前端 IP 地址的引用。
properties.frontendPort	integer (int32)	外部终结点的端口。每个规则的端口号在负载均衡器内均必须唯一。可接受值，范围从 1 到 65534。
properties.frontendPortRangeEnd	integer (int32)	外部终结点的端口范围结束。此属性与 BackendAddressPool 和 FrontendPortRangeStart 一起使用。将为 BackendAddressPool 中的每个后端地址创建单个入站 NAT 规则端口映射。可接受值，范围从 1 到 65534。
properties.frontendPortRangeStart	integer (int32)	端口范围从外部终结点开始。此属性与 BackendAddressPool 和 FrontendPortRangeEnd 一起使用。将为 BackendAddressPool 中的每个后端地址创建单个入站 NAT 规则端口映射。可接受值，范围从 1 到 65534。
properties.idleTimeoutInMinutes	integer (int32)	TCP 空闲连接的超时。该值可设置为介于 4 和 30 分钟之间。默认值为 4 分钟。仅当协议设置为 TCP 时，才使用此元素。
properties.protocol	TransportProtocol	对负载均衡规则使用的传输协议的引用。
properties.provisioningState	ProvisioningState	入站 NAT 规则资源的预配状态。
type	string	资源的类型。

IPAllocationMethod

枚举

IP 地址分配方法。

值	说明
Static
Dynamic

IpamPoolPrefixAllocation

Object

IpamPool 前缀分配引用。

名称	类型	说明
allocatedAddressPrefixes	string[]	关联资源的 IpamPool 中分配的 IP 地址前缀列表。
numberOfIpAddresses	string	要分配的 IP 地址数。
pool.id	string (arm-id)	关联的 Azure IpamPool 资源的资源 ID。

IPConfiguration

Object

IP 配置。

名称	类型	默认值	说明
etag	string		一个唯一的只读字符串，每当更新资源时更改。
id	string		资源 ID。
name	string		资源组中唯一的资源的名称。此名称可用于访问资源。
properties.privateIPAddress	string		IP 配置的专用 IP 地址。
properties.privateIPAllocationMethod	IPAllocationMethod	Dynamic	专用 IP 地址分配方法。
properties.provisioningState	ProvisioningState		IP 配置资源的预配状态。
properties.publicIPAddress	PublicIPAddress		对公共 IP 资源的引用。
properties.subnet	Subnet		对子网资源的引用。

IPConfigurationProfile

Object

IP 配置文件子资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源的名称。此名称可用于访问资源。
properties.provisioningState	ProvisioningState	IP 配置文件资源的预配状态。
properties.subnet	Subnet	对子网资源的引用，用于创建容器网络接口 ip 配置。
type	string	子资源类型。

IpTag

Object

包含与对象关联的 IpTag。

名称	类型	说明
ipTagType	string	IP 标记类型。示例：FirstPartyUsage。
tag	string	与公共 IP 关联的 IP 标记的值。示例：SQL。

IPVersion

枚举

IP 地址版本。

值	说明
IPv4
IPv6

LoadBalancerBackendAddress

Object

负载均衡器后端地址。

名称	类型	说明
name	string	后端地址的名称。
properties.adminState	LoadBalancerBackendAddressAdminState	一个管理状态列表，一旦设置即可替代运行状况探测，以便负载均衡器始终将新连接转发到后端，或拒绝新连接并重置现有连接。
properties.inboundNatRulesPortMapping	NatRulePortMapping[]	入站 NAT 规则端口映射的集合。
properties.ipAddress	string	属于所引用虚拟网络的 IP 地址。
properties.loadBalancerFrontendIPConfiguration	SubResource	对区域负载均衡器中定义的前端 IP 地址配置的引用。
properties.networkInterfaceIPConfiguration	SubResource	对网络接口中定义的 IP 地址的引用。
properties.subnet	SubResource	对现有子网的引用。
properties.virtualNetwork	SubResource	对现有虚拟网络的引用。

LoadBalancerBackendAddressAdminState

枚举

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

值	说明
None
Up
Down

ManagedServiceIdentity

Object

资源的标识。

名称	类型	说明
principalId	string	系统分配的标识的主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string	系统分配的标识的租户 ID。此属性仅针对系统分配的标识提供。
type	ResourceIdentityType	用于资源的标识类型。类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机中删除任何标识。
userAssignedIdentities	UserAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

NatGateway

Object

Nat Gateway 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.idleTimeoutInMinutes	integer (int32)	nat 网关的空闲超时。
properties.provisioningState	ProvisioningState	NAT 网关资源的预配状态。
properties.publicIpAddresses	SubResource[]	与 nat 网关资源关联的公有 IP 地址 V4 数组。
properties.publicIpAddressesV6	SubResource[]	与 nat 网关资源关联的公有 IP 地址 V6 数组。
properties.publicIpPrefixes	SubResource[]	与 nat 网关资源关联的公有 IP 前缀 V4 数组。
properties.publicIpPrefixesV6	SubResource[]	与 nat 网关资源关联的公有 IP 前缀 V6 数组。
properties.resourceGuid	string	NAT 网关资源的资源 GUID 属性。
properties.sourceVirtualNetwork	SubResource	使用此 nat 网关资源对源虚拟网络的引用。
properties.subnets	SubResource[]	使用此 nat 网关资源的子网引用数组。
sku	NatGatewaySku	nat 网关 SKU。
tags	object	资源标记。
type	string	资源类型。
zones	string[]	表示应在其中部署 Nat 网关的区域的可用性区域的列表。

NatGatewaySku

Object

nat 网关的 SKU。

名称	类型	说明
name	NatGatewaySkuName	Nat 网关 SKU 的名称。

NatGatewaySkuName

枚举

Nat 网关 SKU 的名称。

值	说明
Standard
StandardV2

NatRulePortMapping

Object

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

名称	类型	说明
backendPort	integer (int32)	后端端口。
frontendPort	integer (int32)	前端端口。
inboundNatRuleName	string	入站 NAT 规则的名称。

NetworkInterface

Object

资源组中的网络接口。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
extendedLocation	ExtendedLocation	网络接口的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	网络接口资源的辅助模式。
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	网络接口资源的辅助 SKU。
properties.defaultOutboundConnectivityEnabled	boolean	是否配置了网卡的默认出站连接。
properties.disableTcpStateTracking	boolean	指示是否禁用 tcp 状态跟踪。
properties.dnsSettings	NetworkInterfaceDnsSettings	网络接口中的 DNS 设置。
properties.dscpConfiguration	SubResource	对网络接口链接到的 dscp 配置的引用。
properties.enableAcceleratedNetworking	boolean	如果将网络接口配置为加速网络。不适用于需要加速网络的 VM 大小。
properties.enableIPForwarding	boolean	指示是否在此网络接口上启用 IP 转发。
properties.hostedWorkloads	string[]	链接的 BareMetal 资源的引用列表。
properties.ipConfigurations	NetworkInterfaceIPConfiguration[]	网络接口的 IPConfiguration 列表。
properties.macAddress	string	网络接口的 MAC 地址。
properties.migrationPhase	NetworkInterfaceMigrationPhase	网络接口资源的迁移阶段。
properties.networkSecurityGroup	NetworkSecurityGroup	对 NetworkSecurityGroup 资源的引用。
properties.nicType	NetworkInterfaceNicType	网络接口资源的类型。
properties.primary	boolean	这是否是虚拟机上的主网络接口。
properties.privateEndpoint	PrivateEndpoint	对网络接口链接到的专用终结点的引用。
properties.privateLinkService	PrivateLinkService	网络接口资源的 Privatelinkservice。
properties.provisioningState	ProvisioningState	网络接口资源的预配状态。
properties.resourceGuid	string	网络接口资源的资源 GUID 属性。
properties.tapConfigurations	NetworkInterfaceTapConfiguration[]	网络接口的 TapConfiguration 列表。
properties.virtualMachine	SubResource	对虚拟机的引用。
properties.vnetEncryptionSupported	boolean	此网卡连接到的虚拟机是否支持加密。
properties.workloadType	string	BareMetal 资源的 NetworkInterface 的 WorkloadType
tags	object	资源标记。
type	string	资源类型。

NetworkInterfaceAuxiliaryMode

枚举

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

值	说明
None
MaxConnections
Floating
AcceleratedConnections

NetworkInterfaceAuxiliarySku

枚举

网络接口资源的辅助 SKU。

值	说明
None
A1
A2
A4
A8

NetworkInterfaceDnsSettings

Object

网络接口的 DNS 设置。

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

Object

IPConfiguration 在网络接口中。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.applicationGatewayBackendAddressPools	ApplicationGatewayBackendAddressPool[]	对 ApplicationGatewayBackendAddressPool 资源的引用。
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	包含 IP 配置的应用程序安全组。
properties.gatewayLoadBalancer	SubResource	对网关负载均衡器前端 IP 的引用。
properties.loadBalancerBackendAddressPools	BackendAddressPool[]	对 LoadBalancerBackendAddressPool 资源的引用。
properties.loadBalancerInboundNatRules	InboundNatRule[]	LoadBalancerInboundNatRules 的引用列表。
properties.primary	boolean	这是否是网络接口上的主要客户地址。
properties.privateIPAddress	string	IP 配置的专用 IP 地址。它可以是单个 IP 地址或格式为 /<prefix-length 的 /prefix-length> 中。
properties.privateIPAddressPrefixLength	integer (int32) minimum: 1 maximum: 128	专用 IP 地址前缀长度。如果指定且分配方法是动态的，则服务将分配 CIDR 块而不是单个 IP 地址。
properties.privateIPAddressVersion	IPVersion	特定 IP 配置是 IPv4 还是 IPv6。默认值为 IPv4。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 地址分配方法。
properties.privateLinkConnectionProperties	NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	PrivateLinkConnection 属性。
properties.provisioningState	ProvisioningState	网络接口 IP 配置的预配状态。
properties.publicIPAddress	PublicIPAddress	绑定到 IP 配置的公共 IP 地址。
properties.subnet	Subnet	绑定到 IP 配置的子网。
properties.virtualNetworkTaps	VirtualNetworkTap[]	对虚拟网络点击的引用。
type	string	资源类型。

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

Object

PrivateLinkConnection 属性。

名称	类型	说明
fqdns	string[]	当前专用链接连接的 FQDN 列表。
groupId	string	当前专用链接连接的组 ID。
requiredMemberName	string	当前专用链接连接所需的成员名称。

NetworkInterfaceMigrationPhase

枚举

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

值	说明
None
Prepare
Commit
Abort
Committed

NetworkInterfaceNicType

枚举

网络接口资源的类型。

值	说明
Standard
Elastic

NetworkInterfaceTapConfiguration

Object

点击网络接口中的配置。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.provisioningState	ProvisioningState	网络接口分流器配置资源的预配状态。
properties.virtualNetworkTap	VirtualNetworkTap	对虚拟网络分流器资源的引用。
type	string	子资源类型。

NetworkSecurityGroup

Object

NetworkSecurityGroup 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.defaultSecurityRules	SecurityRule[]	网络安全组的默认安全规则。
properties.flowLogs	FlowLog[]	流日志资源的引用集合。
properties.flushConnection	boolean	启用后，当规则更新时，将从网络安全组连接创建的流重新评估。初始启用将触发重新评估。
properties.networkInterfaces	NetworkInterface[]	对网络接口的引用的集合。
properties.provisioningState	ProvisioningState	网络安全组资源的预配状态。
properties.resourceGuid	string	网络安全组资源的资源 GUID 属性。
properties.securityRules	SecurityRule[]	网络安全组的安全规则集合。
properties.subnets	Subnet[]	对子网的引用的集合。
tags	object	资源标记。
type	string	资源类型。

PrivateEndpoint

Object

专用终结点资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
extendedLocation	ExtendedLocation	负载均衡器的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	包含专用终结点 IP 配置的应用程序安全组。
properties.customDnsConfigs	CustomDnsConfigPropertiesFormat[]	自定义 DNS 配置的数组。
properties.customNetworkInterfaceName	string	附加到专用终结点的网络接口的自定义名称。
properties.ipConfigurations	PrivateEndpointIPConfiguration[]	专用终结点的 IP 配置列表。这将用于映射到第一方服务的终结点。
properties.manualPrivateLinkServiceConnections	PrivateLinkServiceConnection[]	有关与远程资源的连接的信息的分组。当网络管理员无权批准与远程资源的连接时使用。
properties.networkInterfaces	NetworkInterface[]	为此专用终结点创建的网络接口的引用数组。
properties.privateLinkServiceConnections	PrivateLinkServiceConnection[]	有关与远程资源的连接的信息的分组。
properties.provisioningState	ProvisioningState	专用终结点资源的预配状态。
properties.subnet	Subnet	将从中分配专用 IP 的子网的 ID。
tags	object	资源标记。
type	string	资源类型。

PrivateEndpointConnection

Object

PrivateEndpointConnection 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.linkIdentifier	string	使用者链路 ID。
properties.privateEndpoint	PrivateEndpoint	专用终结点的资源。
properties.privateEndpointLocation	string	专用终结点的位置。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
properties.provisioningState	ProvisioningState	专用终结点连接资源的预配状态。
type	string	资源类型。

PrivateEndpointIPConfiguration

Object

专用终结点的 IP 配置。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
name	string	资源组中唯一的资源的名称。
properties.groupId	string	从此专用终结点应连接到的远程资源获取的组的 ID。
properties.memberName	string	从此专用终结点应连接到的远程资源获取的组的成员名称。
properties.privateIPAddress	string	从专用终结点的子网获取的专用 IP 地址。
type	string	资源类型。

PrivateLinkService

Object

专用链接服务资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
extendedLocation	ExtendedLocation	负载均衡器的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.alias	string	专用链接服务的别名。
properties.autoApproval	AutoApproval	专用链接服务的自动审批列表。
properties.destinationIPAddress	string	专用链接服务的目标 IP 地址。
properties.enableProxyProtocol	boolean	是否为代理协议启用了专用链接服务。
properties.fqdns	string[]	Fqdn 的列表。
properties.ipConfigurations	PrivateLinkServiceIpConfiguration[]	专用链接服务 IP 配置的数组。
properties.loadBalancerFrontendIpConfigurations	FrontendIPConfiguration[]	对负载均衡器 IP 配置的引用数组。
properties.networkInterfaces	NetworkInterface[]	为此专用链接服务创建的对网络接口的引用数组。
properties.privateEndpointConnections	PrivateEndpointConnection[]	有关与专用终结点的连接的列表数组。
properties.provisioningState	ProvisioningState	专用链接服务资源的预配状态。
properties.visibility	Visibility	专用链接服务的可见性列表。
tags	object	资源标记。
type	string	资源类型。

PrivateLinkServiceConnection

Object

PrivateLinkServiceConnection 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.groupIds	string[]	从此专用终结点应连接到的远程资源获取的组的 ID（s）。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关与远程资源的连接状态的只读信息的集合。
properties.privateLinkServiceId	string	专用链接服务的资源 ID。
properties.provisioningState	ProvisioningState	专用链接服务连接资源的预配状态。
properties.requestMessage	string	使用此连接请求传递给远程资源的所有者的消息。限制为 140 个字符。
type	string	资源类型。

PrivateLinkServiceConnectionState

Object

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

名称	类型	说明
actionsRequired	string	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准/拒绝连接的原因。
status	string	指示连接是否已被服务的所有者批准/拒绝/删除。

PrivateLinkServiceIpConfiguration

Object

专用链接服务 ip 配置。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	专用链接服务 IP 配置的名称。
properties.primary	boolean	IP 配置是否为主要配置。
properties.privateIPAddress	string	IP 配置的专用 IP 地址。
properties.privateIPAddressVersion	IPVersion	特定 IP 配置是 IPv4 还是 IPv6。默认值为 IPv4。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 地址分配方法。
properties.provisioningState	ProvisioningState	专用链接服务 IP 配置资源的预配状态。
properties.subnet	Subnet	对子网资源的引用。
type	string	资源类型。

ProvisioningState

枚举

当前预配状态。

值	说明
Succeeded
Updating
Deleting
Failed

PublicIPAddress

Object

公共 IP 地址资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
extendedLocation	ExtendedLocation	公共 IP 地址的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.ddosSettings	DdosSettings	与公共 IP 地址关联的 DDoS 保护自定义策略。
properties.deleteOption	DeleteOptions	指定删除 VM 时公共 IP 地址会发生什么情况
properties.dnsSettings	PublicIPAddressDnsSettings	与公共 IP 地址关联的 DNS 记录的 FQDN。
properties.idleTimeoutInMinutes	integer (int32)	公共 IP 地址的空闲超时。
properties.ipAddress	string	与公共 IP 地址资源关联的 IP 地址。
properties.ipConfiguration	IPConfiguration	与公共 IP 地址关联的 IP 配置。
properties.ipTags	IpTag[]	与公共 IP 地址关联的标记列表。
properties.linkedPublicIPAddress	PublicIPAddress	公共 IP 地址资源的链接公共 IP 地址。
properties.migrationPhase	PublicIPAddressMigrationPhase	公共 IP 地址的迁移阶段。
properties.natGateway	NatGateway	公共 IP 地址的 NatGateway。
properties.provisioningState	ProvisioningState	公共 IP 地址资源的预配状态。
properties.publicIPAddressVersion	IPVersion	公共 IP 地址版本。
properties.publicIPAllocationMethod	IPAllocationMethod	公共 IP 地址分配方法。
properties.publicIPPrefix	SubResource	应从中分配此公共 IP 地址的公共 IP 前缀。
properties.resourceGuid	string	公共 IP 地址资源的资源 GUID 属性。
properties.servicePublicIPAddress	PublicIPAddress	公共 IP 地址资源的服务公共 IP 地址。
sku	PublicIPAddressSku	公共 IP 地址 SKU。
tags	object	资源标记。
type	string	资源类型。
zones	string[]	表示为资源分配的 IP 需要来自的可用性区域列表。

PublicIPAddressDnsSettings

Object

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

名称	类型	说明
domainNameLabel	string	域名标签。域名标签和区域化 DNS 区域的串联构成了与公共 IP 地址关联的完全限定域名。如果指定了域名标签，则会为 Microsoft Azure DNS 系统中的公共 IP 创建 A DNS 记录。
domainNameLabelScope	PublicIpAddressDnsSettingsDomainNameLabelScope	域名标签范围。如果指定了域名标签和域名标签范围，则会为 Microsoft Azure DNS 系统中的公共 IP 创建一条 DNS 记录，其中包含 FQDN 中的哈希值。
fqdn	string	与公共 IP 关联的 A DNS 记录的完全限定域名。这是 domainNameLabel 和区域化 DNS 区域的串联。
reverseFqdn	string	反向 FQDN。解析为此公共 IP 地址的用户可见完全限定域名。如果指定了 reverseFqdn，则会创建 PTR DNS 记录，该记录从 in-addr.arpa 域中的 IP 地址指向反向 FQDN。

PublicIpAddressDnsSettingsDomainNameLabelScope

枚举

域名标签范围。如果指定了域名标签和域名标签范围，则会为 Microsoft Azure DNS 系统中的公共 IP 创建一条 DNS 记录，其中包含 FQDN 中的哈希值。

值	说明
TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

PublicIPAddressMigrationPhase

枚举

公共 IP 地址的迁移阶段。

值	说明
None
Prepare
Commit
Abort
Committed

PublicIPAddressSku

Object

公共 IP 地址的 SKU。

名称	类型	说明
name	PublicIPAddressSkuName	公共 IP 地址 SKU 的名称。
tier	PublicIPAddressSkuTier	公共 IP 地址 SKU 的层。

PublicIPAddressSkuName

枚举

公共 IP 地址 SKU 的名称。

值	说明
Basic
Standard
StandardV2

PublicIPAddressSkuTier

枚举

公共 IP 地址 SKU 的层。

值	说明
Regional
Global

ResourceIdentityType

枚举

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

值	说明
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ResourceNavigationLink

Object

ResourceNavigationLink 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源导航链接标识符。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.link	string	链接到外部资源。
properties.linkedResourceType	string	链接资源的资源类型。
properties.provisioningState	ProvisioningState	资源导航链接资源的预配状态。
type	string	资源类型。

RetentionPolicyParameters

Object

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

名称	类型	默认值	说明
days	integer (int32)	0	保留流日志记录的天数。
enabled	boolean	False	用于启用/禁用保留的标志。

Route

Object

路由资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.addressPrefix	string	路由应用到的目标 CIDR。
properties.hasBgpOverride	boolean	一个值，指示此路由是否覆盖重叠的 BGP 路由，而不管 LPM 如何。
properties.nextHopIpAddress	string	数据包应转发到的 IP 地址。只有在下一跃点类型为 VirtualAppliance 的路由中才允许下一跃点值。
properties.nextHopType	RouteNextHopType	应将数据包发送到的 Azure 跃点的类型。
properties.provisioningState	ProvisioningState	路由资源的预配状态。
type	string	资源类型。

RouteNextHopType

枚举

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

值	说明
VirtualNetworkGateway
VnetLocal
Internet
VirtualAppliance
None

RouteTable

Object

路由表资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.disableBgpRoutePropagation	boolean	是否禁用 BGP 在该路由表上学习的路由。 True 表示禁用。
properties.provisioningState	ProvisioningState	路由表资源的预置状态。
properties.resourceGuid	string	路由表的资源 GUID 属性。
properties.routes	Route[]	路由表中包含的路由的集合。
properties.subnets	Subnet[]	对子网的引用的集合。
tags	object	资源标记。
type	string	资源类型。

SecurityRule

Object

网络安全规则。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.access	SecurityRuleAccess	允许或拒绝网络流量。
properties.description	string	此规则的说明。限制为 140 个字符。
properties.destinationAddressPrefix	string	目标地址前缀。 CIDR 或目标 IP 范围。星号“*”还可用于匹配所有源 IP。也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。
properties.destinationAddressPrefixes	string[]	目标地址前缀。 CIDR 或目标 IP 范围。
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	指定为目标的应用程序安全组。
properties.destinationPortRange	string	目标端口或范围。介于 0 和 65535 之间的整数或范围。星号“*”也可用于匹配所有端口。
properties.destinationPortRanges	string[]	目标端口范围。
properties.direction	SecurityRuleDirection	规则的方向。该方向指定在传入或传出流量上是否评估规则。
properties.priority	integer (int32)	规则的优先级。该值可以介于 100 和 4096 之间。对于集合中的每个规则，优先级编号必须是唯一的。优先级编号越低，规则优先级越高。
properties.protocol	SecurityRuleProtocol	此规则适用于的网络协议。
properties.provisioningState	ProvisioningState	安全规则资源的预配状态。
properties.sourceAddressPrefix	string	CIDR 或源 IP 范围。星号“*”还可用于匹配所有源 IP。也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。如果这是入口规则，则指定网络流量的来源。
properties.sourceAddressPrefixes	string[]	CIDR 或源 IP 范围。
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	指定为源的应用程序安全组。
properties.sourcePortRange	string	源端口或范围。介于 0 和 65535 之间的整数或范围。星号“*”也可用于匹配所有端口。
properties.sourcePortRanges	string[]	源端口范围。
type	string	资源类型。

SecurityRuleAccess

枚举

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

值	说明
Allow
Deny

SecurityRuleDirection

枚举

规则的方向。该方向指定在传入或传出流量上是否评估规则。

值	说明
Inbound
Outbound

SecurityRuleProtocol

枚举

此规则适用于的网络协议。

值	说明
Tcp
Udp
Icmp
Esp
*
Ah

ServiceAssociationLink

Object

ServiceAssociationLink 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.allowDelete	boolean	如果为 true，则可以删除资源。
properties.link	string	链接到外部资源。
properties.linkedResourceType	string	链接资源的资源类型。
properties.locations	string[]	位置列表。
properties.provisioningState	ProvisioningState	服务关联链接资源的预配状态。
type	string	资源类型。

ServiceEndpointPolicy

Object

服务终结点策略资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
kind	string	服务终结点策略的种类。这是用于 Azure 门户体验的元数据。
location	string	资源位置。
name	string	资源名称。
properties.contextualServiceEndpointPolicies	string[]	上下文服务终结点策略的集合。
properties.provisioningState	ProvisioningState	服务终结点策略资源的预配状态。
properties.resourceGuid	string	服务终结点策略资源的资源 GUID 属性。
properties.serviceAlias	string	指示策略是否属于服务的别名
properties.serviceEndpointPolicyDefinitions	ServiceEndpointPolicyDefinition[]	服务终结点策略的服务终结点策略定义的集合。
properties.subnets	Subnet[]	对子网的引用的集合。
tags	object	资源标记。
type	string	资源类型。

ServiceEndpointPolicyDefinition

Object

服务终结点策略定义。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.description	string	此规则的说明。限制为 140 个字符。
properties.provisioningState	ProvisioningState	服务终结点策略定义资源的预配状态。
properties.service	string	服务终结点名称。
properties.serviceResources	string[]	服务资源列表。
type	string	资源类型。

ServiceEndpointPropertiesFormat

Object

服务终结点属性。

名称	类型	说明
locations	string[]	位置列表。
networkIdentifier	SubResource	SubResource 作为网络标识符。
provisioningState	ProvisioningState	服务终结点资源的预配状态。
service	string	终结点服务的类型。

SharingScope

枚举

将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。

值	说明
Tenant
DelegatedServices

Subnet

Object

虚拟网络资源中的子网。

名称	类型	默认值	说明
etag	string		一个唯一的只读字符串，每当更新资源时更改。
id	string		资源 ID。
name	string		资源组中唯一的资源的名称。此名称可用于访问资源。
properties.addressPrefix	string		子网的地址前缀。
properties.addressPrefixes	string[]		子网的地址前缀列表。
properties.applicationGatewayIPConfigurations	ApplicationGatewayIPConfiguration[]		虚拟网络资源的应用程序网关 IP 配置。
properties.defaultOutboundAccess	boolean		将此属性设置为 false，以禁用子网中所有 VM 的默认出站连接。此属性只能在创建子网时设置，并且不能为现有子网更新。
properties.delegations	Delegation[]		对子网上的委派的引用数组。
properties.ipAllocations	SubResource[]		引用此子网的 IpAllocation 数组。
properties.ipConfigurationProfiles	IPConfigurationProfile[]		引用此子网的 IP 配置文件数组。
properties.ipConfigurations	IPConfiguration[]		使用子网对网络接口 IP 配置的引用数组。
properties.ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]		用于分配 IP 地址前缀的 IPAM 池列表。
properties.natGateway	SubResource		与此子网关联的 Nat 网关。
properties.networkSecurityGroup	NetworkSecurityGroup		对 NetworkSecurityGroup 资源的引用。
properties.privateEndpointNetworkPolicies	VirtualNetworkPrivateEndpointNetworkPolicies	Disabled	在子网中的专用终结点上启用或禁用应用网络策略。
properties.privateEndpoints	PrivateEndpoint[]		对专用终结点的引用数组。
properties.privateLinkServiceNetworkPolicies	VirtualNetworkPrivateLinkServiceNetworkPolicies	Enabled	在子网中的专用链接服务上启用或禁用应用网络策略。
properties.provisioningState	ProvisioningState		子网资源的预配状态。
properties.purpose	string		一个只读字符串，根据委派和其他用户定义的属性标识此子网的使用意图。
properties.resourceNavigationLinks	ResourceNavigationLink[]		使用子网引用外部资源的数组。
properties.routeTable	RouteTable		对 RouteTable 资源的引用。
properties.serviceAssociationLinks	ServiceAssociationLink[]		对注入此子网的服务的引用数组。
properties.serviceEndpointPolicies	ServiceEndpointPolicy[]		服务终结点策略数组。
properties.serviceEndpoints	ServiceEndpointPropertiesFormat[]		服务终结点数组。
properties.sharingScope	SharingScope		将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。
type	string		资源类型。

SubResource

Object

对另一个子资源的引用。

名称	类型	说明
id	string	资源 ID。

SyncMode

枚举

后端池的后端地址同步模式

值	说明
Automatic
Manual

TrafficAnalyticsConfigurationProperties

Object

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

名称	类型	说明
enabled	boolean	标记以启用/禁用流量分析。
trafficAnalyticsInterval	integer (int32)	以分钟为单位的时间间隔，决定 TA 服务应执行流分析的频率。
workspaceId	string	附加工作区的资源 guid。
workspaceRegion	string	附加工作区的位置。
workspaceResourceId	string	附加工作区的资源 ID。

TrafficAnalyticsProperties

Object

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

名称	类型	说明
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	定义流量分析配置的参数。

TransportProtocol

枚举

终结点的传输协议。

值	说明
Udp
Tcp
All
Quic

UserAssignedIdentities

Object

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

名称	类型	说明

VirtualNetworkPrivateEndpointNetworkPolicies

枚举

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

值	说明
Enabled
Disabled
NetworkSecurityGroupEnabled
RouteTableEnabled

VirtualNetworkPrivateLinkServiceNetworkPolicies

枚举

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

值	说明
Enabled
Disabled

VirtualNetworkTap

Object

虚拟网络 Tap 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.destinationLoadBalancerFrontEndIPConfiguration	FrontendIPConfiguration	对内部负载均衡器上将接收点击的专用 IP 地址的引用。
properties.destinationNetworkInterfaceIPConfiguration	NetworkInterfaceIPConfiguration	对将接收点击的收集器 nic 的专用 IP 地址的引用。
properties.destinationPort	integer	将接收点击流量的 VXLAN 目标端口。
properties.networkInterfaceTapConfigurations	NetworkInterfaceTapConfiguration[]	指定需要分机的网络接口 IP 配置的资源 ID 列表。
properties.provisioningState	ProvisioningState	虚拟网络分流器资源的预配状态。
properties.resourceGuid	string	虚拟网络分流器资源的资源 GUID 属性。
tags	object	资源标记。
type	string	资源类型。

Visibility

Object

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

名称	类型	说明
subscriptions	string[]	订阅列表。

通过

Application Gateways - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Create Application Gateway

示例请求

示例响应

定义

ApplicationGateway

ApplicationGatewayAuthenticationCertificate

ApplicationGatewayAutoscaleConfiguration

ApplicationGatewayBackendAddress

ApplicationGatewayBackendAddressPool

ApplicationGatewayBackendHttpSettings

ApplicationGatewayBackendSettings

ApplicationGatewayClientAuthConfiguration

ApplicationGatewayClientRevocationOptions

ApplicationGatewayConnectionDraining

ApplicationGatewayCookieBasedAffinity

ApplicationGatewayCustomError

ApplicationGatewayCustomErrorStatusCode

ApplicationGatewayFirewallDisabledRuleGroup

ApplicationGatewayFirewallExclusion

ApplicationGatewayFirewallMode

ApplicationGatewayFrontendIPConfiguration

ApplicationGatewayFrontendPort

ApplicationGatewayGlobalConfiguration

ApplicationGatewayHeaderConfiguration

ApplicationGatewayHttpListener

ApplicationGatewayIPConfiguration

ApplicationGatewayListener

ApplicationGatewayLoadDistributionAlgorithm

ApplicationGatewayLoadDistributionPolicy

ApplicationGatewayLoadDistributionTarget

ApplicationGatewayOperationalState

ApplicationGatewayPathRule

ApplicationGatewayPrivateEndpointConnection

ApplicationGatewayPrivateLinkConfiguration

ApplicationGatewayPrivateLinkIpConfiguration

ApplicationGatewayProbe

ApplicationGatewayProbeHealthResponseMatch

ApplicationGatewayProtocol

ApplicationGatewayRedirectConfiguration

ApplicationGatewayRedirectType

ApplicationGatewayRequestRoutingRule

ApplicationGatewayRequestRoutingRuleType

ApplicationGatewayRewriteRule

ApplicationGatewayRewriteRuleActionSet

ApplicationGatewayRewriteRuleCondition

ApplicationGatewayRewriteRuleSet

ApplicationGatewayRoutingRule

ApplicationGatewaySku

ApplicationGatewaySkuFamily

ApplicationGatewaySkuName

ApplicationGatewaySslCertificate

ApplicationGatewaySslCipherSuite

ApplicationGatewaySslPolicy

ApplicationGatewaySslPolicyName

ApplicationGatewaySslPolicyType

ApplicationGatewaySslProfile

ApplicationGatewaySslProtocol

ApplicationGatewayTier

ApplicationGatewayTrustedClientCertificate

ApplicationGatewayTrustedRootCertificate

ApplicationGatewayUrlConfiguration

ApplicationGatewayUrlPathMap

ApplicationGatewayWebApplicationFirewallConfiguration

ApplicationSecurityGroup

AutoApproval

BackendAddressPool

CloudError

CloudErrorBody

CustomDnsConfigPropertiesFormat

DdosSettings

DdosSettingsProtectionMode