az network front-door routing-rule

注意

此參考是 Azure CLI 前端延伸模組的一部分（2.57.0 版或更高版本）。 擴充功能會在您第一次執行 az network front-door routing-rule 命令時自動安裝。 深入了解擴充功能。

管理 Front Door 路由規則。

命令

名稱	Description	類型	狀態
az network front-door routing-rule create	建立 Front Door 路由規則。	副檔名	GA
az network front-door routing-rule delete	刪除 Front Door 路由規則。	副檔名	GA
az network front-door routing-rule list	列出 Front Door 路由規則。	副檔名	GA
az network front-door routing-rule show	取得 Front Door 路由規則的詳細數據。	副檔名	GA
az network front-door routing-rule update	更新 Front Door 路由規則。	副檔名	GA

az network front-door routing-rule create

建立 Front Door 路由規則。

建立 Front Door 路由規則，將要求轉送至後端，或將使用者重新導向至不同的 URL。

範例 1：az network front-door routing-rule create -f frontdoor1 -g rg1 --frontend-endpoints DefaultFrontendEndpoint --route-type Forward --backend-pool DefaultBackendPool -n forwardRoutingrule1 --patterns /forward1

範例 2：az network front-door routing-rule create -f frontdoor1 -g rg1 --frontend-endpoints DefaultFrontendEndpoint --route-type Redirect --custom-host redirecthost.com -n redirectRouteRule1 --patterns /redirect1 --custom-query-string querystring。

