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

az afd rule

管理指定规则集中的传递规则。

命令

名称	说明	类型	状态
az afd rule action	管理指定规则集中的传递规则。	核心	GA
az afd rule action add	更新指定规则集中的新传递规则。	核心	GA
az afd rule action list	获取规则集中的现有传递规则。	核心	GA
az afd rule action remove	更新指定规则集中的新传递规则。	核心	GA
az afd rule condition	管理指定规则集中的传递规则。	核心	GA
az afd rule condition add	更新指定规则集中的新传递规则。	核心	GA
az afd rule condition list	获取规则集中的现有传递规则。	核心	GA
az afd rule condition remove	更新指定规则集中的新传递规则。	核心	GA
az afd rule create	在指定的规则集中创建新的传递规则。	核心	GA
az afd rule delete	删除规则集中的现有传递规则。	核心	GA
az afd rule list	列出规则集中的所有现有传递规则。	核心	GA
az afd rule show	获取规则集中的现有传递规则。	核心	GA
az afd rule update	更新指定规则集中的新传递规则。	核心	GA
az afd rule wait	将 CLI 置于等待状态，直到满足条件。	核心	GA

az afd rule create

在指定的规则集中创建新的传递规则。

az afd rule create --name
                   --profile-name
                   --resource-group
                   --rule-set-name
                   [--action-name]
                   [--cache-behavior]
                   [--cache-duration]
                   [--custom-fragment]
                   [--custom-hostname]
                   [--custom-path]
                   [--custom-querystring]
                   [--destination]
                   [--enable-caching {0, 1, f, false, n, no, t, true, y, yes}]
                   [--enable-compression {0, 1, f, false, n, no, t, true, y, yes}]
                   [--forwarding-protocol]
                   [--header-action]
                   [--header-name]
                   [--header-value]
                   [--match-processing-behavior {Continue, Stop}]
                   [--match-values]
                   [--match-variable]
                   [--negate-condition {0, 1, f, false, n, no, t, true, y, yes}]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--operator]
                   [--order]
                   [--origin-group]
                   [--preserve-unmatched-path {0, 1, f, false, n, no, t, true, y, yes}]
                   [--query-parameters]
                   [--query-string-caching-behavior]
                   [--redirect-protocol]
                   [--redirect-type]
                   [--selector]
                   [--source-pattern]
                   [--transforms]

示例

创建规则，为来自泰国的请求追加响应标头。

az afd rule create -g group --rule-set-name ruleset1 --profile-name profile --order 2 --match-variable RemoteAddress --operator GeoMatch --match-values TH --rule-name disablecaching --action-name ModifyResponseHeader --header-action Append --header-name X-CDN --header-value AFDX

为 http 到 https 重定向创建规则

az afd rule create -g group --rule-set-name ruleset1 --profile-name profile --order 1 --rule-name "redirect" --match-variable RequestScheme --operator Equal --match-values HTTP --action-name "UrlRedirect" --redirect-protocol Https --redirect-type Moved

必需参数

--name --rule-name -n

终结点中唯一的传递规则的名称。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称，该配置文件在资源组中是唯一的。

--resource-group -g

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

--rule-set-name

配置文件下的规则集的名称。

可选参数

--action-name

传递规则的操作的名称： https://docs.microsoft.com/en-us/azure/frontdoor/front-door-rules-engine-actions。

--cache-behavior

请求的缓存行为。

--cache-duration

需要缓存内容的持续时间。 允许的格式为 [d.]hh：mm：ss。

--custom-fragment

要添加到重定向 URL 的片段。

--custom-hostname

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

--custom-path

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

--custom-querystring

要放置在重定向 URL 中的查询字符串集。留空以保留传入的查询字符串。

--destination

要在重写中使用的目标路径。

--enable-caching

指示是否在路由上启用缓存。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--enable-compression

指示是否在 AzureFrontDoor 上启用内容压缩。 默认值为 false。如果启用了压缩，则如果用户请求压缩版本，内容将作为压缩。请求的内容不会压缩到 AzureFrontDoorhen 请求的内容小于 1 字节或大于 1 MB。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--forwarding-protocol

将流量转发到后端时此规则将使用的协议。

--header-action

请求的标头操作。

--header-name

要修改的标头的名称。

--header-value

标头的值。

--match-processing-behavior

如果此规则是匹配规则，则规则引擎应继续运行剩余规则或停止。 如果不存在，则默认为“继续”。

接受的值: Continue, Stop

默认值: Continue

--match-values

匹配条件的匹配值。 例如，空格分隔值“GET”“HTTP”。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--match-variable

匹配条件的名称： https://docs.microsoft.com/en-us/azure/frontdoor/rules-match-conditions。

--negate-condition

如果为 true，则否定条件。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--operator

匹配条件的运算符。

