共用方式為


az network local-gateway

管理本機閘道。

如需本機閘道的詳細資訊,請流覽: https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli#localnet

命令

名稱 Description 類型 狀態
az network local-gateway create

建立本機 VPN 閘道。

核心 GA
az network local-gateway delete

刪除本機 VPN 閘道。

核心 GA
az network local-gateway list

列出資源群組中的所有本機 VPN 閘道。

核心 GA
az network local-gateway show

取得本機 VPN 閘道的詳細資料。

核心 GA
az network local-gateway update

更新本機 VPN 閘道。

核心 GA
az network local-gateway wait

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

核心 GA

az network local-gateway create

建立本機 VPN 閘道。

az network local-gateway create --name
                                --resource-group
                                [--address-prefixes]
                                [--asn]
                                [--bgp-peering-address]
                                [--gateway-ip-address]
                                [--location]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--peer-weight]
                                [--tags]

範例

建立局域網路閘道來代表您的內部部署網站。

az network local-gateway create -g MyResourceGroup -n MyLocalGateway --gateway-ip-address 23.99.221.164 --local-address-prefixes 10.0.0.0/24 20.0.0.0/24

必要參數

--name -n

局域網路閘道的名稱。

--resource-group -g

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

選擇性參數

--address-prefixes --local-address-prefixes

CIDR 區塊前置詞的清單,代表 OnPremise VPN 子網的位址空間。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--asn

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

--bgp-peering-address

要用於 BGP 對等互連之 OnPremise VPN 子網的 IP 位址。

--gateway-ip-address

閘道的公用 IP 位址。 (例如10.1.1.1.1)。

--location -l

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

--no-wait

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

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

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

--tags

以空格分隔的標記:key[=value] [key[=value] ...]。支援速記語法、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 local-gateway delete

刪除本機 VPN 閘道。

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

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

範例

刪除局域網路閘道。

az network local-gateway delete -g MyResourceGroup -n MyLocalGateway

刪除本機 VPN 閘道。 (自動產生)

az network local-gateway delete --name MyLocalGateway --resource-group MyResourceGroup --subscription MySubscription

選擇性參數

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

列出資源群組中的所有本機 VPN 閘道。

az network local-gateway list --resource-group

範例

列出資源群組中的所有本機 VPN 閘道。

az network local-gateway list -g MyResourceGroup

必要參數

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

取得本機 VPN 閘道的詳細資料。

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

範例

取得本機 VPN 閘道的詳細資料。

az network local-gateway show -g MyResourceGroup -n MyLocalGateway

選擇性參數

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

更新本機 VPN 閘道。

az network local-gateway update [--add]
                                [--address-prefixes]
                                [--asn]
                                [--bgp-peering-address]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--gateway-ip-address]
                                [--ids]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--peer-weight]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--subscription]
                                [--tags]

範例

更新以 10.0.0.0/24 位址首碼布建的局域網路閘道,並加上額外的前置詞。

az network local-gateway update -g MyResourceGroup -n MyLocalGateway --address-prefixes 10.0.0.0/24 20.0.0.0/24 30.0.0.0/24

更新本機 VPN 閘道。 (自動產生)

az network local-gateway update --gateway-ip-address 23.99.221.164 --name MyLocalGateway --resource-group MyResourceGroup

選擇性參數

--add

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

--address-prefixes --local-address-prefixes

CIDR 區塊前置詞的清單,代表 OnPremise VPN 子網的位址空間。 支援速記語法、json-file 和 yaml-file。 請嘗試 「??」 以顯示更多。

--asn

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

--bgp-peering-address

要用於 BGP 對等互連之 OnPremise VPN 子網的 IP 位址。

--force-string

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

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

閘道的公用 IP 位址。 (例如10.1.1.1.1)。

--ids

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

--name -n

局域網路閘道的名稱。

--no-wait

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

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

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

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

--tags

以空格分隔的標記:key[=value] [key[=value] ...]。支援速記語法、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 local-gateway wait

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

az network local-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

局域網路閘道的名稱。

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