az afd rule action

Note

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

管理行動。

命令

名稱	Description	類型	狀態
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 action add

創造行動。

az afd rule action add --action-name {AfdUrlSigning, CacheExpiration, CacheKeyQueryString, EdgeAction, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, RouteConfigurationOverride, UrlRedirect, UrlRewrite, UrlSigning}
                       --profile-name
                       --resource-group
                       --rule-name
                       --rule-set-name
                       [--acquire-policy-token]
                       [--afd-url-signing]
                       [--cache-expiration]
                       [--cache-key-query-string]
                       [--change-reference]
                       [--edge-action]
                       [--modify-request-header]
                       [--modify-response-header]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--origin-group-override]
                       [--route-config --route-configuration-override]
                       [--url-redirect]
                       [--url-rewrite]
                       [--url-signing]

必要參數

--action-name

投送規則中動作的名稱。

屬性	值
接受的值:	AfdUrlSigning, CacheExpiration, CacheKeyQueryString, EdgeAction, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, RouteConfigurationOverride, UrlRedirect, UrlRewrite, UrlSigning

--profile-name

該名稱為 Azure Front Door Standard 或 Azure Front Door Premium 設定檔，該設定檔在資源群組中獨一無二。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--rule-name

端點內唯一的傳遞規則名稱。

--rule-set-name

配置檔底下的規則集名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--afd-url-signing

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--cache-expiration

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--cache-key-query-string

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--change-reference

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

屬性	值
參數群組:	Global Policy Arguments

--edge-action

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--modify-request-header

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--modify-response-header

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--no-wait

請勿等候長時間執行的作業完成。

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

--origin-group-override

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--route-config --route-configuration-override

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--url-redirect

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--url-rewrite

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--url-signing

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] 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 action list

名單行動。

az afd rule action list --profile-name
                        --resource-group
                        --rule-name
                        --rule-set-name

必要參數

--profile-name

該名稱為 Azure Front Door Standard 或 Azure Front Door Premium 設定檔，該設定檔在資源群組中獨一無二。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--rule-name

端點內唯一的傳遞規則名稱。

--rule-set-name

配置檔底下的規則集名稱。

全域參數

--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 action remove

刪除動作。

az afd rule action remove --action-name {AfdUrlSigning, CacheExpiration, CacheKeyQueryString, EdgeAction, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, RouteConfigurationOverride, UrlRedirect, UrlRewrite, UrlSigning}
                          --profile-name
                          --resource-group
                          --rule-name
                          --rule-set-name
                          [--acquire-policy-token]
                          [--change-reference]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--yes]

必要參數

--action-name

投送規則中動作的名稱。

屬性	值
接受的值:	AfdUrlSigning, CacheExpiration, CacheKeyQueryString, EdgeAction, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, RouteConfigurationOverride, UrlRedirect, UrlRewrite, UrlSigning

--profile-name

該名稱為 Azure Front Door Standard 或 Azure Front Door Premium 設定檔，該設定檔在資源群組中獨一無二。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--rule-name

端點內唯一的傳遞規則名稱。

--rule-set-name

配置檔底下的規則集名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

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

屬性	值
參數群組:	Global Policy Arguments

--no-wait

請勿等候長時間執行的作業完成。

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

--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/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az afd rule action show

展現行動。

az afd rule action show --action-name {AfdUrlSigning, CacheExpiration, CacheKeyQueryString, EdgeAction, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, RouteConfigurationOverride, UrlRedirect, UrlRewrite, UrlSigning}
                        --profile-name
                        --resource-group
                        --rule-name
                        --rule-set-name

必要參數

--action-name

投送規則中動作的名稱。

屬性	值
接受的值:	AfdUrlSigning, CacheExpiration, CacheKeyQueryString, EdgeAction, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, RouteConfigurationOverride, UrlRedirect, UrlRewrite, UrlSigning

--profile-name

該名稱為 Azure Front Door Standard 或 Azure Front Door Premium 設定檔，該設定檔在資源群組中獨一無二。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--rule-name

端點內唯一的傳遞規則名稱。

--rule-set-name

配置檔底下的規則集名稱。

全域參數

--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 action update

更新行動。

az afd rule action update --action-name {AfdUrlSigning, CacheExpiration, CacheKeyQueryString, EdgeAction, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, RouteConfigurationOverride, UrlRedirect, UrlRewrite, UrlSigning}
                          --profile-name
                          --resource-group
                          --rule-name
                          --rule-set-name
                          [--acquire-policy-token]
                          [--add]
                          [--afd-url-signing]
                          [--cache-expiration]
                          [--cache-key-query-string]
                          [--change-reference]
                          [--edge-action]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--modify-request-header]
                          [--modify-response-header]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--origin-group-override]
                          [--remove]
                          [--route-config --route-configuration-override]
                          [--set]
                          [--url-redirect]
                          [--url-rewrite]
                          [--url-signing]

範例

更新快取過期動作。

az afd rule action update -g group --profile-name profile --rule-set-name ruleset --rule-name rule --action-name CacheExpiration --cache-expiration "{parameters:{cache-behavior:BypassCache,cache-type:All}}"

必要參數

--action-name

投送規則中動作的名稱。

屬性	值
接受的值:	AfdUrlSigning, CacheExpiration, CacheKeyQueryString, EdgeAction, ModifyRequestHeader, ModifyResponseHeader, OriginGroupOverride, RouteConfigurationOverride, UrlRedirect, UrlRewrite, UrlSigning

--profile-name

該名稱為 Azure Front Door Standard 或 Azure Front Door Premium 設定檔，該設定檔在資源群組中獨一無二。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--rule-name

端點內唯一的傳遞規則名稱。

--rule-set-name

配置檔底下的規則集名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例： --add property.listProperty <key=value, string or JSON string>.

屬性	值
參數群組:	Generic Update Arguments

--afd-url-signing

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--cache-expiration

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--cache-key-query-string

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--change-reference

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

屬性	值
參數群組:	Global Policy Arguments

--edge-action

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--modify-request-header

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--modify-response-header

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--no-wait

請勿等候長時間執行的作業完成。

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

--origin-group-override

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments

--route-config --route-configuration-override

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--set

指定要設定的屬性路徑和值，以更新物件。 範例： --set property1.property2=<value>.

屬性	值
參數群組:	Generic Update Arguments

--url-redirect

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--url-rewrite

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] Arguments

--url-signing

支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Rule.properties.actions[] 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 action wait

將 CLI 置於等候狀態，直到符合條件為止。

az afd rule action wait [--acquire-policy-token]
                        [--change-reference]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--profile-name]
                        [--resource-group]
                        [--rule-name]
                        [--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

--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-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