Microsoft.Network frontDoors

Bicep 資源定義

frontDoors 資源類型可以部署到：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/frontDoors 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Network/frontDoors@2021-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    backendPools: [
      {
        id: 'string'
        name: 'string'
        properties: {
          backends: [
            {
              address: 'string'
              backendHostHeader: 'string'
              enabledState: 'string'
              httpPort: int
              httpsPort: int
              priority: int
              privateLinkAlias: 'string'
              privateLinkApprovalMessage: 'string'
              privateLinkLocation: 'string'
              privateLinkResourceId: 'string'
              weight: int
            }
          ]
          healthProbeSettings: {
            id: 'string'
          }
          loadBalancingSettings: {
            id: 'string'
          }
        }
      }
    ]
    backendPoolsSettings: {
      enforceCertificateNameCheck: 'string'
      sendRecvTimeoutSeconds: int
    }
    enabledState: 'string'
    friendlyName: 'string'
    frontendEndpoints: [
      {
        id: 'string'
        name: 'string'
        properties: {
          hostName: 'string'
          sessionAffinityEnabledState: 'string'
          sessionAffinityTtlSeconds: int
          webApplicationFirewallPolicyLink: {
            id: 'string'
          }
        }
      }
    ]
    healthProbeSettings: [
      {
        id: 'string'
        name: 'string'
        properties: {
          enabledState: 'string'
          healthProbeMethod: 'string'
          intervalInSeconds: int
          path: 'string'
          protocol: 'string'
        }
      }
    ]
    loadBalancingSettings: [
      {
        id: 'string'
        name: 'string'
        properties: {
          additionalLatencyMilliseconds: int
          sampleSize: int
          successfulSamplesRequired: int
        }
      }
    ]
    routingRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          acceptedProtocols: [
            'string'
          ]
          enabledState: 'string'
          frontendEndpoints: [
            {
              id: 'string'
            }
          ]
          patternsToMatch: [
            'string'
          ]
          routeConfiguration: {
            '@odata.type': 'string'
            // For remaining properties, see RouteConfiguration objects
          }
          rulesEngine: {
            id: 'string'
          }
          webApplicationFirewallPolicyLink: {
            id: 'string'
          }
        }
      }
    ]
  }
}

RouteConfiguration 物件

設定 @odata.type 屬性以指定物件的類型。

針對 #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration，請使用：

  '@odata.type': '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'
  backendPool: {
    id: 'string'
  }
  cacheConfiguration: {
    cacheDuration: 'string'
    dynamicCompression: 'string'
    queryParameters: 'string'
    queryParameterStripDirective: 'string'
  }
  customForwardingPath: 'string'
  forwardingProtocol: 'string'

針對 #Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration，請使用：

  '@odata.type': '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration'
  customFragment: 'string'
  customHost: 'string'
  customPath: 'string'
  customQueryString: 'string'
  redirectProtocol: 'string'
  redirectType: 'string'

屬性值

frontDoors

FrontDoorProperties

BackendPool

BackendPoolProperties

後端

SubResource

BackendPoolsSettings

FrontendEndpoint

FrontendEndpointProperties

FrontendEndpointUpdateParametersWebApplicationFirewa...

HealthProbeSettingsModel

HealthProbeSettingsProperties

LoadBalancingSettingsModel

LoadBalancingSettingsProperties

RoutingRule

RoutingRuleProperties

RouteConfiguration

ForwardingConfiguration

CacheConfiguration

RedirectConfiguration

RoutingRuleUpdateParametersWebApplicationFirewallPol...

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
在 Azure API 管理 前面建立 Azure Front Door	此範例示範如何使用 Azure Front Door 作為 Azure API 管理 前面的全域負載平衡器。
建立基本 Front Door	此範本會建立具有單一後端的基本 Front Door 設定。
建立已針對特定路由啟用快取功能的 Front Door	此範本會針對定義的路由組態建立已啟用快取功能的 Front Door，因此會快取工作負載的任何靜態資產。
建立具有多個後端和後端集區的 Front Door	此範本會建立 Front Door，並針對後端集區中的多個後端設定負載平衡，以及根據 URL 路徑跨後端集區。
建立具有 HTTP 至 HTTPS 重新導向的 Front Door	此範本會建立 HTTP 至 HTTPS 重新導向的 Front Door 設定。
使用 Front Door 新增自定義網域和受控憑證	此範本會使用 Front Door 上線並保護自訂網域
使用 Front Door 新增自定義網域和自定義憑證	此範本會使用客戶管理的憑證將 Front Door 上線並保護自定義網域
在 Front Door 上控制後端的健康狀態探查	此範本會藉由設定探查路徑以及將傳送探查的間隔，來更新 Front Door 以變更健康情況探查設定。
使用 Active-Standby 設定建立 Front Door	此範本會建立 Front Door，示範 Active-Standby 應用程式拓撲的優先順序型路由。
為 Front Door 主機名稱設定工作階段親和性	此範本會更新 Front Door，以啟用前端主機的會話親和性，藉此將來自相同用戶會話的後續流量傳送至相同的後端。

