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

Front Doors - Create Or Update

Service:

Front Door Service

API Version:

2019-05-01

在指定的订阅和资源组下创建具有 Front Door 名称的新 Front Door。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}?api-version=2019-05-01

URI 参数

名称	在	必需	类型	说明
frontDoorName	path	True	string	全局唯一的 Front Door 的名称。 Regex pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$
resourceGroupName	path	True	string	Azure 订阅中资源组的名称。 Regex pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
subscriptionId	path	True	string	可以唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
location	string	资源位置。
properties.backendPools	BackendPool[]	可用于路由规则的后端池。
properties.backendPoolsSettings	BackendPoolsSettings	所有 backendPools 的设置
properties.enabledState	FrontDoorEnabledState	Front Door 负载均衡器的运行状态。 允许的值为“Enabled”或“Disabled”
properties.friendlyName	string	frontDoor 的友好名称
properties.frontendEndpoints	FrontendEndpoint[]	可用于路由规则的前端终结点。
properties.healthProbeSettings	HealthProbeSettingsModel[]	与此 Front Door 实例关联的运行状况探测设置。
properties.loadBalancingSettings	LoadBalancingSettingsModel[]	与此 Front Door 实例关联的负载均衡设置。
properties.routingRules	RoutingRule[]	与此 Front Door 关联的路由规则。
tags	object	资源标记。

响应

名称	类型	说明
200 OK	FrontDoor	没问题。 请求已成功。
201 Created	FrontDoor	Created. 请求已满足，并已创建新的 Front Door。
202 Accepted	FrontDoor	已接受。 已接受请求进行处理，操作将以异步方式完成。
Other Status Codes	ErrorResponse	描述操作失败原因的 Front Door 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Create or update specific Front Door

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1?api-version=2019-05-01

