az network front-door rules-engine rule action

Note

This reference is part of the front-door extension for the Azure CLI (version 2.67.0 or higher). 该扩展将在首次运行 az network front-door rules-engine rule action 命令时自动安装。 Learn more about extensions.

管理 Front Door 的规则引擎操作。

命令

名称	说明	类型	Status
az network front-door rules-engine rule action add	向规则引擎规则添加操作。	Extension	GA
az network front-door rules-engine rule action list	显示适用于规则引擎规则的所有操作。	Extension	GA
az network front-door rules-engine rule action remove	从规则引擎规则中删除操作。	Extension	GA

az network front-door rules-engine rule action add

向规则引擎规则添加操作。

az network front-door rules-engine rule action add --action-type {ForwardRouteOverride, RedirectRouteOverride, RequestHeader, ResponseHeader}
                                                   --front-door-name
                                                   --name
                                                   --resource-group
                                                   --rules-engine-name
                                                   [--backend-pool]
                                                   [--cache-duration]
                                                   [--caching {Disabled, Enabled}]
                                                   [--custom-forwarding-path]
                                                   [--custom-fragment]
                                                   [--custom-host]
                                                   [--custom-path]
                                                   [--custom-query-string]
                                                   [--dynamic-compression {Disabled, Enabled}]
                                                   [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                                                   [--header-action {Append, Delete, Overwrite}]
                                                   [--header-name]
                                                   [--header-value]
                                                   [--query-parameter-strip-directive {StripAll, StripAllExcept, StripNone, StripOnly}]
                                                   [--query-parameters]
                                                   [--redirect-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                                                   [--redirect-type {Found, Moved, PermanentRedirect, TemporaryRedirect}]

必需参数

--action-type

要应用于规则的作类型。

属性	值
Parameter group:	Action Arguments
接受的值:	ForwardRouteOverride, RedirectRouteOverride, RequestHeader, ResponseHeader

--front-door-name -f

Front Door 的名称。

--name -n

规则的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--rules-engine-name -r

规则引擎的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--backend-pool

后端池的名称或 ID。

属性	值
Parameter group:	Forward Route Override Arguments

--cache-duration

需要缓存内容的持续时间。 允许的格式为 ISO 8601 持续时间。

属性	值
Parameter group:	Forward Route Override Arguments

--caching

是否为此路由启用缓存。

属性	值
Parameter group:	Forward Route Override Arguments
接受的值:	Disabled, Enabled

--custom-forwarding-path

用于重写此规则匹配的资源路径的自定义路径。 留空以使用传入路径。

属性	值
Parameter group:	Forward Route Override Arguments

--custom-fragment

要添加到重定向 URL 的片段。 片段是 #之后 URL 的一部分。 请勿包含 #。

属性	值
Parameter group:	Redirect Route Override Arguments

--custom-host

要重定向的主机。 保留为空，以使用传入主机作为目标主机。

属性	值
Parameter group:	Redirect Route Override Arguments

--custom-path

要重定向的完整路径。 路径不能为空，必须以 /开头。 将传入路径保留为空，以用作目标路径。

属性	值
Parameter group:	Redirect Route Override Arguments

--custom-query-string

要放置在重定向 URL 中的查询字符串集。 设置此值将替换任何现有查询字符串;保留空以保留传入的查询字符串。 查询字符串必须采用 <key>=<value> 格式。 第一个？ 并且会自动添加 &，因此不要在前面包含它们，但使用 &分隔多个查询字符串。

属性	值
Parameter group:	Redirect Route Override Arguments

--dynamic-compression

对缓存内容使用动态压缩。

属性	值
Parameter group:	Forward Route Override Arguments
接受的值:	Disabled, Enabled

--forwarding-protocol

用于转发流量的协议。

属性	值
Parameter group:	Forward Route Override Arguments
接受的值:	HttpOnly, HttpsOnly, MatchRequest

--header-action

请求的标头作类型。

属性	值
Parameter group:	Action Arguments
接受的值:	Append, Delete, Overwrite

--header-name

要修改的标头的名称。

属性	值
Parameter group:	Action Arguments

--header-value

标头的值。

属性	值
Parameter group:	Action Arguments

--query-parameter-strip-directive

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

属性	值
Parameter group:	Forward Route Override Arguments
接受的值:	StripAll, StripAllExcept, StripNone, StripOnly

--query-parameters

当分别使用 query-parameter-strip-指令类型 StripAllExcept 或 StripOnly 时，要包含或排除的查询参数（逗号分隔）。

属性	值
Parameter group:	Forward Route Override Arguments

--redirect-protocol

将流量重定向到的目标的协议。

属性	值
Parameter group:	Redirect Route Override Arguments
默认值:	MatchRequest
接受的值:	HttpOnly, HttpsOnly, MatchRequest

--redirect-type

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

属性	值
Parameter group:	Redirect Route Override Arguments
默认值:	Moved
接受的值:	Found, Moved, PermanentRedirect, TemporaryRedirect

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az network front-door rules-engine rule action list

显示适用于规则引擎规则的所有操作。

az network front-door rules-engine rule action list --front-door-name
                                                    --name
                                                    --resource-group
                                                    --rules-engine-name

必需参数

--front-door-name -f

Front Door 的名称。

--name -n

规则的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--rules-engine-name -r

规则引擎的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az network front-door rules-engine rule action remove

从规则引擎规则中删除操作。

az network front-door rules-engine rule action remove --action-type {ForwardRouteOverride, RedirectRouteOverride, RequestHeader, ResponseHeader}
                                                      --front-door-name
                                                      --name
                                                      --resource-group
                                                      --rules-engine-name
                                                      [--index]

必需参数

--action-type

要应用于规则的作类型。

属性	值
Parameter group:	Action Arguments
接受的值:	ForwardRouteOverride, RedirectRouteOverride, RequestHeader, ResponseHeader

--front-door-name -f

Front Door 的名称。

--name -n

规则的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--rules-engine-name -r

规则引擎的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--index

要删除的请求或响应标头作的基于 0 的索引。 删除“ForwardRouteOverride”或“RedirectRouteOverride”作不需要索引参数。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False