az network vhub connection

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.55.0 or higher). 當您第一次執行 az network vhub connection 命令時，擴充功能會自動安裝。 Learn more about extensions.

管理虛擬中樞 VNet 連線。

命令

名稱	Description	類型	狀態
az network vhub connection create	建立虛擬中樞 VNet 連線。	Extension	GA
az network vhub connection delete	刪除虛擬中樞 VNet 連線。	Extension	GA
az network vhub connection list	列出虛擬中樞 VNet 連線。	Extension	GA
az network vhub connection show	取得虛擬中樞 VNet 連線的詳細數據。	Extension	GA
az network vhub connection update	更新虛擬中樞連線的設定。	Extension	GA
az network vhub connection wait	將 CLI 置於等候狀態，直到符合條件為止。	Extension	GA

az network vhub connection create

建立虛擬中樞 VNet 連線。

az network vhub connection create --name
                                  --remote-vnet
                                  --resource-group
                                  --vhub-name
                                  [--address-prefixes]
                                  [--associated --associated-route-table]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--internet-security {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--labels]
                                  [--next-hop]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--propagated --propagated-route-tables]
                                  [--remote-vnet-transit {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--route-name]
                                  [--use-hub-vnet-gateways {0, 1, f, false, n, no, t, true, y, yes}]

範例

建立虛擬中樞 VNet 連線，而不需路由設定。

az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNet

使用路由設定建立虛擬中樞 VNet 連線。

az network vhub connection create -n MyConnection --vhub-name MyHub -g MyRG --remote-vnet MyVNet --associated-route-table /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable1 --propagated-route-tables /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable1 /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/RouteTable2 --labels label1 label2 --route-name route1 --next-hop 70.0.0.2 --address-prefixes 10.80.0.0/16 10.90.0.0/16

必要參數

--name -n

連接的名稱。

--remote-vnet

要連線之遠端 VNet 的識別碼名稱。

--resource-group -g

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

--vhub-name

虛擬中樞的名稱。

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--address-prefixes

預覽

所有地址前綴的空間分隔清單。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
Parameter group:	Routing Configuration Arguments

--associated --associated-route-table

預覽

與此路由組態相關聯的路由表資源標識符。

屬性	值
Parameter group:	Routing Configuration Arguments

--associated-inbound-routemap

此連線路由設定之輸入路由圖的資源 URI。

屬性	值
Parameter group:	Routing Configuration Arguments

--associated-outbound-routemap

此連線路由組態的輸出路由對應資源 URI。

屬性	值
Parameter group:	Routing Configuration Arguments

--internet-security

啟用因特網安全性並啟用預設值。

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

--labels

預覽

傳播路由表的標籤以空格分隔的清單。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
Parameter group:	Routing Configuration Arguments

--next-hop

預覽

下一個躍點的IP位址。

屬性	值
Parameter group:	Routing Configuration Arguments

--no-wait

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

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

--propagated --propagated-route-tables

預覽

傳播路由表的資源標識符空間分隔清單。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
Parameter group:	Routing Configuration Arguments

--remote-vnet-transit

已淘汰：啟用中樞以遠端 VNet 傳輸。

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

--route-name

預覽

VNet 路由內唯一的靜態路由名稱。

屬性	值
Parameter group:	Routing Configuration Arguments

--use-hub-vnet-gateways

已淘汰：允許遠端 VNet 使用中樞的 VNet 閘道。

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	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 network vhub connection delete

刪除虛擬中樞 VNet 連線。

az network vhub connection delete [--ids]
                                  [--name]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--resource-group]
                                  [--subscription]
                                  [--vhub-name]
                                  [--yes]

範例

刪除虛擬中樞 VNet 連線。

az network vhub connection delete -n MyConnection --vhub-name MyHub -g MyRG

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

屬性	值
Parameter group:	Resource Id Arguments

--name -n

連接的名稱。

屬性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--vhub-name

虛擬中樞的名稱。