{
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "routingRules": [
      {
        "name": "routingRule1",
        "properties": {
          "frontendEndpoints": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default"
            }
          ],
          "acceptedProtocols": [
            "Http"
          ],
          "patternsToMatch": [
            "/*"
          ],
          "routeConfiguration": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
            "backendPool": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
            }
          },
          "enabledState": "Enabled"
        }
      }
    ],
    "healthProbeSettings": [
      {
        "name": "healthProbeSettings1",
        "properties": {
          "path": "/",
          "protocol": "Http",
          "intervalInSeconds": 120,
          "enabledState": "Enabled",
          "healthProbeMethod": "HEAD"
        }
      }
    ],
    "loadBalancingSettings": [
      {
        "name": "loadBalancingSettings1",
        "properties": {
          "sampleSize": 4,
          "successfulSamplesRequired": 2
        }
      }
    ],
    "backendPools": [
      {
        "name": "backendPool1",
        "properties": {
          "backends": [
            {
              "address": "w3.contoso.com",
              "httpPort": 80,
              "httpsPort": 443,
              "weight": 1,
              "priority": 2
            },
            {
              "address": "contoso.com.website-us-west-2.othercloud.net",
              "httpPort": 80,
              "httpsPort": 443,
              "weight": 2,
              "priority": 1
            },
            {
              "address": "contoso1.azurewebsites.net",
              "httpPort": 80,
              "httpsPort": 443,
              "weight": 1,
              "priority": 1
            }
          ],
          "loadBalancingSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1"
          },
          "healthProbeSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1"
          }
        }
      }
    ],
    "frontendEndpoints": [
      {
        "name": "frontendEndpoint1",
        "properties": {
          "hostName": "www.contoso.com",
          "sessionAffinityEnabledState": "Enabled",
          "sessionAffinityTtlSeconds": 60,
          "webApplicationFirewallPolicyLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
          }
        }
      },
      {
        "name": "default",
        "properties": {
          "hostName": "frontDoor1.azurefd.net"
        }
      }
    ],
    "backendPoolsSettings": {
      "enforceCertificateNameCheck": "Enabled",
      "sendRecvTimeoutSeconds": 60
    },
    "enabledState": "Enabled"
  }
}

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1",
  "name": "frontDoor1",
  "type": "Microsoft.Network/frontDoor",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "routingRules": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1",
        "name": "routingRule1",
        "properties": {
          "frontendEndpoints": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default"
            }
          ],
          "acceptedProtocols": [
            "Http"
          ],
          "patternsToMatch": [
            "/*"
          ],
          "routeConfiguration": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
            "customForwardingPath": "",
            "forwardingProtocol": "MatchRequest",
            "backendPool": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
            }
          },
          "enabledState": "Enabled"
        }
      }
    ],
    "healthProbeSettings": [
      {
        "name": "healthProbeSettings1",
        "properties": {
          "path": "/",
          "protocol": "Http",
          "intervalInSeconds": 120,
          "enabledState": "Enabled",
          "healthProbeMethod": "HEAD"
        }
      }
    ],
    "loadBalancingSettings": [
      {
        "name": "loadBalancingSettings1",
        "properties": {
          "sampleSize": 4,
          "successfulSamplesRequired": 2
        }
      }
    ],
    "backendPools": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
        "name": "backendPool1",
        "properties": {
          "backends": [
            {
              "address": "w3.contoso.com",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 2
            },
            {
              "address": "contoso.com.website-us-west-2.othercloud.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 2,
              "priority": 1
            },
            {
              "address": "contoso1.azurewebsites.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 1
            }
          ],
          "loadBalancingSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1"
          },
          "healthProbeSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1"
          }
        }
      }
    ],
    "frontendEndpoints": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1",
        "name": "frontendEndpoint1",
        "properties": {
          "hostName": "www.contoso.com",
          "sessionAffinityEnabledState": "Enabled",
          "sessionAffinityTtlSeconds": 60,
          "webApplicationFirewallPolicyLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
          }
        }
      },
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default",
        "name": "default",
        "properties": {
          "hostName": "frontDoor1.azurefd.net"
        }
      }
    ],
    "backendPoolsSettings": {
      "enforceCertificateNameCheck": "Enabled",
      "sendRecvTimeoutSeconds": 60
    },
    "enabledState": "Enabled",
    "resourceState": "Creating",
    "provisioningState": "Succeeded",
    "cname": "frontDoor1.azurefd.net"
  }
}

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1",
  "name": "frontDoor1",
  "type": "Microsoft.Network/frontDoor",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "routingRules": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1",
        "name": "routingRule1",
        "properties": {
          "frontendEndpoints": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default"
            }
          ],
          "acceptedProtocols": [
            "Http"
          ],
          "patternsToMatch": [
            "/*"
          ],
          "routeConfiguration": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
            "customForwardingPath": "",
            "forwardingProtocol": "MatchRequest",
            "backendPool": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
            }
          },
          "enabledState": "Enabled"
        }
      }
    ],
    "healthProbeSettings": [
      {
        "name": "healthProbeSettings1",
        "properties": {
          "path": "/",
          "protocol": "Http",
          "intervalInSeconds": 120,
          "enabledState": "Enabled",
          "healthProbeMethod": "HEAD"
        }
      }
    ],
    "loadBalancingSettings": [
      {
        "name": "loadBalancingSettings1",
        "properties": {
          "sampleSize": 4,
          "successfulSamplesRequired": 2
        }
      }
    ],
    "backendPools": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
        "name": "backendPool1",
        "properties": {
          "backends": [
            {
              "address": "w3.contoso.com",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 2
            },
            {
              "address": "contoso.com.website-us-west-2.othercloud.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 2,
              "priority": 1
            },
            {
              "address": "contoso1.azurewebsites.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 1
            }
          ],
          "loadBalancingSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1"
          },
          "healthProbeSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1"
          }
        }
      }
    ],
    "frontendEndpoints": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1",
        "name": "frontendEndpoint1",
        "properties": {
          "hostName": "www.contoso.com",
          "sessionAffinityEnabledState": "Enabled",
          "sessionAffinityTtlSeconds": 60,
          "webApplicationFirewallPolicyLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
          }
        }
      },
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default",
        "name": "default",
        "properties": {
          "hostName": "frontDoor1.azurefd.net"
        }
      }
    ],
    "backendPoolsSettings": {
      "enforceCertificateNameCheck": "Enabled",
      "sendRecvTimeoutSeconds": 60
    },
    "enabledState": "Enabled",
    "resourceState": "Creating",
    "provisioningState": "Provisioning",
    "cname": "frontDoor1.azurefd.net"
  }
}

Status code:

