Front Doors - Create Or Update

在指定的訂用帳戶和資源群組下,建立具有 Front Door 名稱的新 Front Door。

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

URI 參數

名稱 位於 必要 類型 Description
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 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True

string

用戶端 API 版本。

要求本文

名稱 類型 Description
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

資源標籤。

回應

名稱 類型 Description
200 OK

FrontDoor

正常。 要求成功。

201 Created

FrontDoor

已建立。 要求已完成,並已建立新的 Front Door。

202 Accepted

FrontDoor

已接受。 已接受處理要求,且作業將會以異步方式完成。

Other Status Codes

ErrorResponse

Front Door 錯誤回應,描述作業失敗的原因。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Create or update specific Front Door

Sample Request

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

{
  "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"
  }
}
{
  "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"
  }
}
{
  "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"
  }
}

定義

名稱 Description
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 SubResource 的資源狀態。

FrontDoorTlsProtocolType

定義用於安全傳遞的 TLS 延伸協定

FrontendEndpoint

用於路由的前端端點。

HealthProbeEnabled

是否要針對 backendPools 下定義的後端啟用健康情況探查。 只有在單一已啟用後端集區中有單一啟用後端時,才能停用健康情況探查。

HealthProbeSettingsModel

後端集區的負載平衡設定

LoadBalancingSettingsModel

後端集區的負載平衡設定

MinimumTLSVersion

用戶端所需的最低 TLS 版本,才能建立與 Front Door 的 SSL 交握。

RedirectConfiguration

描述重新導向路由。

RoutingRule

路由規則代表流量要處理的規格,以及傳送它的位置,以及健康情況探查資訊。

routingRuleEnabledState

是否要啟用此規則。 允許的值為 'Enabled' 或 'Disabled'

SessionAffinityEnabledState

是否允許此主機上的工作階段親和性。 有效選項為 'Enabled' 或 'Disabled'

SubResource

另一個子資源的參考。

Vault

包含 SSL 憑證的金鑰保存庫

WebApplicationFirewallPolicyLink

