az network p2s-vpn-gateway

參考

注意

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

管理點對站 VPN 閘道。

命令

名稱	Description	類型	狀態
az network p2s-vpn-gateway connection	管理點對站 VPN 網關聯機。	副檔名	預覽
az network p2s-vpn-gateway connection list	列出指定點對站 VPN 閘道的所有連線。	副檔名	預覽
az network p2s-vpn-gateway connection show	顯示點對站 VPN 網關聯機的詳細數據。	副檔名	預覽
az network p2s-vpn-gateway create	建立點對站 VPN 閘道。	副檔名	GA
az network p2s-vpn-gateway delete	刪除點對站 VPN 閘道。	副檔名	GA
az network p2s-vpn-gateway disconnect	中斷指定資源群組中虛擬 wan P2SVpnGateway 的 P2S vpn 連線。	副檔名	GA
az network p2s-vpn-gateway list	列出所有點對站 VPN 閘道。	副檔名	GA
az network p2s-vpn-gateway reset	重設指定資源群組中 p2s vpn 閘道的主要複本。	副檔名	GA
az network p2s-vpn-gateway show	顯示點對站 VPN 閘道的詳細數據。	副檔名	GA
az network p2s-vpn-gateway update	更新點對站 VPN 閘道的設定。	副檔名	GA
az network p2s-vpn-gateway vpn-client	下載透過點對站連線至 Azure 所需的 VPN 用戶端設定。	副檔名	GA
az network p2s-vpn-gateway vpn-client generate	為指定資源群組中 P2SVpnGateway 的 P2S 用戶端產生 VPN 配置檔。	副檔名	GA
az network p2s-vpn-gateway wait	將 CLI 置於等候狀態，直到符合點對站 VPN 閘道的條件為止。	副檔名	GA

az network p2s-vpn-gateway create

建立點對站 VPN 閘道。

az network p2s-vpn-gateway create --name
                                  --resource-group
                                  --scale-unit
                                  --vhub
                                  [--address-space]
                                  [--associated]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--config-name]
                                  [--labels]
                                  [--location]
                                  [--no-wait]
                                  [--propagated]
                                  [--tags]
                                  [--vpn-server-config]

範例

建立點對站 VPN 閘道。

az network p2s-vpn-gateway create -g MyRG -n MyP2SVPNGateway --scale-unit 2 --vhub MyVhub --vpn-server-config MyVPNServerConfig --address-space 10.0.0.0/24 11.0.0.0/24

建立具有路由設定的點對站 VPN 閘道。

az network p2s-vpn-gateway create -g MyRG -n MyP2SVPNGateway --scale-unit 2 --vhub MyVhub --vpn-server-config MyVPNServerConfig --address-space 10.0.0.0/24 11.0.0.0/24 --associated-route-table /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 --propagated-route-tables /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable1 /subscriptions/MySub/resourceGroups/MyRG/providers/Microsoft.Network/virtualHubs/MyHub/hubRouteTables/MyRouteTable2 --labels label1 label2

必要參數

--name -n

P2S Vpn 閘道名稱。

--resource-group -g

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

--scale-unit

此 VPN 閘道的縮放單位。

--vhub

虛擬中樞的名稱或標識碼。

選擇性參數

--address-space

P2S VpnClient 的地址空間。以空格分隔的IP位址範圍清單。

--associated --associated-route-table

預覽

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

--associated-inbound-routemap

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

--associated-outbound-routemap

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

--config-name

名稱或 p2s 聯機組態。

預設值: P2SConnectionConfigDefault

--labels

預覽

傳播路由表的標籤以空格分隔的清單。

--location -l

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

--no-wait

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

預設值: False

--propagated --propagated-route-tables

預覽

已傳播路由表的資源標識符空間分隔清單。

--tags

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

--vpn-server-config

VPN 伺服器組態的名稱或識別碼。

全域參數

--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 p2s-vpn-gateway delete

刪除點對站 VPN 閘道。