202

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1",
  "name": "frontDoor1",
  "type": "Microsoft.Network/frontDoor",
  "location": "westus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "routingRules": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1",
        "name": "routingRule1",
        "properties": {
          "frontendEndpoints": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default"
            }
          ],
          "acceptedProtocols": [
            "Http"
          ],
          "patternsToMatch": [
            "/*"
          ],
          "routeConfiguration": {
            "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
            "customForwardingPath": "",
            "forwardingProtocol": "MatchRequest",
            "backendPool": {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1"
            }
          },
          "enabledState": "Enabled"
        }
      }
    ],
    "healthProbeSettings": [
      {
        "name": "healthProbeSettings1",
        "properties": {
          "path": "/",
          "protocol": "Http",
          "intervalInSeconds": 120,
          "enabledState": "Enabled",
          "healthProbeMethod": "HEAD"
        }
      }
    ],
    "loadBalancingSettings": [
      {
        "name": "loadBalancingSettings1",
        "properties": {
          "sampleSize": 4,
          "successfulSamplesRequired": 2
        }
      }
    ],
    "backendPools": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
        "name": "backendPool1",
        "properties": {
          "backends": [
            {
              "address": "w3.contoso.com",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 2
            },
            {
              "address": "contoso.com.website-us-west-2.othercloud.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 2,
              "priority": 1
            },
            {
              "address": "contoso1.azurewebsites.net",
              "httpPort": 80,
              "httpsPort": 443,
              "enabledState": "Enabled",
              "weight": 1,
              "priority": 1
            }
          ],
          "loadBalancingSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1"
          },
          "healthProbeSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1"
          }
        }
      }
    ],
    "frontendEndpoints": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1",
        "name": "frontendEndpoint1",
        "properties": {
          "hostName": "www.contoso.com",
          "sessionAffinityEnabledState": "Enabled",
          "sessionAffinityTtlSeconds": 60,
          "webApplicationFirewallPolicyLink": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
          }
        }
      },
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default",
        "name": "default",
        "properties": {
          "hostName": "frontDoor1.azurefd.net"
        }
      }
    ],
    "backendPoolsSettings": {
      "enforceCertificateNameCheck": "Enabled",
      "sendRecvTimeoutSeconds": 60
    },
    "enabledState": "Enabled",
    "resourceState": "Creating",
    "provisioningState": "Provisioning",
    "cname": "frontDoor1.azurefd.net"
  }
}

定义

名称	说明
Backend	frontDoor 负载均衡器的后端地址。
backendEnabledState	是否要启用此后端。 允许的值为“Enabled”或“Disabled”
BackendPool	后端池是可以路由到的后端的集合。
BackendPoolsSettings	应用于所有后端池的设置。
CacheConfiguration	缓存类型路由的缓存设置。 若要禁用缓存，请不要提供 cacheConfiguration 对象。
CustomHttpsConfiguration	域的 Https 设置
CustomHttpsProvisioningState	frontendEndpoint 的自定义 Https 的预配状态。
CustomHttpsProvisioningSubstate	预配子状态显示逐步启用/禁用自定义 HTTPS 过程的进度。
DynamicCompressionEnabled	是否对缓存的内容使用动态压缩
enforceCertificateNameCheckEnabledState	是否对对所有后端池的 HTTPS 请求强制执行证书名称检查。 对非 HTTPS 请求没有影响。
ErrorResponse	错误响应指示 Front Door 服务无法处理传入请求。 错误消息中提供了原因。
ForwardingConfiguration	介绍转发路由。
FrontDoor	Front Door 表示将流量路由到的后端终结点的集合，以及指定流量发送到那里的规则。
FrontDoorCertificateSource	定义 SSL 证书的源
FrontDoorCertificateType	定义用于安全连接到 frontendEndpoint 的证书类型
FrontDoorEnabledState	Front Door 负载均衡器的运行状态。 允许的值为“Enabled”或“Disabled”
FrontDoorForwardingProtocol	将流量转发到后端时此规则将使用的协议。
FrontDoorHealthProbeMethod	配置用于探测 backendPools 下定义的后端的 HTTP 方法。
FrontDoorProtocol	要与此规则匹配的协议方案
FrontDoorQuery	形成缓存密钥时的 URL 查询词的处理。
FrontDoorRedirectProtocol	流量重定向到的目标协议
FrontDoorRedirectType	重定向流量时规则将使用的重定向类型。
FrontDoorResourceState	Front Door 或 Front Door 子资源的资源状态。
FrontDoorTlsProtocolType	定义用于安全传递的 TLS 扩展协议
FrontendEndpoint	用于路由的前端终结点。
HealthProbeEnabled	是否对 backendPools 下定义的后端启用运行状况探测。 仅当单个已启用的后端池中有一个已启用的后端时，才能禁用运行状况探测。
HealthProbeSettingsModel	后端池的负载均衡设置
LoadBalancingSettingsModel	后端池的负载均衡设置
MinimumTLSVersion	客户端与 Front Door 建立 SSL 握手所需的最低 TLS 版本。
RedirectConfiguration	描述重定向路由。
RoutingRule	路由规则表示要处理的流量的规范、发送位置以及运行状况探测信息。
routingRuleEnabledState	是否要启用此规则。 允许的值为“Enabled”或“Disabled”
SessionAffinityEnabledState	是否允许此主机上的会话相关性。 有效选项为“Enabled”或“Disabled”
SubResource	对另一个子资源的引用。
Vault	包含 SSL 证书的 Key Vault
WebApplicationFirewallPolicyLink	为每个主机 (定义Web 应用程序防火墙策略（如果适用)

