az network vpn-connection

  • 參考

管理 VPN 連線。

如需站對站連線的詳細資訊，請流覽 https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli 。 如需 Vnet 對 Vnet 連線的詳細資訊，請流覽 https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-vnet-vnet-cli 。

命令

名稱 Description 類型 狀態
az network vpn-connection create

建立 VPN 連線。

 核心 GA
az network vpn-connection delete

刪除 VPN 連線。

 核心 GA
az network vpn-connection ipsec-policy

管理 VPN 連線 IPSec 原則。

 核心 GA
az network vpn-connection ipsec-policy add

新增 VPN 連線 IPSec 原則。

 核心 GA
az network vpn-connection ipsec-policy clear

刪除 VPN 連線上的所有 IPsec 原則。

 核心 GA
az network vpn-connection ipsec-policy list

列出與 VPN 連線相關聯的 IPSec 原則。

 核心 GA
az network vpn-connection ipsec-policy wait

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

 核心 GA
az network vpn-connection list

列出所有 VPN 連線。

 核心 GA
az network vpn-connection list-ike-sas

列出 VPN 連線的 IKE 安全性關聯。

 核心 預覽版
az network vpn-connection packet-capture

管理 VPN 連線上的封包擷取。

 核心 GA
az network vpn-connection packet-capture start

在 VPN 連線上啟動封包擷取。

 核心 GA
az network vpn-connection packet-capture stop

停止 VPN 連線上的封包擷取。

 核心 預覽版
az network vpn-connection packet-capture wait

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

 核心 GA
az network vpn-connection shared-key

管理 VPN 共用金鑰。

 核心 GA
az network vpn-connection shared-key reset

重設 VPN 連線共用金鑰。

 核心 GA
az network vpn-connection shared-key show

擷取 VPN 連線共用金鑰。

 核心 GA
az network vpn-connection shared-key update

更新 VPN 連線共用金鑰。

 核心 GA
az network vpn-connection show

取得 VPN 連線的詳細資料。

 核心 GA
az network vpn-connection show-device-config-script

取得 VPN 連線裝置組態腳本的 XML 格式標記法。

 核心 預覽版
az network vpn-connection update

更新 VPN 連線。

 核心 GA
az network vpn-connection wait

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

 核心 GA

az network vpn-connection create

編輯

建立 VPN 連線。

必須先布建VPN 閘道和局域網路閘道，才能建立它們之間的連線。

az network vpn-connection create --name
                                 --resource-group
                                 --vnet-gateway1
                                 [--authorization-key]
                                 [--egress-nat-rule]
                                 [--enable-bgp]
                                 [--express-route-circuit2]
                                 [--express-route-gateway-bypass {false, true}]
                                 [--ingress-nat-rule]
                                 [--local-gateway2]
                                 [--location]
                                 [--routing-weight]
                                 [--shared-key]
                                 [--tags]
                                 [--use-policy-based-traffic-selectors {false, true}]
                                 [--validate]
                                 [--vnet-gateway2]

範例

建立 Azure 虛擬網路與內部部署局域網路閘道之間的站對站連線。

az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123

使用 --ingress-nat-rule 建立 VPN 連線。

az network vpn-connection create -g MyResourceGroup -n MyConnection --vnet-gateway1 MyVnetGateway --local-gateway2 MyLocalGateway --shared-key Abc123 --ingress-nat-rule /subscriptions/000/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/gwx/natRules/nat

建立 VPN 連線。 （自動產生）

az network vpn-connection create --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway --vnet-gateway2 /subscriptions/{subscriptionID}/resourceGroups/TestBGPRG1/providers/Microsoft.Network/virtualNetworkGateways/VNet1GW

建立 VPN 連線。 （自動產生）

az network vpn-connection create --local-gateway2 MyLocalGateway --location westus2 --name MyConnection --resource-group MyResourceGroup --shared-key Abc123 --vnet-gateway1 MyVnetGateway

必要參數

--name -n

連線名稱。

--resource-group -g

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

--vnet-gateway1

來源虛擬網路閘道的名稱或識別碼。

選擇性參數

--authorization-key

VPN 連線的授權金鑰。

--egress-nat-rule
預覽

輸出 NatRules 的清單。

--enable-bgp

啟用此 VPN 連線的 BGP。

預設值: False
--express-route-circuit2

目的地 ExpressRoute 的名稱或識別碼，以使用 'ExpressRoute' 連線來連線。

--express-route-gateway-bypass

略過 ExpressRoute 閘道進行資料轉送。

接受的值: false, true
--ingress-nat-rule
預覽

