az afd route

Note

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

管理 AFD 端點下的路由。

命令

名稱	Description	類型	狀態
az afd route create	在指定的訂用帳戶、資源群組、配置檔和 AzureFrontDoor 端點下，建立具有指定路由名稱的新路由。	擴充功能	GA
az afd route delete	在指定的訂用帳戶、資源群組、配置檔和 AzureFrontDoor 端點下，刪除具有指定路由名稱的現有路由。	擴充功能	GA
az afd route list	列出配置檔內的所有現有原始來源。	擴充功能	GA
az afd route show	在指定的訂用帳戶、資源群組、配置檔和 AzureFrontDoor 端點下，取得具有指定路由名稱的現有路由。	擴充功能	GA
az afd route update	在指定的訂用帳戶、資源群組、配置檔和 AzureFrontDoor 端點下，以指定的路由名稱更新新的路由。	擴充功能	GA
az afd route wait	將 CLI 置於等候狀態，直到符合條件為止。	擴充功能	GA

az afd route create

在指定的訂用帳戶、資源群組、配置檔和 AzureFrontDoor 端點下，建立具有指定路由名稱的新路由。

az afd route create --endpoint-name
                    --name --route-name
                    --profile-name
                    --resource-group
                    [--acquire-policy-token]
                    [--cache-configuration]
                    [--change-reference]
                    [--enabled-state {Disabled, Enabled}]
                    [--formatted-custom-domains]
                    [--formatted-rule-sets]
                    [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                    [--https-redirect {Disabled, Enabled}]
                    [--link-to-default-domain {Disabled, Enabled}]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--origin-group]
                    [--origin-path]
                    [--patterns-to-match]
                    [--supported-protocols]

範例

Routes_Create

az afd route create --resource-group RG --profile-name profile1 --endpoint-name endpoint1 --route-name route1 --cache-configuration "{compression-settings:{content-types-to-compress:[text/html,application/octet-stream],is-compression-enabled:True},query-parameters:querystring=test,query-string-caching-behavior:IgnoreSpecifiedQueryStrings}" --formatted-custom-domains "[{id:/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1}]" --enabled-state Enabled --forwarding-protocol MatchRequest --https-redirect Enabled --link-to-default-domain Enabled --origin-group /subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1 --origin-path None --patterns-to-match "[/*]" --formatted-rule-sets "[{id:/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1}]" --supported-protocols "[Https,Http]"

必要參數

--endpoint-name

配置檔底下唯一的端點名稱。

--name --route-name -n

路由規則的名稱。

--profile-name

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

--resource-group -g

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

選擇性參數

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

--acquire-policy-token

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

屬性	值
參數群組:	Global Policy Arguments

--cache-configuration

此路由的快取組態。 若要停用快取，請勿提供 cacheConfiguration 物件。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--change-reference

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

屬性	值
參數群組:	Global Policy Arguments

--enabled-state

是否要啟用此規則的使用。 允許的值是 'Enabled' 或 'Disabled'。

屬性	值
參數群組:	Properties Arguments
接受的值:	Disabled, Enabled

--formatted-custom-domains

這個端點所參考的網域。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--formatted-rule-sets

此端點參考的規則集。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--forwarding-protocol

將流量轉送至後端時，會使用此規則的通訊協定。

屬性	值
參數群組:	Properties Arguments
預設值:	MatchRequest
接受的值:	HttpOnly, HttpsOnly, MatchRequest

--https-redirect

是否要自動將 HTTP 流量重新導向至 HTTPS 流量。 請注意，這是設定此規則的簡單方式，也是第一個執行的規則。

屬性	值
參數群組:	Properties Arguments
預設值:	Disabled
接受的值:	Disabled, Enabled

--link-to-default-domain

此路由是否會連結至預設端點網域。

屬性	值
參數群組:	Properties Arguments
預設值:	Disabled
接受的值:	Disabled, Enabled

--no-wait

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

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

--origin-group

要關聯之源群組的名稱或標識碼。

屬性	值
參數群組:	OriginGroup Arguments

--origin-path

來源上的目錄路徑，AzureFrontDoor 可用來擷取內容，例如 contoso.cloudapp.net/originpath。

屬性	值
參數群組:	Properties Arguments

--patterns-to-match

規則的路由模式。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--supported-protocols

此路由支援通訊協定的清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments
預設值:	['Http', 'Https']

全域參數

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

在指定的訂用帳戶、資源群組、配置檔和 AzureFrontDoor 端點下，刪除具有指定路由名稱的現有路由。

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

範例

Routes_Delete

az afd route delete --resource-group RG --profile-name profile1 --endpoint-name endpoint1 --route-name route1

選擇性參數

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

--acquire-policy-token

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

屬性	值
參數群組:	Global Policy Arguments

--change-reference

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

屬性	值
參數群組:	Global Policy Arguments

--endpoint-name

