通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az network local-gateway

  • 参考

管理本地网关。

有关本地网关的详细信息，请访问： https://docs.microsoft.com/azure/vpn-gateway/vpn-gateway-howto-site-to-site-resource-manager-cli#localnet

命令

名称 说明 类型 Status
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

表示 OnPremise VPN 子网的地址空间的 CIDR 块前缀列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--asn

用于 BGP 设置的自治系统编号。

--bgp-peering-address

要用于 BGP 对等互连的 OnPremise VPN 子网中的 IP 地址。

--gateway-ip-address

网关的公共 IP 地址。 （例如 10.1.1.1）。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

不等待长时间运行的操作完成。

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

添加到通过 BGP 对等互连学习的路由的权重（0-100）。

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

订阅的名称或 ID。 可以使用 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

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

本地网络网关的名称。

--no-wait

不等待长时间运行的操作完成。

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

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

本地网络网关的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

表示 OnPremise VPN 子网的地址空间的 CIDR 块前缀列表。 支持速记语法、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）。

--ids

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--name -n

本地网络网关的名称。

--no-wait

不等待长时间运行的操作完成。

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

添加到通过 BGP 对等互连学习的路由的权重（0-100）。

--remove

从列表中删除属性或元素。 示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=。

--subscription

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 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

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--interval

轮询间隔（以秒为单位）。

默认值: 30
--name -n

本地网络网关的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。