az network vnet-gateway

使用 Azure 虛擬網絡 閘道來建立安全的跨單位連線。

若要深入瞭解 Azure 虛擬網絡 閘道,請瀏覽 https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli

命令

名稱 Description 類型 狀態
az network vnet-gateway aad

管理虛擬網路網關的 AAD(Azure Active Directory) 驗證。

核心 GA
az network vnet-gateway aad assign

將 AAD(Azure Active Directory) 驗證指派/更新至虛擬網路閘道。

核心 GA
az network vnet-gateway aad remove

從虛擬網路閘道移除 AAD(Azure Active Directory) 驗證。

核心 GA
az network vnet-gateway aad show

顯示虛擬網路網關的 AAD(Azure Active Directory) 驗證。

核心 GA
az network vnet-gateway aad wait

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

核心 GA
az network vnet-gateway create

建立虛擬網路閘道。

核心 GA
az network vnet-gateway delete

刪除虛擬網路閘道。

核心 GA
az network vnet-gateway disconnect-vpn-connections

中斷虛擬網路閘道的 VPN 連線。

核心 預覽​​
az network vnet-gateway ipsec-policy

管理虛擬網路閘道 IPSec 原則。

核心 GA
az network vnet-gateway ipsec-policy add

新增虛擬網路閘道IPSec原則。

核心 GA
az network vnet-gateway ipsec-policy clear

刪除虛擬網路閘道上的所有 IPsec 原則。

核心 GA
az network vnet-gateway ipsec-policy list

列出與虛擬網路網關相關聯的IPSec原則。

核心 GA
az network vnet-gateway ipsec-policy wait

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

核心 GA
az network vnet-gateway list

列出虛擬網路閘道。

核心 GA
az network vnet-gateway list-advertised-routes

列出向指定對等公告的虛擬網路網關路由。

核心 GA
az network vnet-gateway list-bgp-peer-status

擷取 BGP 對等互連的狀態。

核心 GA
az network vnet-gateway list-learned-routes

此作業會擷取虛擬網路網關已學習的路由清單,包括從 BGP 對等互連學習的路由。

核心 GA
az network vnet-gateway nat-rule

在虛擬網路閘道中管理 nat 規則。

核心 GA
az network vnet-gateway nat-rule add

在虛擬網路閘道中新增 nat 規則。

核心 預覽​​
az network vnet-gateway nat-rule list

列出虛擬網路閘道的 nat 規則。

核心 預覽​​
az network vnet-gateway nat-rule remove

從虛擬網路閘道移除 nat 規則。

核心 預覽​​
az network vnet-gateway nat-rule wait

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

核心 GA
az network vnet-gateway packet-capture

管理虛擬網路閘道上的封包擷取。

核心 GA
az network vnet-gateway packet-capture start

在虛擬網路閘道上啟動封包擷取。

核心 預覽​​
az network vnet-gateway packet-capture stop

停止虛擬網路閘道上的封包擷取。

核心 預覽​​
az network vnet-gateway packet-capture wait

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

核心 GA
az network vnet-gateway reset

重設虛擬網路閘道。

核心 GA
az network vnet-gateway revoked-cert

管理虛擬網路閘道中撤銷的憑證。 防止使用此憑證的電腦透過此閘道存取 Azure。

核心 GA
az network vnet-gateway revoked-cert create

撤銷憑證。

核心 GA
az network vnet-gateway revoked-cert delete

刪除撤銷的憑證。

核心 GA
az network vnet-gateway revoked-cert wait

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

核心 GA
az network vnet-gateway root-cert

管理虛擬網路閘道的跟證書。

核心 GA
az network vnet-gateway root-cert create

上傳根憑證。

核心 GA
az network vnet-gateway root-cert delete

刪除跟證書。

核心 GA
az network vnet-gateway root-cert wait

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

核心 GA
az network vnet-gateway show

取得虛擬網路閘道的詳細數據。

