共用方式為


Microsoft.Network frontDoors/rulesEngines 2021-06-01

Bicep 資源定義

frontDoors/rulesEngines 資源類型可以使用目標作業來部署:

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

資源格式

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

resource symbolicname 'Microsoft.Network/frontDoors/rulesEngines@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    rules: [
      {
        action: {
          requestHeaderActions: [
            {
              headerActionType: 'string'
              headerName: 'string'
              value: 'string'
            }
          ]
          responseHeaderActions: [
            {
              headerActionType: 'string'
              headerName: 'string'
              value: 'string'
            }
          ]
          routeConfigurationOverride: {
            @odata.type: 'string'
            // For remaining properties, see RouteConfiguration objects
          }
        }
        matchConditions: [
          {
            negateCondition: bool
            rulesEngineMatchValue: [
              'string'
            ]
            rulesEngineMatchVariable: 'string'
            rulesEngineOperator: 'string'
            selector: 'string'
            transforms: [
              'string'
            ]
          }
        ]
        matchProcessingBehavior: 'string'
        name: 'string'
        priority: int
      }
    ]
  }
}

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'
}

屬性值

CacheConfiguration

名字 描述 價值
cacheDuration 需要快取內容的持續時間。 允許的格式為 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations)。 HTTP 要求值不超過一年 字串
dynamicCompression 是否要針對快取的內容使用動態壓縮 'Disabled'
'Enabled'
queryParameters 要包含或排除的查詢參數(以逗號分隔)。 字串
queryParameterStripDirective 在形成快取索引鍵時處理 URL 查詢字詞。 'StripAll'
'StripAllExcept'
'StripNone'
'StripOnly'

ForwardingConfiguration

名字 描述 價值
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration' (必要)
backendPool 此規則路由傳送至的 BackendPool 參考。 SubResource
cacheConfiguration 與此規則相關聯的快取組態。 CacheConfiguration
customForwardingPath 用來重寫此規則所比對之資源路徑的自定義路徑。 保留空白以使用傳入路徑。 字串
forwardingProtocol 將流量轉送至後端時,會使用此規則的通訊協定。 'HttpOnly'
'HttpsOnly'
'MatchRequest'

HeaderAction

名字 描述 價值
headerActionType 要套用至標頭的操作類型。 'Append'
'Delete'
'Overwrite' (必要)
headerName 此動作將套用至的標頭名稱。 字串 (必要)
價值 要用來更新指定標頭名稱的值。 如果 actionType 為 Delete,則不會使用此值。 字串

Microsoft.Network/frontDoors/rulesEngines

名字 描述 價值
名字 資源名稱 字串

約束:
最小長度 = 1
最大長度 = 1
模式 = ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$ (必要)
父母 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型的資源符號名稱:frontDoors
性能 規則引擎組態的屬性。 RulesEngineProperties

RedirectConfiguration

名字 描述 價值
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration' (必要)
customFragment 要新增至重新導向 URL 的片段。 片段是之後 URL 的一部分。 請勿包含 #。 字串
customHost 要重新導向的主機。 保留空白,以使用傳入主機作為目的地主機。 字串
customPath 要重新導向的完整路徑。 路徑不可以是空的,而且必須以 /開頭。 保留空白,以使用傳入路徑作為目的地路徑。 字串
customQueryString 要放在重新導向 URL 中的查詢字串集。 設定此值會取代任何現有的查詢字串;保留空白以保留傳入查詢字串。 查詢字串必須 <索引鍵>=<值> 格式。 第一個 ? 和 & 會自動新增,因此請勿將它們包含在前面,但會使用 &分隔多個查詢字串。 字串
redirectProtocol 將流量重新導向目的地的通訊協定 'HttpOnly'
'HttpsOnly'
'MatchRequest'
redirectType 重新導向類型,規則會在重新導向流量時使用。 'Found'
'Moved'
'PermanentRedirect'
'TemporaryRedirect'

