通过

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

Microsoft.Network frontDoors/rulesEngines 2020-05-01

  • 项目

Bicep 资源定义

frontDoors/rulesEngines 资源类型可以部署到：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/frontDoors/rulesEngines 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Network/frontDoors/rulesEngines@2020-05-01' = {
  name: 'string'
  parent: resourceSymbolicName
  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'

属性值

frontDoors/rulesEngines

名称 说明 值
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。		 字符串 (必需)
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为的资源的符号名称： frontDoors
properties 规则引擎配置的属性。 RulesEngineProperties

RulesEngineProperties

名称 说明 值
规则 定义特定规则引擎配置的规则列表。 RulesEngineRule[]

RulesEngineRule

名称 说明 值
action 满足所有匹配条件时对请求和响应执行的操作。 RulesEngineAction (必需)
matchConditions 为了运行此规则的操作，必须满足的匹配条件列表。 没有匹配条件意味着操作将始终运行。 RulesEngineMatchCondition[]
matchProcessingBehavior 如果此规则是匹配项，则规则引擎应继续运行剩余规则或停止。 如果不存在，则默认为“继续”。 'Continue'
'Stop'
name 要引用此特定规则的名称。 字符串 (必需)
priority 分配给此规则的优先级。 int (必需)

RulesEngineAction

名称 说明 值
requestHeaderActions 要从 AFD 请求应用到源的标头操作的列表。 HeaderAction[]
responseHeaderActions 要从 AFD 响应应用到客户端的标头操作的列表。 HeaderAction[]
routeConfigurationOverride 替代路由配置。 RouteConfiguration

HeaderAction

名称 说明 值
headerActionType 要应用于标头的操作类型。 “Append”
'Delete'
需要“覆盖” ()
headerName 此操作将应用到的标头的名称。 字符串 (必需)
value 用于更新给定标头名称的值。 如果 actionType 为 Delete，则不使用此值。 字符串

RouteConfiguration

名称 说明 值
@odata.type 设置对象类型 #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration (必需)

ForwardingConfiguration

名称 说明 值
@odata.type 需要“#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration” ()
backendPool 对此规则路由到的 BackendPool 的引用。 SubResource
cacheConfiguration 与此规则关联的缓存配置。 CacheConfiguration
customForwardingPath 用于重写此规则匹配的资源路径的自定义路径。 保留为空以使用传入路径。 字符串
forwardingProtocol 将流量转发到后端时此规则将使用的协议。 “HttpOnly”
'HttpsOnly'
“MatchRequest”

SubResource

名称 说明 Value
id 资源 ID。 string

CacheConfiguration

名称 说明 值
cacheDuration 需要缓存内容的持续时间。 允许的格式采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。 HTTP 要求该值不超过一年 字符串
dynamicCompression 是否对缓存的内容使用动态压缩 'Disabled'
'Enabled'
queryParameters 要包含或排除 (逗号分隔) 的查询参数。 字符串
queryParameterStripDirective 形成缓存密钥时的 URL 查询词的处理。 “StripAll”
'StripAllExcept'
“StripNone”
'StripOnly'

RedirectConfiguration

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

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 中要匹配的选择器的名称 string
转换 转换列表 包含任何一项的字符串数组：
“小写”
'RemoveNulls'
“Trim”
“大写”
'UrlDecode'
'UrlEncode'

ARM 模板资源定义

frontDoors/rulesEngines 资源类型可以部署到：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/frontDoors/rulesEngines 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Network/frontDoors/rulesEngines",
  "apiVersion": "2020-05-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"

属性值

frontDoors/rulesEngines

名称 说明 Value
type 资源类型 'Microsoft.Network/frontDoors/rulesEngines'
apiVersion 资源 API 版本 '2020-05-01'
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。		 字符串 (必需)
properties 规则引擎配置的属性。 RulesEngineProperties

RulesEngineProperties

名称 说明 值
规则 定义特定规则引擎配置的规则列表。 RulesEngineRule[]

RulesEngineRule

名称 说明 值
action 满足所有匹配条件时对请求和响应执行的操作。 RulesEngineAction (必需)
matchConditions 为了运行此规则的操作，必须满足的匹配条件列表。 没有匹配条件意味着操作将始终运行。 RulesEngineMatchCondition[]
matchProcessingBehavior 如果此规则是匹配项，则规则引擎应继续运行剩余规则或停止。 如果不存在，则默认为“继续”。 'Continue'
'Stop'
name 要引用此特定规则的名称。 字符串 (必需)
priority 分配给此规则的优先级。 int (必需)