Backend

frontDoor 负载均衡器的后端地址。

名称	类型	说明
address	string	后端的位置（IP 地址或 FQDN）
backendHostHeader	string	要用作发送到后端的主机标头的值。 如果为空或未指定，则默认为传入主机。
enabledState	backendEnabledState	是否要启用此后端。 允许的值为“Enabled”或“Disabled”
httpPort	integer	HTTP TCP 端口号。 必须介于 1 和 65535 之间。
httpsPort	integer	HTTPS TCP 端口号。 必须介于 1 和 65535 之间。
priority	integer	要用于负载均衡的优先级。 如果任何优先级较低的后端正常运行，则不会使用较高优先级进行负载均衡。
weight	integer	此终结点用于负载均衡的权重。

backendEnabledState

是否要启用此后端。 允许的值为“Enabled”或“Disabled”

名称	类型	说明
Disabled	string
Enabled	string

BackendPool

后端池是可以路由到的后端的集合。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.backends	Backend[]	此池的后端集
properties.healthProbeSettings	SubResource	后端池的 L7 运行状况探测设置
properties.loadBalancingSettings	SubResource	后端池的负载均衡设置
properties.resourceState	FrontDoorResourceState	Front Door 或 Front Door 子资源的资源状态。 资源状态。
type	string	资源类型。

BackendPoolsSettings

应用于所有后端池的设置。

名称	类型	默认值	说明
enforceCertificateNameCheck	enforceCertificateNameCheckEnabledState	Enabled	是否对对所有后端池的 HTTPS 请求强制执行证书名称检查。 对非 HTTPS 请求没有影响。
sendRecvTimeoutSeconds	integer		将请求转发到后端时发送和接收超时。 达到超时时，请求将失败并返回。

CacheConfiguration

缓存类型路由的缓存设置。 若要禁用缓存，请不要提供 cacheConfiguration 对象。

名称	类型	说明
dynamicCompression	DynamicCompressionEnabled	是否对缓存的内容使用动态压缩
queryParameterStripDirective	FrontDoorQuery	形成缓存密钥时的 URL 查询词的处理。

CustomHttpsConfiguration

域的 Https 设置

名称	类型	说明
certificateSource	FrontDoorCertificateSource	定义 SSL 证书的源
frontDoorCertificateSourceParameters.certificateType	FrontDoorCertificateType	定义用于安全连接到 frontendEndpoint 的证书类型
keyVaultCertificateSourceParameters.secretName	string	表示完整证书 PFX 的 Key Vault 机密的名称
keyVaultCertificateSourceParameters.secretVersion	string	表示完整证书 PFX 的 Key Vault 机密的版本
keyVaultCertificateSourceParameters.vault	Vault	包含 SSL 证书的 Key Vault
minimumTlsVersion	MinimumTLSVersion	客户端与 Front Door 建立 SSL 握手所需的最低 TLS 版本。
protocolType	FrontDoorTlsProtocolType	定义用于安全传递的 TLS 扩展协议

CustomHttpsProvisioningState

frontendEndpoint 的自定义 Https 的预配状态。

名称	类型	说明
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

预配子状态显示逐步启用/禁用自定义 HTTPS 过程的进度。

名称	类型	说明
CertificateDeleted	string
CertificateDeployed	string
DeletingCertificate	string
DeployingCertificate	string
DomainControlValidationRequestApproved	string
DomainControlValidationRequestRejected	string
DomainControlValidationRequestTimedOut	string
IssuingCertificate	string
PendingDomainControlValidationREquestApproval	string
SubmittingDomainControlValidationRequest	string