RouteConfiguration

名字 描述 價值
@odata.type 針對 forwardingConfiguration 類型,設定為 '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'。 針對 RedirectConfiguration 類型設定為 '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration', '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'
'#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration' (必要)

RulesEngineAction

名字 描述 價值
requestHeaderActions 要從 AFD 要求套用至來源的標頭動作清單。 HeaderAction[]
responseHeaderActions 要從 AFD 回應套用至用戶端的標頭動作清單。 HeaderAction[]
routeConfigurationOverride 覆寫路由設定。 RouteConfiguration

RulesEngineMatchCondition

名字 描述 價值
negateCondition 描述這是否為否定條件 bool
rulesEngineMatchValue 比對要比對的值。 運算子會套用至此處具有 OR 語意的每個值。 如果其中任一項符合變數與指定的運算符,則此比對條件會被視為相符專案。 string[] (必要)
rulesEngineMatchVariable 比對變數 'IsMobile'
'PostArgs'
'QueryString'
'RemoteAddr'
'RequestBody'
'RequestFilename'
'RequestFilenameExtension'
'RequestHeader'
'RequestMethod'
'RequestPath'
'RequestScheme'
'RequestUri' (必要)
rulesEngineOperator 描述要套用至比對條件的運算元。 'Any'
'BeginsWith'
'Contains'
'EndsWith'
'Equal'
'GeoMatch'
'GreaterThan'
'GreaterThanOrEqual'
'IPMatch'
'LessThan'
'LessThanOrEqual' (必要)
選擇器 RequestHeader 或 RequestBody 中要比對的選取器名稱 字串
變換 轉換清單 包含任何的字串數組:
'小寫'
'RemoveNulls'
'Trim'
'大寫'
'UrlDecode'
'UrlEncode'

RulesEngineProperties

名字 描述 價值
規則 定義特定規則引擎組態的規則清單。 RulesEngineRule[]

RulesEngineRule

名字 描述 價值
行動 如果符合所有比對條件,則對要求和回應執行的動作。 RulesEngineAction (必要)
matchConditions 必須符合的比對條件清單,才能執行此規則的動作。 沒有相符條件表示動作一律會執行。 RulesEngineMatchCondition[]
matchProcessingBehavior 如果此規則相符,規則引擎應該繼續執行其餘規則或停止。 如果不存在,則預設為 [繼續]。 'Continue'
'Stop'
名字 要參考此特定規則的名稱。 字串 (必要)
優先權 指派給此規則的優先順序。 int (必要)

SubResource

名字 描述 價值
id 資源標識碼。 字串

ARM 樣本資源定義

frontDoors/rulesEngines 資源類型可以使用目標作業來部署:

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

資源格式

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

{
  "type": "Microsoft.Network/frontDoors/rulesEngines",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "rules": [
      {
        "action": {
          "requestHeaderActions": [
            {
              "headerActionType": "string",
              "headerName": "string",
              "value": "string"
            }
          ],
          "responseHeaderActions": [
            {
              "headerActionType": "string",
              "headerName": "string",
              "value": "string"
            }
          ],
          "routeConfigurationOverride": {
            "@odata.type": "string"
            // For remaining properties, see RouteConfiguration objects
          }
        },
        "matchConditions": [
          {
            "negateCondition": "bool",
            "rulesEngineMatchValue": [ "string" ],
            "rulesEngineMatchVariable": "string",
            "rulesEngineOperator": "string",
            "selector": "string",
            "transforms": [ "string" ]
          }
        ],
        "matchProcessingBehavior": "string",
        "name": "string",
        "priority": "int"
      }
    ]
  }
}

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

屬性值

CacheConfiguration

