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

az afd rule

注释

此引用是 Azure CLI (版本 2.85.0 或更高版本)的 cdn 扩展的一部分。 该扩展将在首次运行 az afd rule 命令时自动安装。 了解更多关于扩展程序的信息。

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

命令

名称 说明 类型 Status
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 action show

显示操作。

扩展 GA
az afd rule action update

更新操作。

扩展 GA
az afd rule action wait

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

扩展 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 condition show

显示条件。

扩展 GA
az afd rule condition update

更新条件。

扩展 GA
az afd rule condition wait

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

扩展 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 --rule-name
                   --profile-name
                   --resource-group
                   --rule-set-name
                   [--acquire-policy-token]
                   [--actions]
                   [--change-reference]
                   [--conditions]
                   [--match-processing-behavior {Continue, Stop}]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--order]

示例

Rules_Create

az afd rule create --resource-group RG --profile-name profile1 --rule-set-name ruleSet1 --rule-name rule1 --actions "[{parameters:{headerAction:Overwrite,headerName:X-CDN,typeName:DeliveryRuleHeaderActionParameters,value:MSFT},modify-response-header:{parameters:{headerAction:Overwrite,headerName:X-CDN,typeName:DeliveryRuleHeaderActionParameters,value:MSFT}}}]" --conditions "[{parameters:{matchValues:[GET],negateCondition:False,operator:Equal,typeName:DeliveryRuleRequestMethodConditionParameters},request-method:{parameters:{typeName:DeliveryRuleRequestMethodConditionParameters,match-values:[GET],negate-condition:False,operator:Equal}}}]" --order 1

Rules_Create_AfdUrlSigningAction

az afd rule create --resource-group RG --profile-name profile1 --rule-set-name ruleSet1 --rule-name rule1 --actions "[{parameters:{headerAction:Overwrite,headerName:X-CDN,typeName:DeliveryRuleHeaderActionParameters,value:MSFT},modify-response-header:{parameters:{headerAction:Overwrite,headerName:X-CDN,typeName:DeliveryRuleHeaderActionParameters,value:MSFT}}}]" --conditions "[{parameters:{matchValues:[GET],negateCondition:False,operator:Equal,typeName:DeliveryRuleRequestMethodConditionParameters},request-method:{parameters:{typeName:DeliveryRuleRequestMethodConditionParameters,match-values:[GET],negate-condition:False,operator:Equal}}}]" --order 1 --resource-group RG --profile-name profile1 --rule-set-name ruleSet1 --rule-name rule1 --actions "[{parameters:{algorithm:SHA256,keyGroupReference:{id:/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keygroups/kg1},parameterNameOverride:[{paramIndicator:Expires,paramName:Expiration-Date},{paramIndicator:Signature,paramName:Sig-Hash}],typeName:DeliveryRuleAfdUrlSigningActionParameters},afd-url-signing:{parameters:{algorithm:SHA256,key-group-reference:{id:/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keygroups/kg1},parameter-name-override:[{paramIndicator:Expires,paramName:Expiration-Date},{paramIndicator:Signature,paramName:Sig-Hash}],type-name:DeliveryRuleAfdUrlSigningActionParameters}}}]" --conditions "[{parameters:{matchValues:[GET],negateCondition:False,operator:Equal,typeName:DeliveryRuleRequestMethodConditionParameters},request-method:{parameters:{typeName:DeliveryRuleRequestMethodConditionParameters,match-values:[GET],negate-condition:False,operator:Equal}}}]" --order 1

必需参数

--name --rule-name -n

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

--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

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

--rule-set-name

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

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--actions

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

属性 值
参数组: Properties Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--conditions

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

属性 值
参数组: Properties Arguments
--match-processing-behavior

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

属性 值
参数组: Properties Arguments
默认值: Continue
接受的值: Continue, Stop
--no-wait

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

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

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

属性 值
参数组: Properties Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: 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 afd rule delete

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

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

示例

Rules_Delete

az afd rule delete --resource-group RG --profile-name profile1 --rule-set-name ruleSet1 --rule-name rule1

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--ids

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

属性 值
参数组: Resource Id Arguments
--name --rule-name -n

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