核心 GA
az network vnet-gateway show-supported-devices

取得支援的 vpn 裝置的 xml 格式表示法。

核心 預覽​​
az network vnet-gateway update

更新虛擬網路閘道。

核心 GA
az network vnet-gateway vpn-client

下載透過點對站連線至 Azure 所需的 VPN 用戶端設定。

核心 GA
az network vnet-gateway vpn-client generate

產生 VPN 用戶端組態。

核心 GA
az network vnet-gateway vpn-client ipsec-policy

管理虛擬網路網關 P2S 用戶端連線的 VPN 用戶端連線 ipsec-policy。

核心 GA
az network vnet-gateway vpn-client ipsec-policy set

為每個虛擬網路網關的 P2S 用戶端連線設定 VPN 用戶端連線 ipsec 原則。

核心 預覽​​
az network vnet-gateway vpn-client ipsec-policy show

取得虛擬網路網關每個 P2S 用戶端連線的 VPN 用戶端連線 ipsec 原則。

核心 預覽​​
az network vnet-gateway vpn-client ipsec-policy wait

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

核心 GA
az network vnet-gateway vpn-client show-health

取得虛擬網路網關每個 P2S 用戶端連線的 VPN 用戶端連線健康情況詳細數據。

核心 預覽​​
az network vnet-gateway vpn-client show-url

擷取預先產生的 VPN 用戶端組態。

核心 GA
az network vnet-gateway wait

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

核心 GA

az network vnet-gateway create

建立虛擬網路閘道。

az network vnet-gateway create --name
                               --resource-group
                               --vnet
                               [--aad-audience]
                               [--aad-issuer]
                               [--aad-tenant]
                               [--address-prefix]
                               [--allow-remote-vnet-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--allow-vwan-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--asn]
                               [--bgp-peering-address]
                               [--client-protocol]
                               [--custom-routes]
                               [--edge-zone]
                               [--edge-zone-vnet-id]
                               [--enable-private-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--gateway-default-site]
                               [--gateway-type {ExpressRoute, LocalGateway, Vpn}]
                               [--location]
                               [--max-scale-unit]
                               [--min-scale-unit]
                               [--nat-rule]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--peer-weight]
                               [--public-ip-address]
                               [--radius-secret]
                               [--radius-server]
                               [--root-cert-data]
                               [--root-cert-name]
                               [--sku {Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ}]
                               [--tags]
                               [--vpn-auth-type]
                               [--vpn-gateway-generation {Generation1, Generation2, None}]
                               [--vpn-type {PolicyBased, RouteBased}]

範例

建立站對站聯機的基本虛擬網路閘道。

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --no-wait

建立基本虛擬網路網關,以提供點對站連線與RADIUS伺服器上設定的RADIUS秘密相符。

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --address-prefixes 40.1.0.0/24 --client-protocol IkeV2 SSTP --radius-secret 111_aaa --radius-server 30.1.1.15 --vpn-gateway-generation Generation1

使用多重驗證建立基本虛擬網路閘道

az network vnet-gateway create -g MyResourceGroup -n MyVnetGateway --public-ip-address MyGatewayIp --vnet MyVnet --gateway-type Vpn --sku VpnGw1 --vpn-type RouteBased --address-prefixes 40.1.0.0/24 --client-protocol OpenVPN --radius-secret 111_aaa --radius-server 30.1.1.15 --aad-issuer https://sts.windows.net/00000-000000-00000-0000-000/ --aad-tenant https://login.microsoftonline.com/000 --aad-audience 0000-000 --root-cert-name root-cert --root-cert-data "root-cert.cer" --vpn-auth-type AAD Certificate Radius

建立虛擬網路閘道。

az network vnet-gateway create --gateway-type Vpn --location westus2 --name MyVnetGateway --no-wait --public-ip-addresses myVGPublicIPAddress --resource-group MyResourceGroup --sku Basic --vnet MyVnet --vpn-type PolicyBased

必要參數

--name -n