輸入 NatRules 的清單。

--local-gateway2

使用 'IPSec' 連線連線的目的地局域網路閘道名稱或識別碼。

--location -l

位置。​​ 來自的值： az account list-locations 。 您可以使用 來設定預設位置 az configure --defaults location=<location> 。

--routing-weight

連線路由權數。

預設值: 10
--shared-key

共用 IPSec 金鑰。

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「」 清除現有的標記。

--use-policy-based-traffic-selectors

啟用以原則為基礎的流量選取器。

接受的值: false, true
預設值: False
--validate

顯示及驗證 ARM 範本，但不建立任何資源。

預設值: False
--vnet-gateway2

使用 'Vnet2Vnet' 連線連線的目的地虛擬網路閘道名稱或識別碼。

全域參數
--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 vpn-connection delete

編輯

刪除 VPN 連線。

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

範例

刪除 VPN 連線。

az network vpn-connection delete -g MyResourceGroup -n MyConnection

選擇性參數

--ids

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

--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 帳戶。

全域參數
--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 vpn-connection list

編輯

列出所有 VPN 連線。

az network vpn-connection list --resource-group
                               [--vnet-gateway]

範例

列出資源群組中的所有 VPN 連線。

az network vpn-connection list -g MyResourceGroup

列出虛擬網路閘道中的所有 VPN 連線。

az network vpn-connection list -g MyResourceGroup --vnet-gateway MyVnetGateway

必要參數

--resource-group -g

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

選擇性參數

--vnet-gateway

VNet 閘道的名稱。

全域參數
--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 vpn-connection list-ike-sas

編輯
預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出 VPN 連線的 IKE 安全性關聯。

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

範例

列出 VPN 連線的 IKE 安全性關聯。

az network vpn-connection list-ike-sas -g MyResourceGroup -n MyConnection

選擇性參數

--ids

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

--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 帳戶。

全域參數
--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 vpn-connection show

編輯

取得 VPN 連線的詳細資料。

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

範例

檢視 VPN 連線的詳細資料。

az network vpn-connection show -g MyResourceGroup -n MyConnection

選擇性參數

--ids

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

--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 vpn-connection show-device-config-script

編輯
預覽

此命令處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得 VPN 連線裝置組態腳本的 XML 格式標記法。

az network vpn-connection show-device-config-script --device-family
                                                    --firmware-version
                                                    --vendor
                                                    [--ids]
                                                    [--name]
                                                    [--resource-group]
                                                    [--subscription]

範例

取得 VPN 連線裝置組態腳本的 XML 格式標記法。

az network vpn-connection show-device-config-script -g MyResourceGroup -n MyConnection --vendor "Cisco" --device-family "Cisco-ISR(IOS)" --firmware-version "Cisco-ISR-15.x-- IKEv2+BGP"

必要參數

--device-family

VPN 裝置的裝置系列。

--firmware-version

vpn 裝置的韌體版本。

--vendor

vpn 裝置的廠商。

選擇性參數

--ids

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

--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 vpn-connection update

編輯

更新 VPN 連線。

az network vpn-connection update [--add]
                                 [--enable-bgp {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--express-route-gateway-bypass {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--ids]
                                 [--name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--remove]
                                 [--resource-group]
                                 [--routing-weight]
                                 [--set]
                                 [--shared-key]
                                 [--subscription]
                                 [--tags]
                                 [--use-policy-based-traffic-selectors {0, 1, f, false, n, no, t, true, y, yes}]

範例

將 BGP 新增至現有的連線。

az network vpn-connection update -g MyResourceGroup -n MyConnection --enable-bgp True

更新 VPN 連線。

az network vpn-connection update --name MyConnection --resource-group MyResourceGroup --use-policy-based-traffic-selectors true

選擇性參數

--add

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

--enable-bgp

啟用 BGP （邊界閘道通訊協定）。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--express-route-gateway-bypass

略過 ExpressRoute 閘道進行資料轉送。

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

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

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

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

--name -n

連線名稱。

--no-wait

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

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

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

--resource-group -g

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

--routing-weight

連線路由權數。

--set

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

--shared-key

共用 IPSec 金鑰。

--subscription

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

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用 「」 清除現有的標記。 支援速記語法、json-file 和 yaml-file。 請嘗試 「？？」 以顯示更多。

--use-policy-based-traffic-selectors

啟用以原則為基礎的流量選取器。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
全域參數
--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 vpn-connection wait

編輯

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

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

選擇性參數

--created

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

預設值: False
--custom

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

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30
--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 來取得完整偵錯記錄。