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

az network vpn-gateway nat-rule

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.55.0 or higher). 该扩展会在首次运行 az network vpn-gateway nat-rule 命令时自动安装。 Learn more about extensions.

管理站点到站点 VPN 网关 nat 规则。

命令

名称	说明	类型	Status
az network vpn-gateway nat-rule create	如果不存在 nat 规则，请为可缩放的 VPN 网关创建 nat 规则，否则会更新现有的 nat 规则。	Extension	GA
az network vpn-gateway nat-rule delete	删除 nat 规则。	Extension	GA
az network vpn-gateway nat-rule list	列出特定虚拟 WAN VPN 网关的所有 nat 规则。	Extension	GA
az network vpn-gateway nat-rule show	获取 nat ruleGet 的详细信息。	Extension	GA
az network vpn-gateway nat-rule update	如果 NAT 规则不存在，请将 nat 规则更新为可缩放的 VPN 网关，否则会更新现有的 nat 规则。	Extension	GA
az network vpn-gateway nat-rule wait	将 CLI 置于等待状态，直到满足条件。	Extension	GA

az network vpn-gateway nat-rule create

如果不存在 nat 规则，请为可缩放的 VPN 网关创建 nat 规则，否则会更新现有的 nat 规则。

az network vpn-gateway nat-rule create --gateway-name
                                       --name
                                       --resource-group
                                       [--external-mappings]
                                       [--internal-mappings]
                                       [--ip-config-id]
                                       [--mode {EgressSnat, IngressSnat}]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--type {Dynamic, Static}]

示例

创建 nat 规则。

az network vpn-gateway nat-rule create -g MyResourceGroup --gateway-name MyVpnGateway --name MyNatRule --internal-mappings [{"address-space":10.4.0.0/24}] --external-mappings [{"address-space":192.168.21.0/24}] --type Static --mode EgressSnat

必需参数

--gateway-name

网关的名称。

--name -n

nat 规则的名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--external-mappings

NAT 的专用 IP 地址外部映射。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--internal-mappings

NAT 的专用 IP 地址内部映射。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--ip-config-id

此 NAT 规则适用的 IP 配置 ID。

属性	值
Parameter group:	Properties Arguments

--mode

VPN NAT 的源 NAT 方向。

属性	值
Parameter group:	Properties Arguments
接受的值:	EgressSnat, IngressSnat

--no-wait

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

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

--type

VPN NAT 的 NAT 规则的类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	Dynamic, Static

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

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

属性	值
默认值:	False

az network vpn-gateway nat-rule delete

删除 nat 规则。

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

示例

删除 nat 规则。

az network vpn-gateway nat-rule delete -g MyResourceGroup --gateway-name MyVpnGateway --name MyNatRule -y

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--gateway-name

网关的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--name -n

nat 规则的名称。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

az network vpn-gateway nat-rule list

列出特定虚拟 WAN VPN 网关的所有 nat 规则。

az network vpn-gateway nat-rule list --gateway-name
                                     --resource-group
                                     [--max-items]
                                     [--next-token]

示例

列出所有 nat 规则。

az network vpn-gateway nat-rule list -g MyResourceGroup --gateway-name MyVpnGateway

必需参数

--gateway-name

网关的名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
Parameter group:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

属性	值
Parameter group:	Pagination Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

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

--verbose

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

属性	值
默认值:	False

az network vpn-gateway nat-rule show

获取 nat ruleGet 的详细信息。

az network vpn-gateway nat-rule show [--gateway-name]
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

示例

获取 nat 规则的详细信息。

az network vpn-gateway nat-rule show -g MyResourceGroup --gateway-name MyVpnGateway --name MyNatRule

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--gateway-name

网关的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--name -n

nat 规则的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

az network vpn-gateway nat-rule update

如果 NAT 规则不存在，请将 nat 规则更新为可缩放的 VPN 网关，否则会更新现有的 nat 规则。

az network vpn-gateway nat-rule update [--add]
                                       [--external-mappings]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--gateway-name]
                                       [--ids]
                                       [--internal-mappings]
                                       [--ip-config-id]
                                       [--mode {EgressSnat, IngressSnat}]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--subscription]
                                       [--type {Dynamic, Static}]

示例

更新 nat 规则。

az network vpn-gateway nat-rule update -g MyResourceGroup --gateway-name MyVpnGateway --name MyNatRule --internal-mappings [{"address-space":10.3.0.0/24}]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

属性	值
Parameter group:	Generic Update Arguments

--external-mappings

NAT 的专用 IP 地址外部映射。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--gateway-name

网关的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--internal-mappings

NAT 的专用 IP 地址内部映射。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--ip-config-id

此 NAT 规则适用的 IP 配置 ID。

属性	值
Parameter group:	Properties Arguments

--mode

VPN NAT 的源 NAT 方向。

属性	值
Parameter group:	Properties Arguments
接受的值:	EgressSnat, IngressSnat

--name -n

nat 规则的名称。

属性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--remove

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

属性	值
Parameter group:	Generic Update Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--set

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

属性	值
Parameter group:	Generic Update Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--type

VPN NAT 的 NAT 规则的类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	Dynamic, Static

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

az network vpn-gateway nat-rule wait

将 CLI 置于等待状态，直到满足条件。

az network vpn-gateway nat-rule wait [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--gateway-name]
                                     [--ids]
                                     [--interval]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]
                                     [--timeout]
                                     [--updated]

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性	值
Parameter group:	Wait Condition Arguments

--deleted

等到删除为止。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--exists

等待资源存在。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

--gateway-name

网关的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

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

属性	值
Parameter group:	Resource Id Arguments

--interval

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

属性	值
Parameter group:	Wait Condition Arguments
默认值:	30

--name -n

nat 规则的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

属性	值
Parameter group:	Resource Id Arguments

--subscription

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

属性	值
Parameter group:	Resource Id Arguments

--timeout

最大等待（以秒为单位）。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	3600

--updated

等到 provisioningState 更新为“Succeeded”。

属性	值
Parameter group:	Wait Condition Arguments
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

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

属性	值
默认值:	False

通过

az network vpn-gateway nat-rule

命令

az network vpn-gateway nat-rule create

示例

必需参数

可选参数

az network vpn-gateway nat-rule delete

示例

可选参数

az network vpn-gateway nat-rule list

示例

必需参数

可选参数

az network vpn-gateway nat-rule show

示例

可选参数

az network vpn-gateway nat-rule update

示例

可选参数

az network vpn-gateway nat-rule wait

可选参数

反馈