如果) 適用,請定義每個主機 Web 應用程式防火牆 原則 (

Backend

frontDoor 負載平衡器的後端位址。

名稱 類型 Description
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'

名稱 類型 Description
Disabled

string

Enabled

string

BackendPool

後端集區是可路由傳送至的後端集合。

名稱 類型 Description
id

string

資源識別碼。

name

string

資源名稱。

properties.backends

Backend[]

此集區的後端集合

properties.healthProbeSettings

SubResource

後端集區的 L7 健康情況探查設定

properties.loadBalancingSettings

SubResource

後端集區的負載平衡設定

properties.resourceState

FrontDoorResourceState

Front Door 或 Front Door SubResource 的資源狀態。
資源狀態。

type

string

資源類型。

BackendPoolsSettings

套用至所有後端集區的設定。

名稱 類型 預設值 Description
enforceCertificateNameCheck

enforceCertificateNameCheckEnabledState

Enabled

是否要在所有後端集區的 HTTPS 要求上強制執行憑證名稱檢查。 不會影響非 HTTPS 要求。

sendRecvTimeoutSeconds

integer

傳送和接收將要求轉送至後端的逾時。 達到逾時時,要求會失敗並傳回。

CacheConfiguration

快取類型路由的快取設定。 若要停用快取,請勿提供 cacheConfiguration 物件。

名稱 類型 Description
dynamicCompression

DynamicCompressionEnabled

是否對快取的內容使用動態壓縮

queryParameterStripDirective

FrontDoorQuery

形成快取索引鍵時,URL 查詢字詞的處理方式。

CustomHttpsConfiguration

網域的 Https 設定

名稱 類型 Description
certificateSource

FrontDoorCertificateSource

定義 SSL 憑證的來源

frontDoorCertificateSourceParameters.certificateType

FrontDoorCertificateType

定義用於安全連線至frontendEndpoint的憑證類型

keyVaultCertificateSourceParameters.secretName

string

代表完整憑證 PFX 的金鑰保存庫密碼名稱

keyVaultCertificateSourceParameters.secretVersion

string

代表完整憑證 PFX 的金鑰保存庫密碼版本

keyVaultCertificateSourceParameters.vault

Vault

包含 SSL 憑證的金鑰保存庫

minimumTlsVersion

MinimumTLSVersion

用戶端所需的最低 TLS 版本,才能建立與 Front Door 的 SSL 交握。

protocolType

FrontDoorTlsProtocolType

定義用於安全傳遞的 TLS 延伸協定

CustomHttpsProvisioningState

frontendEndpoint 的自訂 Https 布建狀態。

名稱 類型 Description
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Failed

string

CustomHttpsProvisioningSubstate

布建子狀態會顯示自定義 HTTPS 的逐步啟用/停用程序進度。

名稱 類型 Description
CertificateDeleted

string

CertificateDeployed

string

DeletingCertificate

string

DeployingCertificate

string

DomainControlValidationRequestApproved

string

DomainControlValidationRequestRejected

string

DomainControlValidationRequestTimedOut

string

IssuingCertificate

string

PendingDomainControlValidationREquestApproval

string

SubmittingDomainControlValidationRequest

string

DynamicCompressionEnabled

是否對快取的內容使用動態壓縮

名稱 類型 Description
Disabled

string

Enabled

string

enforceCertificateNameCheckEnabledState

是否對所有後端集區的 HTTPS 要求強制執行憑證名稱檢查。 不會影響非 HTTPS 要求。

名稱 類型 Description
Disabled

string

Enabled

string

ErrorResponse

錯誤回應指出 Front Door 服務無法處理傳入要求。 錯誤訊息中會提供原因。

名稱 類型 Description
code

string

錯誤碼。

message

string

錯誤訊息,指出作業失敗的原因。

ForwardingConfiguration

描述轉送路由。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration

backendPool

SubResource

此規則路由傳送至的 BackendPool 參考。

cacheConfiguration

CacheConfiguration

與此規則相關聯的快取組態。

customForwardingPath

string

用來重寫此規則所比對之資源路徑的自定義路徑。 保留空白將使用傳入路徑。

forwardingProtocol

FrontDoorForwardingProtocol

將流量轉送至後端時,此規則將使用的通訊協定。

FrontDoor

Front Door 代表後端端點的集合,可路由傳送流量,以及指定流量傳送到該處的規則。

名稱 類型 Description
id

string

資源識別碼。

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 SubResource 的資源狀態。
Front Door 的資源狀態。

properties.routingRules

RoutingRule[]

與此 Front Door 相關聯的路由規則。

tags

object

資源標籤。

type

string

資源類型。

FrontDoorCertificateSource

定義 SSL 憑證的來源

名稱 類型 Description
AzureKeyVault

string

FrontDoor

string

FrontDoorCertificateType

定義用於安全連線至frontendEndpoint的憑證類型

名稱 類型 Description
Dedicated

string

FrontDoorEnabledState

Front Door 負載平衡器的操作狀態。 允許的值是 'Enabled' 或 'Disabled'

名稱 類型 Description
Disabled

string

Enabled

string

FrontDoorForwardingProtocol

將流量轉送至後端時,此規則將使用的通訊協定。

名稱 類型 Description
HttpOnly

string

HttpsOnly

string

MatchRequest

string

FrontDoorHealthProbeMethod

設定要用來探查 backendPools 下定義的後端的 HTTP 方法。

名稱 類型 Description
GET

string

HEAD

string

FrontDoorProtocol

要符合此規則的通訊協定配置

名稱 類型 Description
Http

string

Https

string

FrontDoorQuery

形成快取索引鍵時,URL 查詢字詞的處理方式。

名稱 類型 Description
StripAll

string

StripNone

string

FrontDoorRedirectProtocol

將流量重新導向目的地的通訊協定

名稱 類型 Description
HttpOnly

string

HttpsOnly

string

MatchRequest

string

FrontDoorRedirectType

重新導向流量時,規則將使用的重新導向類型。

名稱 類型 Description
Found

string

Moved

string

PermanentRedirect

string

TemporaryRedirect

string

FrontDoorResourceState

Front Door 或 Front Door SubResource 的資源狀態。

名稱 類型 Description
Creating

string

Deleting

string

Disabled

string

Disabling

string

Enabled

string

Enabling

string

FrontDoorTlsProtocolType

定義用於安全傳遞的 TLS 延伸協定

名稱 類型 Description
ServerNameIndication

string

FrontendEndpoint

用於路由的前端端點。

名稱 類型 Description
id

string

資源識別碼。

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 SubResource 的資源狀態。
資源狀態。

properties.sessionAffinityEnabledState

SessionAffinityEnabledState

是否允許此主機上的工作階段親和性。 有效選項為 'Enabled' 或 'Disabled'

properties.sessionAffinityTtlSeconds

integer

閑置。 此欄位將被忽略。 如果適用的話,則為可在幾秒鐘之後用於工作階段親和性的 TTL。

properties.webApplicationFirewallPolicyLink

WebApplicationFirewallPolicyLink

如果適用) ,請定義每個主機 (Web 應用程式防火牆 原則

type

string

資源類型。

HealthProbeEnabled

是否要針對 backendPools 下定義的後端啟用健康情況探查。 只有在單一已啟用後端集區中有單一啟用後端時,才能停用健康情況探查。

名稱 類型 Description
Disabled

string

Enabled

string

HealthProbeSettingsModel

後端集區的負載平衡設定

名稱 類型 預設值 Description
id

string

資源識別碼。

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 SubResource 的資源狀態。
資源狀態。

type

string

資源類型。

LoadBalancingSettingsModel

後端集區的負載平衡設定

名稱 類型 Description
id

string

資源識別碼。

name

string

資源名稱。

properties.additionalLatencyMilliseconds

integer

探查的額外延遲以毫秒為單位,落在最低的延遲值區

properties.resourceState

FrontDoorResourceState

Front Door 或 Front Door SubResource 的資源狀態。
資源狀態。

properties.sampleSize

integer

要考慮進行負載平衡決策的範例數目

properties.successfulSamplesRequired

integer

範例期間內必須成功的樣本數目

type

string

資源類型。

MinimumTLSVersion

用戶端所需的最低 TLS 版本,才能建立與 Front Door 的 SSL 交握。

名稱 類型 Description
1.0

string

1.2

string

RedirectConfiguration

描述重新導向路由。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration

customFragment

string

要新增至重新導向 URL 的片段。 片段是之後 URL 的一部分。 請勿包含 #。

customHost

string

要重新導向的主機。 保留空白,以使用傳入主機作為目的地主機。

customPath

string

要重新導向的完整路徑。 路徑不能是空的,而且必須以 /開頭。 保留空白,以使用傳入路徑作為目的地路徑。

customQueryString

string

要放在重新導向 URL 中的查詢字串集。 設定此值會取代任何現有的查詢字串;保留空白以保留傳入查詢字串。 查詢字串必須是 = 格式。 第一個 ? 和 & 會自動新增,因此請勿將它們包含在前端,但會使用 & 分隔多個查詢字串。

redirectProtocol

FrontDoorRedirectProtocol

將流量重新導向目的地的通訊協定

redirectType

FrontDoorRedirectType

重新導向流量時,規則將使用的重新導向類型。

RoutingRule

路由規則代表流量要處理的規格,以及傳送它的位置,以及健康情況探查資訊。

名稱 類型 Description
id

string

資源識別碼。

name

string

資源名稱。

properties.acceptedProtocols

FrontDoorProtocol[]

要符合此規則的通訊協定配置

properties.enabledState

routingRuleEnabledState

是否要啟用此規則。 允許的值為 'Enabled' 或 'Disabled'

properties.frontendEndpoints

SubResource[]

與此規則相關聯的前端端點

properties.patternsToMatch

string[]

規則的路由模式。

properties.resourceState

FrontDoorResourceState

Front Door 或 Front Door SubResource 的資源狀態。
資源狀態。

properties.routeConfiguration RouteConfiguration:

路由組態的參考。

type

string

資源類型。

routingRuleEnabledState

是否要啟用此規則。 允許的值為 'Enabled' 或 'Disabled'

名稱 類型 Description
Disabled

string

Enabled

string

SessionAffinityEnabledState

是否允許此主機上的工作階段親和性。 有效選項為 'Enabled' 或 'Disabled'

名稱 類型 Description
Disabled

string

Enabled

string

SubResource

另一個子資源的參考。

名稱 類型 Description
id

string

資源識別碼。

Vault

包含 SSL 憑證的金鑰保存庫

名稱 類型 Description
id

string

資源識別碼。

如果) 適用,請定義每個主機 Web 應用程式防火牆 原則 (

名稱 類型 Description
id

string

資源識別碼。