VNet 閘道名稱。

--resource-group -g

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

--vnet

現有虛擬網路的名稱或標識符,其子網名為 『GatewaySubnet』。

選擇性參數

--aad-audience

VirtualNetworkGateway 的 AADAudience 標識符。

--aad-issuer

VirtualNetworkGateway 的 AAD 簽發者 URI。

--aad-tenant

VirtualNetworkGateway 的 AAD 租使用者 URI。

--address-prefix --address-prefixes

CIDR 前置詞的空間分隔清單,代表 P2S Vpnclient 的地址空間。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。 單一旗標: --address-prefix

--allow-remote-vnet-traffic

設定此閘道以接受來自其他 Azure 虛擬網絡 的流量。 此設定不支持連線到 Azure 虛擬 WAN。

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

設定此閘道以接受來自遠端虛擬網路的流量。

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

用於 BGP 設定的自發系統號碼。

--bgp-peering-address

用於 BGP 對等互連的 IP 位址。

--client-protocol

要用於連接的通訊協定。 允許的值:IkeV2、OpenVPN、SSTP。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

--custom-routes

CIDR 前置詞的空間分隔清單,代表客戶針對 VpnClient 所指定的自定義路由地址空間。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

--edge-zone

邊緣區域的名稱。

--edge-zone-vnet-id

本機閘道的擴充 vnet 資源識別碼。

--enable-private-ip

是否需要在此閘道上啟用私人IP以進行連線。

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

代表具有預設路由之局域網路網站之局域網路網關的名稱或標識符。

--gateway-type

閘道類型。

接受的值: ExpressRoute, LocalGateway, Vpn
預設值: Vpn
--location -l

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

--max-scale-unit

自動調整組態的最大縮放單位。

--min-scale-unit

自動調整組態的最小縮放單位。

--nat-rule --nat-rules

VirtualNetworkGatewayNatRule 資源。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。 單一旗標: --nat-rule

--no-wait

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

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

加權 (0-100) 已新增至透過 BGP 對等互連學習的路由。

--public-ip-address --public-ip-addresses

為主動待命閘道指定單一公用IP(名稱或標識碼)。 為主動-主動網關指定兩個以空格分隔的公用IP。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

--radius-secret

要用於驗證的半徑秘密。

--radius-server

要連線的半徑伺服器位址。

--root-cert-data

跟證書檔案或檔案路徑的Base64內容。

--root-cert-name

跟證書名稱。

--sku

VNet 閘道 SKU。

接受的值: Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ
預設值: Basic
--tags

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

--vpn-auth-type

已啟用虛擬網路閘道的 VPN 驗證類型。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

--vpn-gateway-generation

虛擬網路閘道的產生。 如果gateway_type不是 Vpn,就不應該提供vpn_gateway_generation。

接受的值: Generation1, Generation2, None
--vpn-type

VPN 路由類型。

接受的值: PolicyBased, RouteBased
預設值: RouteBased
全域參數
--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 vnet-gateway delete

刪除虛擬網路閘道。

若要刪除 虛擬網絡 閘道,您必須先刪除連線至閘道的 Azure 中所有 連線 物件。 刪除閘道之後,請繼續刪除目前未使用的其他資源。 如需詳細資訊,請遵循此頁面上的指示順序: https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-delete-vnet-gateway-portal

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

範例

刪除虛擬網路閘道。

az network vnet-gateway delete -g MyResourceGroup -n MyVnetGateway

選擇性參數

--ids

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

--name -n

VNet 閘道名稱。

--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 vnet-gateway disconnect-vpn-connections

預覽

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

中斷虛擬網路閘道的 VPN 連線。

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

範例

中斷虛擬網路閘道的 VPN 連線。

az network vnet-gateway disconnect-vpn-connections -g MyResourceGroup -n MyVnetGateway --vpn-connections MyConnetion1ByName MyConnection2ByID

選擇性參數

--ids

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

--name -n