--order

为终结点应用规则的顺序。 可能的值 {0,1,2,3，¦ ¦¦ Â'？¦¦ ¦}。 具有较低顺序的规则将在具有较大顺序的规则之前应用。 具有顺序 0 的规则是一个特殊规则。 它不需要任何条件，并且它中列出的操作将始终应用。

--origin-group

将替代默认 OriginGroup 的 OriginGroup 的名称或 ID。

--preserve-unmatched-path

如果为 True，则源模式后的剩余路径将追加到新的目标路径。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--query-parameters

要包含或排除的查询参数。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--query-string-caching-behavior

定义 CDN 如何缓存包含查询字符串的请求。缓存时，可以忽略任何查询字符串，绕过缓存以防止包含查询字符串的请求被缓存，或缓存每个请求的唯一 URL。

--redirect-protocol

要用于重定向的协议。

--redirect-type

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

--selector

匹配条件的选择器。

--source-pattern

一种请求 URI 模式，用于标识可能重写的请求类型。

--transforms

转换以在匹配之前应用。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az afd rule delete

删除规则集中的现有传递规则。

az afd rule delete [--ids]
                   [--name]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--profile-name]
                   [--resource-group]
                   [--rule-set-name]
                   [--subscription]
                   [--yes]

示例

删除名称规则 1 的规则。

az afd rule delete -g group --rule-set-name ruleSetName --profile-name profile --rule-name rule1

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name --rule-name -n

终结点中唯一的传递规则的名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称，该配置文件在资源组中是唯一的。

--resource-group -g

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

--rule-set-name

配置文件下的规则集的名称。

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az afd rule list

列出规则集中的所有现有传递规则。

az afd rule list --profile-name
                 --resource-group
                 --rule-set-name
                 [--max-items]
                 [--next-token]

示例

列出指定终结点中的所有路由。

az afd route list -g group --profile-name profile --endpoint-name endpoint1

必需参数

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称，该配置文件在资源组中是唯一的。

--resource-group -g

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

--rule-set-name

配置文件下的规则集的名称。

可选参数

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az afd rule show

获取规则集中的现有传递规则。

az afd rule show [--ids]
                 [--name]
                 [--profile-name]
                 [--resource-group]
                 [--rule-set-name]
                 [--subscription]

示例

显示名称规则 1 的传递规则的详细信息。

az afd rule show -g group --rule-set-name ruleSetName --profile-name profile --rule-name rule1

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name --rule-name -n

终结点中唯一的传递规则的名称。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称，该配置文件在资源组中是唯一的。

--resource-group -g

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

--rule-set-name

配置文件下的规则集的名称。

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az afd rule update

更新指定规则集中的新传递规则。

az afd rule update [--actions]
                   [--add]
                   [--conditions]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--match-processing-behavior {Continue, Stop}]
                   [--name]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--order]
                   [--profile-name]
                   [--remove]
                   [--resource-group]
                   [--rule-set-name]
                   [--set]
                   [--subscription]

可选参数

--actions

满足规则的所有条件时执行的操作列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--conditions

必须匹配要执行的操作的条件列表，支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--match-processing-behavior

如果此规则是匹配规则，则规则引擎应继续运行剩余规则或停止。 如果不存在，则默认为“继续”。

接受的值: Continue, Stop

--name --rule-name -n

终结点中唯一的传递规则的名称。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--order

为终结点应用规则的顺序。 可能的值 {0,1,2,3，ƑЕ'†â€™ŠƑ ？Â-Ƒ‚Ƒ ƑÄ'ྡྷ࿢ ƑЕ'†™â'ƒЕ'Â'Â'ƑƒƑƑƑƑƑƑ...Â-Ƒ‚Ƒ ƑÄ'ྡྷ࿢ ƑЕ'†™â'ƒЕ'Â'Â'ƑƒƑƑƑƑƑƑ...Â-Ƒ‚ƑÄ'Â'ྡྷྡྷ'¦}. 具有较低顺序的规则将在具有较大顺序的规则之前应用。 具有顺序 0 的规则是一个特殊规则。 它不需要任何条件，并且它中列出的操作将始终应用。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称，该配置文件在资源组中是唯一的。

--remove

从列表中删除属性或元素。 示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--rule-set-name

配置文件下的规则集的名称。

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=。

--subscription

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az afd rule wait

将 CLI 置于等待状态，直到满足条件。

az afd rule wait [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--ids]
                 [--interval]
                 [--name]
                 [--profile-name]
                 [--resource-group]
                 [--rule-set-name]
                 [--subscription]
                 [--timeout]
                 [--updated]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name --rule-name -n

终结点中唯一的传递规则的名称。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称，该配置文件在资源组中是唯一的。

--resource-group -g

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

--rule-set-name

配置文件下的规则集的名称。

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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