屬性	值
Parameter group:	Resource Id Arguments

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

屬性	值
預設值:	False

az network vhub connection list

列出虛擬中樞 VNet 連線。

az network vhub connection list --resource-group
                                --vhub-name
                                [--max-items]
                                [--next-token]

範例

列出指定虛擬中樞中的 VNet 連線。

az network vhub connection list --vhub-name MyHub -g MyRG

必要參數

--resource-group -g

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

--vhub-name

虛擬中樞的名稱。

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

命令輸出中要傳回的項目總數。如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。若要繼續分頁，請在後續命令的 --next-token 自變數中提供令牌值。

屬性	值
Parameter group:	Pagination Arguments

--next-token

標記，指定要開始分頁的位置。這是先前截斷回應中的令牌值。

屬性	值
Parameter group:	Pagination Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	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 network vhub connection show

取得虛擬中樞 VNet 連線的詳細數據。

az network vhub connection show [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]
                                [--vhub-name]

範例

取得虛擬中樞 VNet 連線的詳細數據。

az network vhub connection show -n MyConnection --vhub-name MyHub -g MyRG

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

屬性	值
Parameter group:	Resource Id Arguments

--name -n

連接的名稱。

屬性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--vhub-name

虛擬中樞的名稱。

屬性	值
Parameter group:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

屬性	值
預設值:	False

az network vhub connection update

更新虛擬中樞連線的設定。

az network vhub connection update [--add]
                                  [--associated --associated-route-table]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--ids]
                                  [--labels]
                                  [--name]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--propagated --propagated-route-tables]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--vhub-name]

範例

在路由組態下新增傳播路由表的標籤。

az network vhub connection update -n MyConnection --vhub-name MyHub -g MyRG --labels Newlabel1 Newlabel2

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

屬性	值
Parameter group:	Generic Update Arguments

--associated --associated-route-table

預覽

與此路由組態相關聯的路由表資源標識符。

屬性	值
Parameter group:	Routing Configuration Arguments

--associated-inbound-routemap

此連線路由設定之輸入路由圖的資源 URI。

屬性	值
Parameter group:	Routing Configuration Arguments

--associated-outbound-routemap

此連線路由組態的輸出路由對應資源 URI。

屬性	值
Parameter group:	Routing Configuration Arguments

--force-string

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

屬性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--ids

屬性	值
Parameter group:	Resource Id Arguments

--labels

預覽

傳播路由表的標籤以空格分隔的清單。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
Parameter group:	Routing Configuration Arguments

--name -n

連接的名稱。

屬性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--propagated --propagated-route-tables

預覽

傳播路由表的資源標識符空間分隔清單。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
Parameter group:	Routing Configuration Arguments

--remove

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

屬性	值
Parameter group:	Generic Update Arguments

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--set

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

屬性	值
Parameter group:	Generic Update Arguments

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--vhub-name

虛擬中樞的名稱。

屬性	值
Parameter group:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

屬性	值
預設值:	False

az network vhub connection wait

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

az network vhub connection wait [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--name]
                                [--resource-group]
                                [--subscription]
                                [--timeout]
                                [--updated]
                                [--vhub-name]

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	False

--custom

等到條件符合自定義 JMESPath 查詢為止。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性	值
Parameter group:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	False

--ids

屬性	值
Parameter group:	Resource Id Arguments

--interval

輪詢間隔以秒為單位。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	30

--name -n

連接的名稱。

屬性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--timeout

以秒為單位的等候上限。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	False

--vhub-name

虛擬中樞的名稱。

屬性	值
Parameter group:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

屬性	值
預設值:	False

共用方式為

az network vhub connection

命令

az network vhub connection create

範例

必要參數

選擇性參數

az network vhub connection delete

範例

選擇性參數

az network vhub connection list

範例

必要參數

選擇性參數

az network vhub connection show

範例

選擇性參數

az network vhub connection update

範例

選擇性參數

az network vhub connection wait

選擇性參數

意見反應