az network front-door routing-rule create --front-door-name
                                          --frontend-endpoints
                                          --name
                                          --resource-group
                                          --route-type {Forward, Redirect}
                                          [--accepted-protocols]
                                          [--backend-pool]
                                          [--cache-duration]
                                          [--caching {Disabled, Enabled}]
                                          [--custom-forwarding-path]
                                          [--custom-fragment]
                                          [--custom-host]
                                          [--custom-path]
                                          [--custom-query-string]
                                          [--disabled {false, true}]
                                          [--dynamic-compression {Disabled, Enabled}]
                                          [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                                          [--patterns]
                                          [--query-parameter-strip-directive {StripAll, StripAllExcept, StripNone, StripOnly}]
                                          [--query-parameters]
                                          [--redirect-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                                          [--redirect-type {Found, Moved, PermanentRedirect, TemporaryRedirect}]
                                          [--rules-engine]

必要參數

--front-door-name -f

Front Door 的名稱。

--frontend-endpoints

前端端點名稱或標識符的空間分隔清單。

--name -n

路由規則的名稱。

--resource-group -g

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

--route-type

路由類型，以定義 Front Door 應該如何處理此路由的要求，也就是將它們轉送至後端，或將使用者重新導向至不同的 URL。

接受的值: Forward, Redirect

選擇性參數

--accepted-protocols

要接受之通訊協議的空間分隔清單。 預設值：Http。

--backend-pool

後端集區的名稱或識別碼。 需要建立轉送路由規則。

--cache-duration

需要快取內容的持續時間。 允許的格式為 ISO 8601 持續時間。

--caching

是否要啟用此路由的快取。

接受的值: Disabled, Enabled

--custom-forwarding-path

用來重寫此規則所比對之資源路徑的自定義路徑。 保留空白以使用傳入路徑。

--custom-fragment

要新增至重新導向 URL 的片段。 片段是之後 URL 的一部分。 請勿包含 #。

--custom-host

要重新導向的主機。 保留空白，以使用傳入主機作為目的地主機。

--custom-path

要重新導向的完整路徑。 路徑不可以是空的，而且必須以 /開頭。 保留空白，以使用傳入路徑作為目的地路徑。

--custom-query-string

要放在重新導向 URL 中的查詢字串集。 設定此值會取代任何現有的查詢字串;保留空白以保留傳入查詢字串。 查詢字串必須是 = 格式。 第一個 ？ 和 和 會自動新增，因此請勿將它們包含在前面，但會使用 和 分隔多個查詢字串。

--disabled

以停用狀態建立。

接受的值: false, true

--dynamic-compression

針對快取的內容使用動態壓縮。

接受的值: Disabled, Enabled

--forwarding-protocol

用於轉送流量的通訊協定。

接受的值: HttpOnly, HttpsOnly, MatchRequest

--patterns

要比對之模式的空間分隔清單。 預設值：『/*』。

--query-parameter-strip-directive

在形成快取索引鍵時處理 URL 查詢字詞。

接受的值: StripAll, StripAllExcept, StripNone, StripOnly

--query-parameters

分別使用 query-parameter-strip-指示詞類型 StripAllExcept 或 StripOn 時，要包含或排除的查詢參數（逗號分隔）。

--redirect-protocol

將流量重新導向目的地的通訊協定。

接受的值: HttpOnly, HttpsOnly, MatchRequest

預設值: MatchRequest

--redirect-type

重新導向類型，規則會在重新導向流量時使用。

接受的值: Found, Moved, PermanentRedirect, TemporaryRedirect

預設值: Moved

--rules-engine

規則引擎組態的名稱或識別碼。 若要取消連結屬性 --remove rulesEngine”

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

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

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az network front-door routing-rule delete

刪除 Front Door 路由規則。

az network front-door routing-rule delete --front-door-name
                                          --name
                                          --resource-group

必要參數

--front-door-name -f

Front Door 的名稱。

--name -n

路由規則的名稱。

--resource-group -g

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

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

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az network front-door routing-rule list

列出 Front Door 路由規則。

az network front-door routing-rule list --front-door-name
                                        --resource-group

必要參數

--front-door-name -f

Front Door 的名稱。

--resource-group -g

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

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

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az network front-door routing-rule show

取得 Front Door 路由規則的詳細數據。

az network front-door routing-rule show --front-door-name
                                        --name
                                        --resource-group

必要參數

--front-door-name -f

Front Door 的名稱。

--name -n

路由規則的名稱。

--resource-group -g

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

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

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az network front-door routing-rule update

更新 Front Door 路由規則。

az network front-door routing-rule update --front-door-name
                                          --name
                                          --resource-group
                                          [--accepted-protocols]
                                          [--add]
                                          [--backend-pool]
                                          [--cache-duration]
                                          [--caching {Disabled, Enabled}]
                                          [--custom-forwarding-path]
                                          [--custom-fragment]
                                          [--custom-host]
                                          [--custom-path]
                                          [--custom-query-string]
                                          [--dynamic-compression {Disabled, Enabled}]
                                          [--enabled {Disabled, Enabled}]
                                          [--force-string]
                                          [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                                          [--frontend-endpoints]
                                          [--patterns]
                                          [--query-parameter-strip-directive {StripAll, StripAllExcept, StripNone, StripOnly}]
                                          [--query-parameters]
                                          [--redirect-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                                          [--redirect-type {Found, Moved, PermanentRedirect, TemporaryRedirect}]
                                          [--remove]
                                          [--rules-engine]
                                          [--set]

必要參數

--front-door-name -f

Front Door 的名稱。

--name -n

路由規則的名稱。

--resource-group -g

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

選擇性參數

--accepted-protocols

要接受之通訊協議的空間分隔清單。 預設值：Http。

--add

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

預設值: []

--backend-pool

後端集區的名稱或識別碼。 需要建立轉送路由規則。

--cache-duration

需要快取內容的持續時間。 允許的格式為 ISO 8601 持續時間。

--caching

是否要啟用此路由的快取。

接受的值: Disabled, Enabled

--custom-forwarding-path

用來重寫此規則所比對之資源路徑的自定義路徑。 保留空白以使用傳入路徑。

--custom-fragment

要新增至重新導向 URL 的片段。 片段是之後 URL 的一部分。 請勿包含 #。

--custom-host

要重新導向的主機。 保留空白，以使用傳入主機作為目的地主機。

--custom-path

要重新導向的完整路徑。 路徑不可以是空的，而且必須以 /開頭。 保留空白，以使用傳入路徑作為目的地路徑。

--custom-query-string

要放在重新導向 URL 中的查詢字串集。 設定此值會取代任何現有的查詢字串;保留空白以保留傳入查詢字串。 查詢字串必須是 = 格式。 第一個 ？ 和 和 會自動新增，因此請勿將它們包含在前面，但會使用 和 分隔多個查詢字串。

--dynamic-compression

針對快取的內容使用動態壓縮。

接受的值: Disabled, Enabled

--enabled

已啟用狀態。

接受的值: Disabled, Enabled

--force-string

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

預設值: False

--forwarding-protocol

用於轉送流量的通訊協定。

接受的值: HttpOnly, HttpsOnly, MatchRequest

--frontend-endpoints

前端端點名稱或標識符的空間分隔清單。

--patterns

要比對之模式的空間分隔清單。 預設值：『/*』。

--query-parameter-strip-directive

在形成快取索引鍵時處理 URL 查詢字詞。

接受的值: StripAll, StripAllExcept, StripNone, StripOnly

--query-parameters

分別使用 query-parameter-strip-指示詞類型 StripAllExcept 或 StripOn 時，要包含或排除的查詢參數（逗號分隔）。

--redirect-protocol

將流量重新導向目的地的通訊協定。

接受的值: HttpOnly, HttpsOnly, MatchRequest

--redirect-type

重新導向類型，規則會在重新導向流量時使用。

接受的值: Found, Moved, PermanentRedirect, TemporaryRedirect

--remove

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

預設值: []

--rules-engine

規則引擎組態的名稱或識別碼。 若要取消連結屬性 --remove rulesEngine”

--set

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

預設值: []

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

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

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。