名字 描述 價值
cacheDuration 需要快取內容的持續時間。 允許的格式為 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations)。 HTTP 要求值不超過一年 字串
dynamicCompression 是否要針對快取的內容使用動態壓縮 'Disabled'
'Enabled'
queryParameters 要包含或排除的查詢參數(以逗號分隔)。 字串
queryParameterStripDirective 在形成快取索引鍵時處理 URL 查詢字詞。 'StripAll'
'StripAllExcept'
'StripNone'
'StripOnly'

ForwardingConfiguration

名字 描述 價值
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration' (必要)
backendPool 此規則路由傳送至的 BackendPool 參考。 SubResource
cacheConfiguration 與此規則相關聯的快取組態。 CacheConfiguration
customForwardingPath 用來重寫此規則所比對之資源路徑的自定義路徑。 保留空白以使用傳入路徑。 字串
forwardingProtocol 將流量轉送至後端時,會使用此規則的通訊協定。 'HttpOnly'
'HttpsOnly'
'MatchRequest'

HeaderAction

名字 描述 價值
headerActionType 要套用至標頭的操作類型。 'Append'
'Delete'
'Overwrite' (必要)
headerName 此動作將套用至的標頭名稱。 字串 (必要)
價值 要用來更新指定標頭名稱的值。 如果 actionType 為 Delete,則不會使用此值。 字串

Microsoft.Network/frontDoors/rulesEngines

名字 描述 價值
apiVersion API 版本 '2021-06-01'
名字 資源名稱 字串

約束:
最小長度 = 1
最大長度 = 1
模式 = ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$ (必要)
性能 規則引擎組態的屬性。 RulesEngineProperties
類型 資源類型 'Microsoft.Network/frontDoors/rulesEngines'

RedirectConfiguration

名字 描述 價值
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration' (必要)
customFragment 要新增至重新導向 URL 的片段。 片段是之後 URL 的一部分。 請勿包含 #。 字串
customHost 要重新導向的主機。 保留空白,以使用傳入主機作為目的地主機。 字串
customPath 要重新導向的完整路徑。 路徑不可以是空的,而且必須以 /開頭。 保留空白,以使用傳入路徑作為目的地路徑。 字串
customQueryString 要放在重新導向 URL 中的查詢字串集。 設定此值會取代任何現有的查詢字串;保留空白以保留傳入查詢字串。 查詢字串必須 <索引鍵>=<值> 格式。 第一個 ? 和 & 會自動新增,因此請勿將它們包含在前面,但會使用 &分隔多個查詢字串。 字串
redirectProtocol 將流量重新導向目的地的通訊協定 'HttpOnly'
'HttpsOnly'
'MatchRequest'
redirectType 重新導向類型,規則會在重新導向流量時使用。 'Found'
'Moved'
'PermanentRedirect'
'TemporaryRedirect'

RouteConfiguration

名字 描述 價值
@odata.type 針對 forwardingConfiguration 類型,設定為 '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'。 針對 RedirectConfiguration 類型設定為 '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration', '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'
'#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration' (必要)

RulesEngineAction

名字 描述 價值
requestHeaderActions 要從 AFD 要求套用至來源的標頭動作清單。 HeaderAction[]
responseHeaderActions 要從 AFD 回應套用至用戶端的標頭動作清單。 HeaderAction[]
routeConfigurationOverride 覆寫路由設定。 RouteConfiguration

RulesEngineMatchCondition

名字 描述 價值
negateCondition 描述這是否為否定條件 bool
rulesEngineMatchValue 比對要比對的值。 運算子會套用至此處具有 OR 語意的每個值。 如果其中任一項符合變數與指定的運算符,則此比對條件會被視為相符專案。 string[] (必要)
rulesEngineMatchVariable 比對變數 'IsMobile'
'PostArgs'
'QueryString'
'RemoteAddr'
'RequestBody'
'RequestFilename'
'RequestFilenameExtension'
'RequestHeader'
'RequestMethod'
'RequestPath'
'RequestScheme'
'RequestUri' (必要)
rulesEngineOperator 描述要套用至比對條件的運算元。 'Any'
'BeginsWith'
'Contains'
'EndsWith'
'Equal'
'GeoMatch'
'GreaterThan'
'GreaterThanOrEqual'
'IPMatch'
'LessThan'
'LessThanOrEqual' (必要)
選擇器 RequestHeader 或 RequestBody 中要比對的選取器名稱 字串
變換 轉換清單 包含任何的字串數組:
'小寫'
'RemoveNulls'
'Trim'
'大寫'
'UrlDecode'
'UrlEncode'