DynamicCompressionEnabled

是否对缓存的内容使用动态压缩

名称	类型	说明
Disabled	string
Enabled	string

enforceCertificateNameCheckEnabledState

是否对对所有后端池的 HTTPS 请求强制执行证书名称检查。 对非 HTTPS 请求没有影响。

名称	类型	说明
Disabled	string
Enabled	string

ErrorResponse

错误响应指示 Front Door 服务无法处理传入请求。 错误消息中提供了原因。

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败原因的错误消息。

ForwardingConfiguration

介绍转发路由。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
backendPool	SubResource	对此规则路由到的 BackendPool 的引用。
cacheConfiguration	CacheConfiguration	与此规则关联的缓存配置。
customForwardingPath	string	用于重写此规则匹配的资源路径的自定义路径。 保留为空以使用传入路径。
forwardingProtocol	FrontDoorForwardingProtocol	将流量转发到后端时此规则将使用的协议。

FrontDoor

Front Door 表示将流量路由到的后端终结点的集合，以及指定流量发送到那里的规则。

名称	类型	说明
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.backendPools	BackendPool[]	可用于路由规则的后端池。
properties.backendPoolsSettings	BackendPoolsSettings	所有 backendPools 的设置
properties.cname	string	每个 frontendEndpoint 都必须 CNAME 到的主机。
properties.enabledState	FrontDoorEnabledState	Front Door 负载均衡器的运行状态。 允许的值为“Enabled”或“Disabled”
properties.friendlyName	string	frontDoor 的友好名称
properties.frontendEndpoints	FrontendEndpoint[]	可用于路由规则的前端终结点。
properties.healthProbeSettings	HealthProbeSettingsModel[]	与此 Front Door 实例关联的运行状况探测设置。
properties.loadBalancingSettings	LoadBalancingSettingsModel[]	与此 Front Door 实例关联的负载均衡设置。
properties.provisioningState	string	Front Door 的预配状态。
properties.resourceState	FrontDoorResourceState	Front Door 或 Front Door 子资源的资源状态。 Front Door 的资源状态。
properties.routingRules	RoutingRule[]	与此 Front Door 关联的路由规则。
tags	object	资源标记。
type	string	资源类型。

FrontDoorCertificateSource

定义 SSL 证书的源

名称	类型	说明
AzureKeyVault	string
FrontDoor	string

FrontDoorCertificateType

定义用于安全连接到 frontendEndpoint 的证书类型

名称	类型	说明
Dedicated	string

FrontDoorEnabledState

Front Door 负载均衡器的运行状态。 允许的值为“Enabled”或“Disabled”

名称	类型	说明
Disabled	string
Enabled	string

FrontDoorForwardingProtocol

将流量转发到后端时此规则将使用的协议。

名称	类型	说明
HttpOnly	string
HttpsOnly	string
MatchRequest	string

FrontDoorHealthProbeMethod

配置用于探测 backendPools 下定义的后端的 HTTP 方法。

名称	类型	说明
GET	string
HEAD	string

FrontDoorProtocol

要与此规则匹配的协议方案

名称	类型	说明
Http	string
Https	string

FrontDoorQuery

形成缓存密钥时的 URL 查询词的处理。

名称	类型	说明
StripAll	string
StripNone	string

FrontDoorRedirectProtocol

流量重定向到的目标协议

名称	类型	说明
HttpOnly	string
HttpsOnly	string
MatchRequest	string

FrontDoorRedirectType

重定向流量时规则将使用的重定向类型。

名称	类型	说明
Found	string
Moved	string
PermanentRedirect	string
TemporaryRedirect	string

FrontDoorResourceState

Front Door 或 Front Door 子资源的资源状态。

名称	类型	说明
Creating	string
Deleting	string
Disabled	string
Disabling	string
Enabled	string
Enabling	string

FrontDoorTlsProtocolType

定义用于安全传递的 TLS 扩展协议

名称	类型	说明
ServerNameIndication	string

FrontendEndpoint