ARM 範本資源定義

frontDoors 資源類型可以部署到：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.Network/frontDoors 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.Network/frontDoors",
  "apiVersion": "2021-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "backendPools": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "backends": [
            {
              "address": "string",
              "backendHostHeader": "string",
              "enabledState": "string",
              "httpPort": "int",
              "httpsPort": "int",
              "priority": "int",
              "privateLinkAlias": "string",
              "privateLinkApprovalMessage": "string",
              "privateLinkLocation": "string",
              "privateLinkResourceId": "string",
              "weight": "int"
            }
          ],
          "healthProbeSettings": {
            "id": "string"
          },
          "loadBalancingSettings": {
            "id": "string"
          }
        }
      }
    ],
    "backendPoolsSettings": {
      "enforceCertificateNameCheck": "string",
      "sendRecvTimeoutSeconds": "int"
    },
    "enabledState": "string",
    "friendlyName": "string",
    "frontendEndpoints": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "hostName": "string",
          "sessionAffinityEnabledState": "string",
          "sessionAffinityTtlSeconds": "int",
          "webApplicationFirewallPolicyLink": {
            "id": "string"
          }
        }
      }
    ],
    "healthProbeSettings": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "enabledState": "string",
          "healthProbeMethod": "string",
          "intervalInSeconds": "int",
          "path": "string",
          "protocol": "string"
        }
      }
    ],
    "loadBalancingSettings": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "additionalLatencyMilliseconds": "int",
          "sampleSize": "int",
          "successfulSamplesRequired": "int"
        }
      }
    ],
    "routingRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "acceptedProtocols": [ "string" ],
          "enabledState": "string",
          "frontendEndpoints": [
            {
              "id": "string"
            }
          ],
          "patternsToMatch": [ "string" ],
          "routeConfiguration": {
            "@odata.type": "string"
            // For remaining properties, see RouteConfiguration objects
          },
          "rulesEngine": {
            "id": "string"
          },
          "webApplicationFirewallPolicyLink": {
            "id": "string"
          }
        }
      }
    ]
  }
}

RouteConfiguration 物件

設定 @odata.type 屬性以指定 物件的類型。

針對 #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration，請使用：

  "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
  "backendPool": {
    "id": "string"
  },
  "cacheConfiguration": {
    "cacheDuration": "string",
    "dynamicCompression": "string",
    "queryParameters": "string",
    "queryParameterStripDirective": "string"
  },
  "customForwardingPath": "string",
  "forwardingProtocol": "string"

針對 #Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration，請使用：

  "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration",
  "customFragment": "string",
  "customHost": "string",
  "customPath": "string",
  "customQueryString": "string",
  "redirectProtocol": "string",
  "redirectType": "string"

屬性值

frontDoors

FrontDoorProperties

BackendPool

BackendPoolProperties

後端

SubResource

BackendPoolsSettings

FrontendEndpoint

FrontendEndpointProperties

FrontendEndpointUpdateParametersWebApplicationFirewa...

HealthProbeSettingsModel

HealthProbeSettingsProperties

LoadBalancingSettingsModel

LoadBalancingSettingsProperties

RoutingRule

RoutingRuleProperties

RouteConfiguration

ForwardingConfiguration

CacheConfiguration

RedirectConfiguration