RulesEngineProperties

名字 描述 價值
規則 定義特定規則引擎組態的規則清單。 RulesEngineRule[]

RulesEngineRule

名字 描述 價值
行動 如果符合所有比對條件,則對要求和回應執行的動作。 RulesEngineAction (必要)
matchConditions 必須符合的比對條件清單,才能執行此規則的動作。 沒有相符條件表示動作一律會執行。 RulesEngineMatchCondition[]
matchProcessingBehavior 如果此規則相符,規則引擎應該繼續執行其餘規則或停止。 如果不存在,則預設為 [繼續]。 'Continue'
'Stop'
名字 要參考此特定規則的名稱。 字串 (必要)
優先權 指派給此規則的優先順序。 int (必要)

SubResource

名字 描述 價值
id 資源標識碼。 字串

Terraform (AzAPI 提供者) 資源定義

frontDoors/rulesEngines 資源類型可以使用目標作業來部署:

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/frontDoors/rulesEngines@2021-06-01"
  name = "string"
  body = jsonencode({
    properties = {
      rules = [
        {
          action = {
            requestHeaderActions = [
              {
                headerActionType = "string"
                headerName = "string"
                value = "string"
              }
            ]
            responseHeaderActions = [
              {
                headerActionType = "string"
                headerName = "string"
                value = "string"
              }
            ]
            routeConfigurationOverride = {
              @odata.type = "string"
              // For remaining properties, see RouteConfiguration objects
            }
          }
          matchConditions = [
            {
              negateCondition = bool
              rulesEngineMatchValue = [
                "string"
              ]
              rulesEngineMatchVariable = "string"
              rulesEngineOperator = "string"
              selector = "string"
              transforms = [
                "string"
              ]
            }
          ]
          matchProcessingBehavior = "string"
          name = "string"
          priority = int
        }
      ]
    }
  })
}

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

屬性值

CacheConfiguration

名字 描述 價值
cacheDuration 需要快取內容的持續時間。 允許的格式為 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations)。 HTTP 要求值不超過一年 字串
dynamicCompression 是否要針對快取的內容使用動態壓縮 'Disabled'
'Enabled'
queryParameters 要包含或排除的查詢參數(以逗號分隔)。 字串
queryParameterStripDirective 在形成快取索引鍵時處理 URL 查詢字詞。 'StripAll'
'StripAllExcept'
'StripNone'
'StripOnly'

ForwardingConfiguration

名字 描述 價值
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration' (必要)
backendPool 此規則路由傳送至的 BackendPool 參考。 SubResource
cacheConfiguration 與此規則相關聯的快取組態。 CacheConfiguration
customForwardingPath 用來重寫此規則所比對之資源路徑的自定義路徑。 保留空白以使用傳入路徑。 字串
forwardingProtocol 將流量轉送至後端時,會使用此規則的通訊協定。 'HttpOnly'
'HttpsOnly'
'MatchRequest'

HeaderAction

名字 描述 價值
headerActionType 要套用至標頭的操作類型。 'Append'
'Delete'
'Overwrite' (必要)
headerName 此動作將套用至的標頭名稱。 字串 (必要)
價值 要用來更新指定標頭名稱的值。 如果 actionType 為 Delete,則不會使用此值。 字串

Microsoft.Network/frontDoors/rulesEngines

名字 描述 價值
名字 資源名稱 字串

