az network manager connect-config

參考

注意

此參考是 Azure CLI 的虛擬網路管理員延伸模組的一部分（2.57.0 版或更高版本）。擴充功能會在您第一次執行 az network manager connect-config 命令時自動安裝。深入了解擴充功能。

使用網路管理連線設定。

命令

名稱	Description	類型	狀態
az network manager connect-config create	建立新的網路管理員連線設定。	副檔名	GA
az network manager connect-config delete	刪除資源群組、網路管理員名稱和連線設定名稱所指定的網路管理員連線設定。	副檔名	GA
az network manager connect-config list	列出指定網路管理員中的所有網路管理員連線設定。	副檔名	GA
az network manager connect-config show	取得資源群組、網路管理員名稱和連線設定名稱所指定的網路連線設定。	副檔名	GA
az network manager connect-config update	更新新的網路管理員連線設定。	副檔名	GA
az network manager connect-config wait	將 CLI 置於等候狀態，直到符合條件為止。	副檔名	GA

az network manager connect-config create

建立新的網路管理員連線設定。

az network manager connect-config create --configuration-name
                                         --name
                                         --resource-group
                                         [--applies-to-group]
                                         [--connectivity-topology {HubAndSpoke, Mesh}]
                                         [--delete-existing-peering {False, True}]
                                         [--description]
                                         [--hub]
                                         [--is-global {False, True}]

範例

建立/更新 Azure 虛擬網絡管理員連線設定

az network manager connect-config create --configuration-name "myTestConnectivityConfig" --description "Sample Configuration" --applies-to-group group-connectivity="None" is-global=false network-group-id="/subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkManagerGroups/group1" use-hub-gateway=true --connectivity-topology "HubAndSpoke" --delete-existing-peering true --hub resource-id="subscriptions/subscriptionA/resourceGroups/myResourceGroup/providers/Micr osoft.Network/virtualNetworks/myTestConnectivityConfig" resource- type="Microsoft.Network/virtualNetworks" --is-global true --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

必要參數

--configuration-name

網路管理員連線設定的名稱。

--name --network-manager-name -n

網路管理員的名稱。

--resource-group -g

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

選擇性參數

--applies-to-group --applies-to-groups

組態的群組支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。單一旗標： --applies-to-group。

--connectivity-topology

線上拓撲類型。

接受的值: HubAndSpoke, Mesh

--delete-existing-peering

如果需要移除目前的現有對等互連，請加上旗標。

接受的值: False, True

--description

線上設定的描述。

--hub --hubs

hubItems 清單支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。單一旗標： --hub。

--is-global

如果支援全域網格，則為旗標。

接受的值: False, True

全域參數

--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 manager connect-config delete

刪除資源群組、網路管理員名稱和連線設定名稱所指定的網路管理員連線設定。

az network manager connect-config delete [--configuration-name]
                                         [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

範例

刪除 Azure 虛擬網絡 Manager 連線設定

az network manager connect-config delete --configuration-name "myTestConnectivityConfig" --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

選擇性參數

--configuration-name

網路管理員連線設定的名稱。

--force

即使資源是已部署組態的一部分，也會刪除資源。如果已部署組態，服務會在刪除之前，在背景中執行清除部署。

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

--ids

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

--name --network-manager-name -n

網路管理員的名稱。

--no-wait

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

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

--resource-group -g

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

--subscription

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

--yes -y

不提示確認。

預設值: False

全域參數

--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 manager connect-config list

列出指定網路管理員中的所有網路管理員連線設定。

az network manager connect-config list --name
                                       --resource-group
                                       [--max-items]
                                       [--next-token]
                                       [--skip-token]
                                       [--top]

範例

列出 Azure 虛擬網絡 Manager 並行設定

az network manager connect-config list --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

必要參數

--name --network-manager-name -n

網路管理員的名稱。

--resource-group -g

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

選擇性參數

--max-items

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

--next-token

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

--skip-token

只有在先前的作業傳回部分結果時，才會使用SkipToken。如果先前的回應包含 nextLink 元素，則 nextLink 元素的值會包含 skipToken 參數，指定用於後續呼叫的起點。

--top

選擇性的查詢參數，指定要由伺服器傳回的記錄數目上限。

全域參數

--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 manager connect-config show

取得資源群組、網路管理員名稱和連線設定名稱所指定的網路連線設定。

az network manager connect-config show [--configuration-name]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

範例

取得 Azure 虛擬網絡 Manager 連線設定

az network manager connect-config show --configuration-name "myTestConnectivityConfig" --network-manager-name "testNetworkManager" --resource-group "myResourceGroup"

選擇性參數

--configuration-name

網路管理員連線設定的名稱。

--ids

--name --network-manager-name -n

網路管理員的名稱。

--resource-group -g

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

--subscription

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

全域參數

--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 manager connect-config update

更新新的網路管理員連線設定。

az network manager connect-config update [--add]
                                         [--applies-to-group]
                                         [--configuration-name]
                                         [--connectivity-topology {HubAndSpoke, Mesh}]
                                         [--delete-existing-peering {False, True}]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--hub]
                                         [--ids]
                                         [--is-global {False, True}]
                                         [--name]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]

選擇性參數

--add

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

--applies-to-group --applies-to-groups

組態的群組支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。單一旗標： --applies-to-group。

--configuration-name

網路管理員連線設定的名稱。

--connectivity-topology

線上拓撲類型。

接受的值: HubAndSpoke, Mesh

--delete-existing-peering

如果需要移除目前的現有對等互連，請加上旗標。

接受的值: False, True

--description

線上設定的描述。

--force-string

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

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

--hub --hubs

hubItems 清單支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。單一旗標： --hub。

--ids

--is-global

如果支援全域網格，則為旗標。

接受的值: False, True

--name --network-manager-name -n

網路管理員的名稱。

--remove

從清單中移除屬性或專案。範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

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

--set

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

--subscription

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

全域參數

--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 manager connect-config wait

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

az network manager connect-config wait [--configuration-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

選擇性參數

--configuration-name

網路管理員連線設定的名稱。

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

--interval

輪詢間隔以秒為單位。

預設值: 30

--name --network-manager-name -n

網路管理員的名稱。

--resource-group -g

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

全域參數

--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 manager connect-config

命令

az network manager connect-config create

範例

必要參數

選擇性參數

az network manager connect-config delete

範例

選擇性參數

az network manager connect-config list

範例

必要參數

選擇性參數

az network manager connect-config show

範例

選擇性參數

az network manager connect-config update

選擇性參數

az network manager connect-config wait

選擇性參數

其他資源