配置檔底下唯一的端點名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

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

屬性	值
參數群組:	Resource Id Arguments

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

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

列出配置檔內的所有現有原始來源。

az afd route list --endpoint-name
                  --profile-name
                  --resource-group
                  [--max-items]
                  [--next-token]

範例

Routes_ListByEndpoint

az afd route list --resource-group RG --profile-name profile1 --endpoint-name endpoint1

必要參數

--endpoint-name

配置檔底下唯一的端點名稱。

--profile-name

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

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<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 route show

在指定的訂用帳戶、資源群組、配置檔和 AzureFrontDoor 端點下，取得具有指定路由名稱的現有路由。

az afd route show [--endpoint-name]
                  [--ids]
                  [--name --route-name]
                  [--profile-name]
                  [--resource-group]
                  [--subscription]

範例

Routes_Get

az afd route show --resource-group RG --profile-name profile1 --endpoint-name endpoint1 --route-name route1

選擇性參數

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

--endpoint-name

配置檔底下唯一的端點名稱。

屬性	值
參數群組:	Resource Id Arguments

--ids

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

屬性	值
參數群組:	Resource Id Arguments

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

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

在指定的訂用帳戶、資源群組、配置檔和 AzureFrontDoor 端點下，以指定的路由名稱更新新的路由。

az afd route update [--acquire-policy-token]
                    [--add]
                    [--cache-configuration]
                    [--change-reference]
                    [--enabled-state {Disabled, Enabled}]
                    [--endpoint-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--formatted-custom-domains]
                    [--formatted-rule-sets]
                    [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                    [--https-redirect {Disabled, Enabled}]
                    [--ids]
                    [--link-to-default-domain {Disabled, Enabled}]
                    [--name --route-name]
                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                    [--origin-group]
                    [--origin-path]
                    [--patterns-to-match]
                    [--profile-name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--subscription]
                    [--supported-protocols]

範例

Routes_Create

az afd route update --resource-group RG --profile-name profile1 --endpoint-name endpoint1 --route-name route1 --cache-configuration "{compression-settings:{content-types-to-compress:[text/html,application/octet-stream],is-compression-enabled:True},query-parameters:querystring=test,query-string-caching-behavior:IgnoreSpecifiedQueryStrings}" --formatted-custom-domains "[{id:/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1}]" --enabled-state Enabled --forwarding-protocol MatchRequest --https-redirect Enabled --link-to-default-domain Enabled --origin-group /subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1 --origin-path None --patterns-to-match "[/*]" --formatted-rule-sets "[{id:/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1}]" --supported-protocols "[Https,Http]"

選擇性參數

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

--acquire-policy-token

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

屬性	值
參數群組:	Global Policy Arguments

--add

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

屬性	值
參數群組:	Generic Update Arguments

--cache-configuration

此路由的快取組態。 若要停用快取，請勿提供 cacheConfiguration 物件。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--change-reference

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

屬性	值
參數群組:	Global Policy Arguments

--enabled-state

是否要啟用此規則的使用。 允許的值是 'Enabled' 或 'Disabled'。

屬性	值
參數群組:	Properties Arguments
接受的值:	Disabled, Enabled

--endpoint-name

配置檔底下唯一的端點名稱。

屬性	值
參數群組:	Resource Id Arguments

--force-string

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

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

--formatted-custom-domains

這個端點所參考的網域。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--formatted-rule-sets

此端點參考的規則集。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--forwarding-protocol

將流量轉送至後端時，會使用此規則的通訊協定。

屬性	值
參數群組:	Properties Arguments
接受的值:	HttpOnly, HttpsOnly, MatchRequest

--https-redirect

是否要自動將 HTTP 流量重新導向至 HTTPS 流量。 請注意，這是設定此規則的簡單方式，也是第一個執行的規則。

屬性	值
參數群組:	Properties Arguments
接受的值:	Disabled, Enabled

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--link-to-default-domain

此路由是否會連結至預設端點網域。

屬性	值
參數群組:	Properties Arguments
接受的值:	Disabled, Enabled

--name --route-name -n

路由規則的名稱。

屬性	值
參數群組:	Resource Id Arguments

--no-wait

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

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

--origin-group

要關聯之源群組的名稱或標識碼。

屬性	值
參數群組:	OriginGroup Arguments

--origin-path

來源上的目錄路徑，AzureFrontDoor 可用來擷取內容，例如 contoso.cloudapp.net/originpath。

屬性	值
參數群組:	Properties Arguments

--patterns-to-match

規則的路由模式。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

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

--set

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

屬性	值
參數群組:	Generic Update Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--supported-protocols

此路由支援通訊協定的清單。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

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

--verbose

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

屬性	值
預設值:	False

az afd route wait

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

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

--endpoint-name

配置檔底下唯一的端點名稱。

屬性	值
參數群組:	Resource Id Arguments

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

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

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