属性 值
参数组: Resource Id Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称,该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--rule-set-name

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az afd rule list

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

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

示例

Rules_ListByRuleSet

az afd rule list --resource-group RG --profile-name profile1 --rule-set-name ruleSet1

必需参数

--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

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

--rule-set-name

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

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--max-items

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

属性 值
参数组: Pagination Arguments
--next-token

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

属性 值
参数组: Pagination Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: 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 afd rule show

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

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

示例

Rules_Get

az afd rule show --resource-group RG --profile-name profile1 --rule-set-name ruleSet1 --rule-name rule1

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--ids

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

属性 值
参数组: Resource Id Arguments
--name --rule-name -n

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

属性 值
参数组: Resource Id Arguments
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称,该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--rule-set-name

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az afd rule update

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

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

示例

Rules_Create

az afd rule update --resource-group RG --profile-name profile1 --rule-set-name ruleSet1 --rule-name rule1 --actions "[{name:ModifyResponseHeader,parameters:{headerAction:Overwrite,headerName:X-CDN,typeName:DeliveryRuleHeaderActionParameters,value:MSFT}}]" --conditions "[{name:RequestMethod,parameters:{matchValues:[GET],negateCondition:False,operator:Equal,typeName:DeliveryRuleRequestMethodConditionParameters}}]" --order 1

Rules_Create_AfdUrlSigningAction

az afd rule update --resource-group RG --profile-name profile1 --rule-set-name ruleSet1 --rule-name rule1 --actions "[{name:ModifyResponseHeader,parameters:{headerAction:Overwrite,headerName:X-CDN,typeName:DeliveryRuleHeaderActionParameters,value:MSFT}}]" --conditions "[{name:RequestMethod,parameters:{matchValues:[GET],negateCondition:False,operator:Equal,typeName:DeliveryRuleRequestMethodConditionParameters}}]" --order 1 --resource-group RG --profile-name profile1 --rule-set-name ruleSet1 --rule-name rule1 --actions "[{name:AfdUrlSigning,parameters:{algorithm:SHA256,keyGroupReference:{id:/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/keygroups/kg1},parameterNameOverride:[{paramIndicator:Expires,paramName:Expiration-Date},{paramIndicator:Signature,paramName:Sig-Hash}],typeName:DeliveryRuleAfdUrlSigningActionParameters}}]" --conditions "[{name:RequestMethod,parameters:{matchValues:[GET],negateCondition:False,operator:Equal,typeName:DeliveryRuleRequestMethodConditionParameters}}]" --order 1

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--actions

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

属性 值
参数组: Properties Arguments
--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>。

属性 值
参数组: Generic Update Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--conditions

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

属性 值
参数组: Properties Arguments
--force-string

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

属性 值
参数组: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

属性 值
参数组: Resource Id Arguments
--match-processing-behavior

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

属性 值
参数组: Properties Arguments
接受的值: Continue, Stop
--name --rule-name -n

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

属性 值
参数组: Resource Id Arguments
--no-wait

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

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

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

属性 值
参数组: Properties Arguments
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称,该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--remove

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

属性 值
参数组: Generic Update Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--rule-set-name

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

属性 值
参数组: Resource Id Arguments
--set

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

属性 值
参数组: Generic Update Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az afd rule wait

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

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

可选参数

以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--created

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

属性 值
参数组: Wait Condition Arguments
默认值: False
--custom

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

属性 值
参数组: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
参数组: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
参数组: Wait Condition Arguments
默认值: False
--ids

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

属性 值
参数组: Resource Id Arguments
--interval

轮询间隔(以秒为单位)。

属性 值
参数组: Wait Condition Arguments
默认值: 30
--name --rule-name -n

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

属性 值
参数组: Resource Id Arguments
--profile-name

Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称,该配置文件在资源组中是唯一的。

属性 值
参数组: Resource Id Arguments
--resource-group -g

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

属性 值
参数组: Resource Id Arguments
--rule-set-name

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

属性 值
参数组: Resource Id Arguments
--subscription

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

属性 值
参数组: Resource Id Arguments
--timeout

最大等待(以秒为单位)。

属性 值
参数组: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
参数组: Wait Condition Arguments
默认值: False
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False