az network p2s-vpn-gateway delete --name
                                  --resource-group
                                  [--yes]

必要參數

--name -n

P2S Vpn 閘道名稱。

--resource-group -g

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

選擇性參數

--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 p2s-vpn-gateway disconnect

中斷指定資源群組中虛擬 wan P2SVpnGateway 的 P2S vpn 連線。

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

範例

中斷 P2S vpn 連線。

az network p2s-vpn-gateway disconnect -g MyResourceGroup -n MyP2sGateway --vpn-connection-ids "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/p2sVpnGateways/MyP2sGateway/p2sConnectionConfigurations/P2SConnectionConfigDefault"

選擇性參數

--ids

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

--name -n

P2S Vpn 閘道名稱。

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

--vpn-connection-ids

p2s vpn 連線標識碼的清單。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

全域參數

--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 p2s-vpn-gateway list

列出所有點對站 VPN 閘道。

az network p2s-vpn-gateway 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 p2s-vpn-gateway reset

重設指定資源群組中 p2s vpn 閘道的主要複本。

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

範例

重設 p2s vpn 閘道的主要複本。

az network p2s-vpn-gateway reset -g MyResourceGroup -n MyP2sGateway

選擇性參數

--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 p2s-vpn-gateway show

顯示點對站 VPN 閘道的詳細數據。

az network p2s-vpn-gateway show --name
                                --resource-group

必要參數

--name -n

P2S Vpn 閘道名稱。

--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 p2s-vpn-gateway update

更新點對站 VPN 閘道的設定。

az network p2s-vpn-gateway update --name
                                  --resource-group
                                  [--add]
                                  [--address-space]
                                  [--associated]
                                  [--associated-inbound-routemap]
                                  [--associated-outbound-routemap]
                                  [--config-name]
                                  [--force-string]
                                  [--labels]
                                  [--no-wait]
                                  [--propagated]
                                  [--remove]
                                  [--scale-unit]
                                  [--set]
                                  [--tags]
                                  [--vpn-server-config]

範例

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

az network p2s-vpn-gateway update -g MyRG -n MyP2SVPNGateway --labels Newlabel1 Newlabel2 Newlabel3

必要參數

--name -n

P2S Vpn 閘道名稱。

--resource-group -g

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

選擇性參數

--add

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

預設值: []

--address-space

P2S VpnClient 的地址空間。以空格分隔的IP位址範圍清單。

--associated --associated-route-table

預覽

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

--associated-inbound-routemap

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

--associated-outbound-routemap

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

--config-name

名稱或 p2s 聯機組態。

--force-string

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

預設值: False

--labels

預覽

傳播路由表的標籤以空格分隔的清單。

--no-wait

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

預設值: False

--propagated --propagated-route-tables

預覽

已傳播路由表的資源標識符空間分隔清單。

--remove

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

預設值: []

--scale-unit

此 VPN 閘道的縮放單位。

--set

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

預設值: []

--tags

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

--vpn-server-config

VPN 伺服器組態的名稱或識別碼。

全域參數

--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 p2s-vpn-gateway wait

將 CLI 置於等候狀態，直到符合點對站 VPN 閘道的條件為止。

az network p2s-vpn-gateway wait --name
                                --resource-group
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--interval]
                                [--timeout]
                                [--updated]

必要參數

--name -n

P2S Vpn 閘道名稱。

--resource-group -g

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

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--interval

輪詢間隔以秒為單位。

預設值: 30

--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 p2s-vpn-gateway

命令

az network p2s-vpn-gateway create

範例

必要參數

選擇性參數

az network p2s-vpn-gateway delete

必要參數

選擇性參數

az network p2s-vpn-gateway disconnect

範例

選擇性參數

az network p2s-vpn-gateway list

選擇性參數

az network p2s-vpn-gateway reset

範例

選擇性參數

az network p2s-vpn-gateway show

必要參數

az network p2s-vpn-gateway update

範例

必要參數

選擇性參數

az network p2s-vpn-gateway wait

必要參數

選擇性參數

其他資源