az afd rule

Note

此參考文獻是 Azure CLI（版本 2.85.0 或更高版本）cdn 擴充的一部分。 這個擴充功能會在你第一次執行 az afd 規則 指令時自動安裝。 深入了解擴充功能。

管理指定規則集中的傳遞規則。

命令

名稱 Description 類型 狀態
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 原則 令牌以進行此資源操作。

屬性 值
參數群組: 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

訂用帳戶的名稱或標識碼。 您可以使用 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 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: 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

訂用帳戶的名稱或標識碼。 您可以使用 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

訂用帳戶的名稱或標識碼。 您可以使用 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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: 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

訂用帳戶的名稱或標識碼。 您可以使用 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 原則 令牌以進行此資源操作。

屬性 值
參數群組: 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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: 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> 或 --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

訂用帳戶的名稱或標識碼。 您可以使用 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 原則 令牌以進行此資源操作。

屬性 值
參數群組: 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

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: 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

訂用帳戶的名稱或標識碼。 您可以使用 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