約束:
最小長度 = 1
最大長度 = 1
模式 = ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$ (必要)
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼:frontDoors
性能 規則引擎組態的屬性。 RulesEngineProperties
類型 資源類型 “Microsoft.Network/frontDoors/rulesEngines@2021-06-01”

RedirectConfiguration

名字 描述 價值
@odata.type '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration' (必要)
customFragment 要新增至重新導向 URL 的片段。 片段是之後 URL 的一部分。 請勿包含 #。 字串
customHost 要重新導向的主機。 保留空白,以使用傳入主機作為目的地主機。 字串
customPath 要重新導向的完整路徑。 路徑不可以是空的,而且必須以 /開頭。 保留空白,以使用傳入路徑作為目的地路徑。 字串
customQueryString 要放在重新導向 URL 中的查詢字串集。 設定此值會取代任何現有的查詢字串;保留空白以保留傳入查詢字串。 查詢字串必須 <索引鍵>=<值> 格式。 第一個 ? 和 & 會自動新增,因此請勿將它們包含在前面,但會使用 &分隔多個查詢字串。 字串
redirectProtocol 將流量重新導向目的地的通訊協定 'HttpOnly'
'HttpsOnly'
'MatchRequest'
redirectType 重新導向類型,規則會在重新導向流量時使用。 'Found'
'Moved'
'PermanentRedirect'
'TemporaryRedirect'

RouteConfiguration

名字 描述 價值
@odata.type 針對 forwardingConfiguration 類型,設定為 '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'。 針對 RedirectConfiguration 類型設定為 '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration', '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'
'#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration' (必要)

RulesEngineAction

名字 描述 價值
requestHeaderActions 要從 AFD 要求套用至來源的標頭動作清單。 HeaderAction[]
responseHeaderActions 要從 AFD 回應套用至用戶端的標頭動作清單。 HeaderAction[]
routeConfigurationOverride 覆寫路由設定。 RouteConfiguration

RulesEngineMatchCondition

名字 描述 價值
negateCondition 描述這是否為否定條件 bool
rulesEngineMatchValue 比對要比對的值。 運算子會套用至此處具有 OR 語意的每個值。 如果其中任一項符合變數與指定的運算符,則此比對條件會被視為相符專案。 string[] (必要)
rulesEngineMatchVariable 比對變數 'IsMobile'
'PostArgs'
'QueryString'
'RemoteAddr'
'RequestBody'
'RequestFilename'
'RequestFilenameExtension'
'RequestHeader'
'RequestMethod'
'RequestPath'
'RequestScheme'
'RequestUri' (必要)
rulesEngineOperator 描述要套用至比對條件的運算元。 'Any'
'BeginsWith'
'Contains'
'EndsWith'
'Equal'
'GeoMatch'
'GreaterThan'
'GreaterThanOrEqual'
'IPMatch'
'LessThan'
'LessThanOrEqual' (必要)
選擇器 RequestHeader 或 RequestBody 中要比對的選取器名稱 字串
變換 轉換清單 包含任何的字串數組:
'小寫'
'RemoveNulls'
'Trim'
'大寫'
'UrlDecode'
'UrlEncode'

RulesEngineProperties

名字 描述 價值
規則 定義特定規則引擎組態的規則清單。 RulesEngineRule[]

RulesEngineRule

名字 描述 價值
行動 如果符合所有比對條件,則對要求和回應執行的動作。 RulesEngineAction (必要)
matchConditions 必須符合的比對條件清單,才能執行此規則的動作。 沒有相符條件表示動作一律會執行。 RulesEngineMatchCondition[]
matchProcessingBehavior 如果此規則相符,規則引擎應該繼續執行其餘規則或停止。 如果不存在,則預設為 [繼續]。 'Continue'
'Stop'
名字 要參考此特定規則的名稱。 字串 (必要)
優先權 指派給此規則的優先順序。 int (必要)

SubResource

名字 描述 價值
id 資源標識碼。 字串