通过

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

az network nat gateway

管理 NAT 网关。

命令

名称 说明 类型 Status
az network nat gateway create

创建 NAT 网关。

 Core GA
az network nat gateway delete

删除 NAT 网关。

 Core GA
az network nat gateway list

列出 NAT 网关。

 Core GA
az network nat gateway show

显示 NAT 网关的详细信息。

 Core GA
az network nat gateway update

更新 NAT 网关。

 Core GA
az network nat gateway wait

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

 Core GA

az network nat gateway create

编辑

创建 NAT 网关。

az network nat gateway create --name
                              --resource-group
                              [--idle-timeout]
                              [--location]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--pip-addresses-v6]
                              [--pip-prefixes-v6]
                              [--public-ip-addresses]
                              [--public-ip-prefixes]
                              [--sku {Standard, StandardV2}]
                              [--source-vnet]
                              [--tags]
                              [--zone]

示例

创建 NAT 网关。

az network nat gateway create --resource-group MyResourceGroup --name MyNatGateway --location MyLocation --public-ip-addresses  MyPublicIp --public-ip-prefixes MyPublicIpPrefix --idle-timeout 4 --zone 2

必需参数

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

--idle-timeout

空闲超时（以分钟为单位）。

--location -l

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

--no-wait

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

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

与 nat 网关资源关联的公有 IP 地址 V6 数组。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--pip-prefixes-v6

与 nat 网关资源关联的公有 IP 前缀 V6 数组。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--public-ip-addresses

公共 IP 地址（名称或 ID）的空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--public-ip-prefixes

公共 IP 前缀（名称或 ID）的空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--sku

Nat 网关 SKU 的名称。

属性 值
默认值: Standard
接受的值: Standard, StandardV2
--source-vnet

使用此 nat 网关资源对源虚拟网络的引用。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--tags

空格分隔标记：key[=value] [key[=value] ...]。支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--zone -z

要在其中预配资源的可用性区域。 允许的值：1、2、3。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: 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 nat gateway delete

编辑

删除 NAT 网关。

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

示例

删除 NAT 网关。

az network nat gateway delete --resource-group MyResourceGroup --name MyNatGateway

可选参数

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

--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
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az network nat gateway list

编辑

列出 NAT 网关。

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

示例

列出 NAT 网关。

az network nat gateway list -g MyResourceGroup

可选参数

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
--resource-group -g

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

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: 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 nat gateway show

编辑

显示 NAT 网关的详细信息。

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

示例

显示 NAT 网关的详细信息。

az network nat gateway show --resource-group MyResourceGroup --name MyNatGateway

使用 ID 显示 NAT 网关。

az network nat gateway show --ids {GatewayId}

可选参数

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

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

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az network nat gateway update

编辑

更新 NAT 网关。

az network nat gateway update [--add]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--idle-timeout]
                              [--ids]
                              [--name]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--pip-addresses-v6]
                              [--pip-prefixes-v6]
                              [--public-ip-addresses]
                              [--public-ip-prefixes]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--source-vnet]
                              [--subscription]
                              [--tags]

示例

更新 NAT 网关。

az network nat gateway update -g MyResourceGroup --name MyNatGateway --idle-timeout 5

可选参数

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

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

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

空闲超时（以分钟为单位）。

--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
--pip-addresses-v6

与 nat 网关资源关联的公有 IP 地址 V6 数组。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--pip-prefixes-v6

与 nat 网关资源关联的公有 IP 前缀 V6 数组。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--public-ip-addresses

公共 IP 地址（名称或 ID）的空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--public-ip-prefixes

公共 IP 前缀（名称或 ID）的空间分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

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

使用此 nat 网关资源对源虚拟网络的引用。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--subscription

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

属性 值
Parameter group: Resource Id Arguments
--tags

空格分隔标记：key[=value] [key[=value] ...]。支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--verbose

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

属性 值
默认值: False

az network nat gateway wait

编辑

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

az network nat gateway wait [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--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
--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

输出格式。

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

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

--verbose

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

属性 值
默认值: False