用于路由的前端终结点。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.customHttpsConfiguration	CustomHttpsConfiguration	指定如何启用 HTTPS 的配置
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	frontendEndpoint 的自定义 Https 的预配状态。
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	预配子状态显示逐步启用/禁用自定义 HTTPS 过程的进度。
properties.hostName	string	frontendEndpoint 的主机名。 必须是域名。
properties.resourceState	FrontDoorResourceState	Front Door 或 Front Door 子资源的资源状态。 资源状态。
properties.sessionAffinityEnabledState	SessionAffinityEnabledState	是否允许此主机上的会话相关性。 有效选项为“Enabled”或“Disabled”
properties.sessionAffinityTtlSeconds	integer	闲置。 将忽略此字段。 会话相关性要使用的 TTL（如果适用，以秒为单位）。
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink	为每个主机 (定义Web 应用程序防火墙策略（如果适用)
type	string	资源类型。

HealthProbeEnabled

是否对 backendPools 下定义的后端启用运行状况探测。 仅当单个已启用的后端池中有一个已启用的后端时，才能禁用运行状况探测。

名称	类型	说明
Disabled	string
Enabled	string

HealthProbeSettingsModel

后端池的负载均衡设置

名称	类型	默认值	说明
id	string		资源 ID。
name	string		资源名称。
properties.enabledState	HealthProbeEnabled		是否对 backendPools 下定义的后端启用运行状况探测。 仅当单个已启用的后端池中有一个已启用的后端时，才能禁用运行状况探测。
properties.healthProbeMethod	FrontDoorHealthProbeMethod	HEAD	配置用于探测 backendPools 下定义的后端的 HTTP 方法。
properties.intervalInSeconds	integer		运行状况探测之间间隔的秒数。
properties.path	string		要用于运行状况探测的路径。 默认值为“/”
properties.protocol	FrontDoorProtocol		用于此探测的协议方案
properties.resourceState	FrontDoorResourceState		Front Door 或 Front Door 子资源的资源状态。 资源状态。
type	string		资源类型。

LoadBalancingSettingsModel

后端池的负载均衡设置

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.additionalLatencyMilliseconds	integer	探测进入最低延迟存储桶的额外延迟（以毫秒为单位）
properties.resourceState	FrontDoorResourceState	Front Door 或 Front Door 子资源的资源状态。 资源状态。
properties.sampleSize	integer	负载均衡决策要考虑的样本数
properties.successfulSamplesRequired	integer	样本周期内必须成功的样本数
type	string	资源类型。

MinimumTLSVersion

客户端与 Front Door 建立 SSL 握手所需的最低 TLS 版本。

名称	类型	说明
1.0	string
1.2	string

RedirectConfiguration

描述重定向路由。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration
customFragment	string	要添加到重定向 URL 的片段。 片段是 #之后的 URL 的一部分。 不要包含 #。
customHost	string	要重定向的主机。 留空以使用传入主机作为目标主机。
customPath	string	要重定向的完整路径。 路径不能为空，并且必须以 /开头。 留空以使用传入路径作为目标路径。
customQueryString	string	要放置在重定向 URL 中的查询字符串集。 设置此值将替换任何现有的查询字符串;保留空以保留传入的查询字符串。 查询字符串必须采用 = 格式。 第一个？ 和 & 将自动添加，因此不要将它们包含在前面，而是使用 & 分隔多个查询字符串。
redirectProtocol	FrontDoorRedirectProtocol	流量重定向到的目标协议
redirectType	FrontDoorRedirectType	重定向流量时规则将使用的重定向类型。

RoutingRule

路由规则表示要处理的流量的规范、发送位置以及运行状况探测信息。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.acceptedProtocols	FrontDoorProtocol[]	要与此规则匹配的协议方案
properties.enabledState	routingRuleEnabledState	是否要启用此规则。 允许的值为“Enabled”或“Disabled”
properties.frontendEndpoints	SubResource[]	与此规则关联的前端终结点
properties.patternsToMatch	string[]	规则的路由模式。
properties.resourceState	FrontDoorResourceState	Front Door 或 Front Door 子资源的资源状态。 资源状态。
properties.routeConfiguration	RouteConfiguration: ForwardingConfiguration RedirectConfiguration	对路由配置的引用。
type	string	资源类型。

routingRuleEnabledState

是否要启用此规则。 允许的值为“Enabled”或“Disabled”

名称	类型	说明
Disabled	string
Enabled	string

SessionAffinityEnabledState

是否允许此主机上的会话相关性。 有效选项为“Enabled”或“Disabled”

名称	类型	说明
Disabled	string
Enabled	string

SubResource

对另一个子资源的引用。

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

Vault

包含 SSL 证书的 Key Vault

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

WebApplicationFirewallPolicyLink

为每个主机 (定义Web 应用程序防火墙策略（如果适用)

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