az network vpn-site

參考

注意

此參考是 Azure CLI 的虛擬 wan 擴充功能的一部分（2.55.0 版或更高版本）。擴充功能會在您第一次執行 az network vpn-site 命令時自動安裝。深入了解擴充功能。

管理 VPN 月台組態。

命令

名稱	Description	類型	狀態
az network vpn-site create	建立 VPN 月台組態。	副檔名	GA
az network vpn-site delete	刪除 VPN 月台組態。	副檔名	GA
az network vpn-site download	提供SAS-URL以下載 VPN 網站的組態。	副檔名	GA
az network vpn-site link	管理 VPN 網站連結。	副檔名	GA
az network vpn-site link add	將 VPN 月臺連結新增至 VPN 月臺組態。	副檔名	GA
az network vpn-site link list	列出 VPN 月台設定上的 VPN 網站連結。	副檔名	GA
az network vpn-site link remove	從 VPN 月臺組態中移除 VPN 月臺連結。	副檔名	GA
az network vpn-site list	列出 VPN 月台組態。	副檔名	GA
az network vpn-site show	取得 VPN 月臺設定的詳細數據。	副檔名	GA
az network vpn-site update	更新 VPN 月台組態的設定。	副檔名	GA

az network vpn-site create

建立 VPN 月台組態。

az network vpn-site create --ip-address
                           --name
                           --resource-group
                           [--address-prefixes]
                           [--asn]
                           [--bgp-peering-address]
                           [--device-model]
                           [--device-vendor]
                           [--link-speed]
                           [--location]
                           [--no-wait]
                           [--peer-weight]
                           [--security-site {false, true}]
                           [--site-key]
                           [--tags]
                           [--virtual-wan]
                           [--with-link {false, true}]

必要參數

--ip-address

VPN 網站的IP位址。

--name -n

VPN 月台組態的名稱。

--resource-group -g

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

選擇性參數

--address-prefixes

CIDR 位址前綴的空間分隔清單。

--asn

BGP 喇叭的 ASN。

--bgp-peering-address

這個 BGP 說話者的對等互連位址和 BGP 識別碼。

--device-model

裝置的模型。

--device-vendor

裝置廠商的名稱。

--link-speed

以 Mbps 為單位的連結速度。

--location -l

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

--no-wait

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

預設值: False

--peer-weight

新增至從此 BGP 喇叭學習的路由的權數。

--security-site

VPN 網站是否與安全性相關。

接受的值: false, true

--site-key

可用於連線的 VPN 月臺金鑰。

--tags

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

--virtual-wan

虛擬 WAN 的名稱或識別碼。

--with-link

建立具有默認連結的 VPN 網站。

接受的值: 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 vpn-site delete

刪除 VPN 月台組態。

az network vpn-site delete [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

選擇性參數

--ids

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

--name -n

VPN 月台組態的名稱。

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

提供SAS-URL以下載 VPN 網站的組態。

az network vpn-site download --request
                             --resource-group
                             --vwan-name

必要參數

--request

提供以下載 vpn-sites 組態的參數。這是模型類型或IO類型。必要。

--resource-group -g

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

--vwan-name

虛擬 WAN 的名稱。

全域參數

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

列出 VPN 月台組態。

az network vpn-site list [--resource-group]

選擇性參數

--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 vpn-site show

取得 VPN 月臺設定的詳細數據。

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

選擇性參數

--ids

--name -n

VPN 月台組態的名稱。

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

更新 VPN 月台組態的設定。

az network vpn-site update [--add]
                           [--address-prefixes]
                           [--asn]
                           [--bgp-peering-address]
                           [--device-model]
                           [--device-vendor]
                           [--force-string]
                           [--ids]
                           [--ip-address]
                           [--link-speed]
                           [--name]
                           [--no-wait]
                           [--peer-weight]
                           [--remove]
                           [--resource-group]
                           [--security-site {false, true}]
                           [--set]
                           [--site-key]
                           [--subscription]
                           [--tags]
                           [--virtual-wan]

選擇性參數

--add

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

預設值: []

--address-prefixes

CIDR 位址前綴的空間分隔清單。

--asn

BGP 喇叭的 ASN。

--bgp-peering-address

這個 BGP 說話者的對等互連位址和 BGP 識別碼。

--device-model

裝置的模型。

--device-vendor

裝置廠商的名稱。

--force-string

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

預設值: False

--ids

--ip-address

VPN 網站的IP位址。

--link-speed

以 Mbps 為單位的連結速度。

--name -n

VPN 月台組態的名稱。

--no-wait

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

預設值: False

--peer-weight

新增至從此 BGP 喇叭學習的路由的權數。

--remove

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

預設值: []

--resource-group -g

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

--security-site

VPN 網站是否與安全性相關。

接受的值: false, true

--set

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

預設值: []

--site-key

可用於連線的 VPN 月臺金鑰。

--subscription

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

--tags

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

--virtual-wan

虛擬 WAN 的名稱或識別碼。

全域參數

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

命令

az network vpn-site create

必要參數

選擇性參數

az network vpn-site delete

選擇性參數

az network vpn-site download

必要參數

az network vpn-site list

選擇性參數

az network vpn-site show

選擇性參數

az network vpn-site update

選擇性參數

其他資源