RoutingRuleUpdateParametersWebApplicationFirewallPol...

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
在 Azure API 管理 前面建立 Azure Front Door	此範例示範如何使用 Azure Front Door 作為 Azure API 管理 前面的全域負載平衡器。
建立基本 Front Door	此範本會建立具有單一後端的基本 Front Door 設定。
建立已針對特定路由啟用快取功能的 Front Door	此範本會針對已定義的路由設定建立已啟用快取功能的 Front Door，因此會快取工作負載的任何靜態資產。
建立具有多個後端和後端集區的 Front Door	此範本會建立 Front Door，並針對後端集區中的多個後端設定負載平衡，以及根據 URL 路徑跨後端集區。
建立具有 HTTP 至 HTTPS 重新導向的 Front Door	此範本會建立適用於 HTTP 至 HTTPS 重新導向的 Front Door 設定。
使用 Front Door 新增自定義網域和受控憑證	此範本會使用 Front Door 將自訂網域上線並保護
使用 Front Door 新增自定義網域和自定義憑證	此範本會使用客戶管理的憑證將 Front Door 上線並保護自定義網域
在 Front Door 上控制後端的健康狀態探查	此範本會藉由設定探查路徑以及將傳送探查的間隔，來更新 Front Door 以變更健康情況探查設定。
使用 Active-Standby 組態建立 Front Door	此範本會建立 Front Door，示範 Active-Standby 應用程式拓撲的優先順序型路由。
為 Front Door 主機名稱設定工作階段親和性	此範本會更新 Front Door，以啟用前端主機的會話親和性，藉此將來自相同用戶會話的後續流量傳送至相同的後端。

Terraform (AzAPI 提供者) 資源定義

frontDoors 資源類型可以部署到：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/frontDoors 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/frontDoors@2021-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      backendPools = [
        {
          id = "string"
          name = "string"
          properties = {
            backends = [
              {
                address = "string"
                backendHostHeader = "string"
                enabledState = "string"
                httpPort = int
                httpsPort = int
                priority = int
                privateLinkAlias = "string"
                privateLinkApprovalMessage = "string"
                privateLinkLocation = "string"
                privateLinkResourceId = "string"
                weight = int
              }
            ]
            healthProbeSettings = {
              id = "string"
            }
            loadBalancingSettings = {
              id = "string"
            }
          }
        }
      ]
      backendPoolsSettings = {
        enforceCertificateNameCheck = "string"
        sendRecvTimeoutSeconds = int
      }
      enabledState = "string"
      friendlyName = "string"
      frontendEndpoints = [
        {
          id = "string"
          name = "string"
          properties = {
            hostName = "string"
            sessionAffinityEnabledState = "string"
            sessionAffinityTtlSeconds = int
            webApplicationFirewallPolicyLink = {
              id = "string"
            }
          }
        }
      ]
      healthProbeSettings = [
        {
          id = "string"
          name = "string"
          properties = {
            enabledState = "string"
            healthProbeMethod = "string"
            intervalInSeconds = int
            path = "string"
            protocol = "string"
          }
        }
      ]
      loadBalancingSettings = [
        {
          id = "string"
          name = "string"
          properties = {
            additionalLatencyMilliseconds = int
            sampleSize = int
            successfulSamplesRequired = int
          }
        }
      ]
      routingRules = [
        {
          id = "string"
          name = "string"
          properties = {
            acceptedProtocols = [
              "string"
            ]
            enabledState = "string"
            frontendEndpoints = [
              {
                id = "string"
              }
            ]
            patternsToMatch = [
              "string"
            ]
            routeConfiguration = {
              @odata.type = "string"
              // For remaining properties, see RouteConfiguration objects
            }
            rulesEngine = {
              id = "string"
            }
            webApplicationFirewallPolicyLink = {
              id = "string"
            }
          }
        }
      ]
    }
  })
}

RouteConfiguration 物件

設定 @odata.type 屬性以指定物件的類型。

針對 #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration，請使用：

  @odata.type = "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"
  backendPool = {
    id = "string"
  }
  cacheConfiguration = {
    cacheDuration = "string"
    dynamicCompression = "string"
    queryParameters = "string"
    queryParameterStripDirective = "string"
  }
  customForwardingPath = "string"
  forwardingProtocol = "string"

針對 #Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration，請使用：

  @odata.type = "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"
  customFragment = "string"
  customHost = "string"
  customPath = "string"
  customQueryString = "string"
  redirectProtocol = "string"
  redirectType = "string"

屬性值

frontDoors

FrontDoorProperties

BackendPool

BackendPoolProperties

後端

SubResource

BackendPoolsSettings

FrontendEndpoint

FrontendEndpointProperties

FrontendEndpointUpdateParametersWebApplicationFirewa...

HealthProbeSettingsModel

HealthProbeSettingsProperties

LoadBalancingSettingsModel

LoadBalancingSettingsProperties

RoutingRule

RoutingRuleProperties

RouteConfiguration

ForwardingConfiguration

CacheConfiguration

RedirectConfiguration

RoutingRuleUpdateParametersWebApplicationFirewallPol...