RulesEngineAction

名称 说明 值
requestHeaderActions 要从 AFD 请求应用到源的标头操作的列表。 HeaderAction[]
responseHeaderActions 要从 AFD 响应应用到客户端的标头操作的列表。 HeaderAction[]
routeConfigurationOverride 替代路由配置。 RouteConfiguration

HeaderAction

名称 说明 值
headerActionType 要应用于标头的操作类型。 “Append”
'Delete'
需要“覆盖” ()
headerName 此操作将应用到的标头的名称。 字符串 (必需)
value 用于更新给定标头名称的值。 如果 actionType 为 Delete，则不使用此值。 string

RouteConfiguration

名称 说明 值
@odata.type 设置对象类型 #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration (必需)

ForwardingConfiguration

名称 说明 值
@odata.type 需要“#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration” ()
backendPool 对此规则路由到的 BackendPool 的引用。 SubResource
cacheConfiguration 与此规则关联的缓存配置。 CacheConfiguration
customForwardingPath 用于重写此规则匹配的资源路径的自定义路径。 保留为空以使用传入路径。 字符串
forwardingProtocol 将流量转发到后端时此规则将使用的协议。 “HttpOnly”
'HttpsOnly'
“MatchRequest”

SubResource

名称 说明 Value
id 资源 ID。 字符串

CacheConfiguration

名称 说明 值
cacheDuration 需要缓存内容的持续时间。 允许的格式采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。 HTTP 要求该值不超过一年 字符串
dynamicCompression 是否对缓存的内容使用动态压缩 'Disabled'
'Enabled'
queryParameters 要包含或排除 (逗号分隔) 的查询参数。 string
queryParameterStripDirective 形成缓存密钥时的 URL 查询词的处理。 “StripAll”
'StripAllExcept'
“StripNone”
'StripOnly'

RedirectConfiguration

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

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'

Terraform (AzAPI 提供程序) 资源定义

frontDoors/rulesEngines 资源类型可以部署到：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Network/frontDoors/rulesEngines 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/frontDoors/rulesEngines@2020-05-01"
  name = "string"
  parent_id = "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"

属性值

frontDoors/rulesEngines

名称 说明 Value
type 资源类型 “Microsoft.Network/frontDoors/rulesEngines@2020-05-01”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为的资源的 ID： frontDoors
properties 规则引擎配置的属性。 RulesEngineProperties

RulesEngineProperties

名称 说明 值
规则 定义特定规则引擎配置的规则列表。 RulesEngineRule[]

RulesEngineRule

名称 说明 值
action 满足所有匹配条件时对请求和响应执行的操作。 RulesEngineAction (必需)
matchConditions 为了运行此规则的操作，必须满足的匹配条件列表。 没有匹配条件意味着操作将始终运行。 RulesEngineMatchCondition[]
matchProcessingBehavior 如果此规则是匹配项，则规则引擎应继续运行剩余规则或停止。 如果不存在，则默认为“继续”。 “继续”
"Stop"
name 要引用此特定规则的名称。 字符串 (必需)
priority 分配给此规则的优先级。 int (必需)

RulesEngineAction

名称 说明 值
requestHeaderActions 要从 AFD 请求应用到源的标头操作的列表。 HeaderAction[]
responseHeaderActions 要从 AFD 响应应用到客户端的标头操作的列表。 HeaderAction[]
routeConfigurationOverride 替代路由配置。 RouteConfiguration

HeaderAction

名称 说明 值
headerActionType 要应用于标头的操作类型。 “Append”
“Delete”
需要“覆盖” ()
headerName 此操作将应用到的标头的名称。 字符串 (必需)
value 用于更新给定标头名称的值。 如果 actionType 为 Delete，则不使用此值。 字符串

RouteConfiguration

名称 说明 值
@odata.type 设置对象类型 #Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration
#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration (必需)

ForwardingConfiguration

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

SubResource

名称 说明 Value
id 资源 ID。 string

CacheConfiguration

名称 说明 值
cacheDuration 需要缓存内容的持续时间。 允许的格式采用 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) 。 HTTP 要求该值不超过一年 字符串
dynamicCompression 是否对缓存的内容使用动态压缩 “Disabled”
“Enabled”
queryParameters 要包含或排除 (逗号分隔) 的查询参数。 字符串
queryParameterStripDirective 形成缓存密钥时的 URL 查询词的处理。 “StripAll”
“StripAllExcept”
“StripNone”
“StripOnly”

RedirectConfiguration

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

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”