VNet 閘道名稱。

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

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 vnet-gateway list

列出虛擬網路閘道。

az network vnet-gateway list --resource-group
                             [--max-items]
                             [--next-token]

範例

列出資源群組中的虛擬網路閘道。

az network vnet-gateway list -g MyResourceGroup

必要參數

--resource-group -g

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

選擇性參數

--max-items

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

--next-token

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

全域參數
--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 vnet-gateway list-advertised-routes

列出向指定對等公告的虛擬網路網關路由。

az network vnet-gateway list-advertised-routes --peer
                                               [--ids]
                                               [--name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

範例

列出向指定對等公告的虛擬網路網關路由。

az network vnet-gateway list-advertised-routes -g MyResourceGroup -n MyVnetGateway --peer 23.10.10.9

必要參數

--peer

對等的IP位址。

選擇性參數

--ids

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

--name -n

VNet 閘道名稱。

--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 vnet-gateway list-bgp-peer-status

擷取 BGP 對等互連的狀態。

az network vnet-gateway list-bgp-peer-status [--ids]
                                             [--name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--peer]
                                             [--resource-group]
                                             [--subscription]

範例

擷取 BGP 對等互連的狀態。

az network vnet-gateway list-bgp-peer-status -g MyResourceGroup -n MyVnetGateway --peer 23.10.10.9

選擇性參數

--ids

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

--name -n

VNet 閘道名稱。

--no-wait

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

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

要擷取狀態的對等IP位址。 預設值為 None。

--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 vnet-gateway list-learned-routes

此作業會擷取虛擬網路網關已學習的路由清單,包括從 BGP 對等互連學習的路由。

az network vnet-gateway list-learned-routes [--ids]
                                            [--name]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]

範例

擷取學習的路由清單。

az network vnet-gateway list-learned-routes -g MyResourceGroup -n MyVnetGateway

選擇性參數

--ids

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

--name -n

VNet 閘道名稱。

--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 vnet-gateway reset

重設虛擬網路閘道。

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

範例

重設虛擬網路閘道。

az network vnet-gateway reset -g MyResourceGroup -n MyVnetGateway

重設已啟用主動-主動功能的虛擬網路閘道。

az network vnet-gateway reset -g MyResourceGroup -n MyVnetGateway --gateway-vip MyGatewayIP

選擇性參數

--gateway-vip

提供給啟用主動-主動功能閘道之開始重設的虛擬網路閘道vip位址。

預設值: None
--ids

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

--name -n

VNet 閘道名稱。

--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 vnet-gateway show

取得虛擬網路閘道的詳細數據。

az network vnet-gateway show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

範例

取得虛擬網路閘道的詳細數據。

az network vnet-gateway show -g MyResourceGroup -n MyVnetGateway

選擇性參數

--ids

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

--name -n

VNet 閘道名稱。

--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 vnet-gateway show-supported-devices

預覽

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

取得支援的 vpn 裝置的 xml 格式表示法。

az network vnet-gateway show-supported-devices [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]

範例

取得支援的 vpn 裝置的 xml 格式表示法。

az network vnet-gateway show-supported-devices -g MyResourceGroup -n MyVnetGateway

選擇性參數

--ids

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

--name -n

VNet 閘道名稱。

--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 vnet-gateway update

更新虛擬網路閘道。

az network vnet-gateway update [--aad-audience]
                               [--aad-issuer]
                               [--aad-tenant]
                               [--add]
                               [--address-prefix]
                               [--allow-remote-vnet-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--allow-vwan-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                               [--asn]
                               [--bgp-peering-address]
                               [--client-protocol]
                               [--custom-routes]
                               [--enable-bgp {0, 1, f, false, n, no, t, true, y, yes}]
                               [--enable-private-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--gateway-default-site]
                               [--gateway-type {ExpressRoute, LocalGateway, Vpn}]
                               [--ids]
                               [--max-scale-unit]
                               [--min-scale-unit]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--peer-weight]
                               [--public-ip-address]
                               [--radius-secret]
                               [--radius-server]
                               [--remove]
                               [--resource-group]
                               [--root-cert-data]
                               [--root-cert-name]
                               [--set]
                               [--sku {Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ}]
                               [--subscription]
                               [--tags]
                               [--vnet]
                               [--vpn-auth-type]
                               [--vpn-type {PolicyBased, RouteBased}]

範例

變更虛擬網路閘道的 SKU。

az network vnet-gateway update -g MyResourceGroup -n MyVnetGateway --sku VpnGw2

更新虛擬網路閘道。

az network vnet-gateway update --address-prefixes 40.1.0.0/24 --client-protocol IkeV2 --name MyVnetGateway --resource-group MyResourceGroup

選擇性參數

--aad-audience

VirtualNetworkGateway 的 AADAudience 標識符。

--aad-issuer

VirtualNetworkGateway 的 AAD 簽發者 URI。

--aad-tenant

VirtualNetworkGateway 的 AAD 租使用者 URI。

--add

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

--address-prefix --address-prefixes

CIDR 前置詞的空間分隔清單,代表 P2S Vpnclient 的地址空間。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。 單一旗標: --address-prefix

--allow-remote-vnet-traffic

設定此閘道以接受來自其他 Azure 虛擬網絡 的流量。 此設定不支持連線到 Azure 虛擬 WAN。

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

設定此閘道以接受來自遠端虛擬網路的流量。

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

用於 BGP 設定的自發系統號碼。

--bgp-peering-address

用於 BGP 對等互連的 IP 位址。

--client-protocol

要用於連接的通訊協定。 允許的值:IkeV2、OpenVPN、SSTP。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

--custom-routes

CIDR 前置詞的空間分隔清單,代表客戶針對 VpnClient 所指定的自定義路由地址空間。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

--enable-bgp

啟用 BGP (邊界閘道通訊協定)。

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

是否需要在此閘道上啟用私人IP以進行連線。

接受的值: 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
--gateway-default-site

代表具有預設路由之局域網路網站之局域網路網關的名稱或標識符。

--gateway-type

閘道類型。

接受的值: ExpressRoute, LocalGateway, Vpn
--ids

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

--max-scale-unit

自動調整組態的最大縮放單位。

--min-scale-unit

自動調整組態的最小縮放單位。

--name -n

VNet 閘道名稱。

--no-wait

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

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

加權 (0-100) 已新增至透過 BGP 對等互連學習的路由。

--public-ip-address --public-ip-addresses

為主動待命閘道指定單一公用IP(名稱或標識碼)。 為主動-主動網關指定兩個以空格分隔的公用IP。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

--radius-secret

要用於驗證的半徑秘密。

--radius-server

要連線的半徑伺服器位址。

--remove

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

--resource-group -g

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

--root-cert-data

跟證書檔案或檔案路徑的Base64內容。

--root-cert-name

跟證書名稱。

--set

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

--sku

VNet 閘道 SKU。

接受的值: Basic, ErGw1AZ, ErGw2AZ, ErGw3AZ, ErGwScale, HighPerformance, Standard, UltraPerformance, VpnGw1, VpnGw1AZ, VpnGw2, VpnGw2AZ, VpnGw3, VpnGw3AZ, VpnGw4, VpnGw4AZ, VpnGw5, VpnGw5AZ
--subscription

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

--tags

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

--vnet

現有虛擬網路的名稱或標識符,其子網名為 『GatewaySubnet』。

--vpn-auth-type

已啟用虛擬網路閘道的 VPN 驗證類型。 支援速記語法、json-file 和 yaml-file。 請嘗試 “??” 以顯示更多。

--vpn-type

VPN 路由類型。

接受的值: PolicyBased, RouteBased
全域參數
--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 vnet-gateway wait

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

az network vnet-gateway 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

VNet 閘道名稱。

--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 來取得完整偵錯記錄。