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

az network vnet subnet

管理 Azure 虚拟网络中的子网。

若要了解有关子网的详细信息,请访问 https://docs.microsoft.com/azure/virtual-network/virtual-network-manage-subnet

命令

名称 说明 类型 Status
az network vnet subnet create

创建子网并关联现有 NSG 和路由表。

核心 GA
az network vnet subnet delete

删除子网。

核心 GA
az network vnet subnet list

列出虚拟网络中的子网。

核心 GA
az network vnet subnet list-available-delegations

列出可用于子网委派的服务。

核心 GA
az network vnet subnet list-available-ips

列出子网中的一些可用 IP。

核心 预览
az network vnet subnet show

显示子网的详细信息。

核心 GA
az network vnet subnet update

更新子网。

核心 GA
az network vnet subnet wait

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

核心 GA

az network vnet subnet create

创建子网并关联现有 NSG 和路由表。

az network vnet subnet create --name
                              --resource-group
                              --vnet-name
                              [--address-prefixes]
                              [--default-outbound {0, 1, f, false, n, no, t, true, y, yes}]
                              [--delegations]
                              [--disable-private-endpoint-network-policies {0, 1, f, false, n, no, t, true, y, yes}]
                              [--disable-private-link-service-network-policies {0, 1, f, false, n, no, t, true, y, yes}]
                              [--endpoints]
                              [--nat-gateway]
                              [--network-security-group]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ple-network-policies {Disabled, Enabled, NetworkSecurityGroupEnabled, RouteTableEnabled}]
                              [--pls-network-policies {Disabled, Enabled}]
                              [--route-table]
                              [--service-endpoint-policy]
                              [--service-endpoints]
                              [--sharing-scope {DelegatedServices, Tenant}]

示例

使用自定义路由表创建附加到 NSG 的新子网。

az network vnet subnet create -g MyResourceGroup --vnet-name MyVnet -n MySubnet --address-prefixes 10.0.0.0/24 --network-security-group MyNsg --route-table MyRouteTable

创建附加到 NAT 网关的新子网。

az network vnet subnet create -n MySubnet --vnet-name MyVnet -g MyResourceGroup --nat-gateway MyNatGateway --address-prefixes "10.0.0.0/21"

必需参数

--name -n

子网名称。

--resource-group -g

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

--vnet-name

虚拟网络(VNet)名称。

可选参数

--address-prefixes

以 CIDR 格式分隔的地址前缀的空格分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--default-outbound --default-outbound-access

将此属性设置为 false,以禁用子网中所有 VM 的默认出站连接。 此属性只能在创建子网时设置,并且不能为现有子网更新。

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

子网应委托给其空间分隔的服务列表,例如Microsoft.Sql/servers。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--disable-private-endpoint-network-policies

禁用子网上的专用终结点网络策略。 请注意,它将很快被 --private-endpoint-network-policies 替换。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--disable-private-link-service-network-policies

禁用子网上的专用链接服务网络策略。 请注意,它将很快被 --private-link-service-network-policies 替换。

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

服务终结点数组。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--nat-gateway

要附加的 NAT 网关的名称或 ID。

--network-security-group --nsg

网络安全组的名称或 ID(NSG)。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ple-network-policies --private-endpoint-network-policies

管理专用终结点的网络策略。

接受的值: Disabled, Enabled, NetworkSecurityGroupEnabled, RouteTableEnabled
默认值: Disabled
--pls-network-policies --private-link-service-network-policies

管理专用链接服务的网络策略。

接受的值: Disabled, Enabled
默认值: Enabled
--route-table

要与子网关联的路由表的名称或 ID。

--service-endpoint-policy

要应用的服务终结点策略的名称或 ID 的空格分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--service-endpoints

允许对此子网进行专用访问的服务的空间分隔列表。 值来源:az network vnet list-endpoint-services。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--sharing-scope

将此属性设置为“租户”,以允许与 AAD 租户中的其他订阅共享子网。 仅当 defaultOutboundAccess 设置为 false 时,才能设置此属性,仅当子网为空时,才能设置这两个属性。

接受的值: DelegatedServices, Tenant
全局参数
--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 vnet subnet delete

删除子网。

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

示例

删除子网。

az network vnet subnet delete --name MySubnet --resource-group MyResourceGroup --vnet-name MyVnet

可选参数

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource 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 配置默认订阅。

--vnet-name

虚拟网络(VNet)名称。

全局参数
--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 vnet subnet list

列出虚拟网络中的子网。

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

示例

列出虚拟网络中的子网。

az network vnet subnet list -g MyResourceGroup --vnet-name MyVNet

必需参数

--resource-group -g

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

--vnet-name

虚拟网络(VNet)名称。

可选参数

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

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

--verbose

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

az network vnet subnet list-available-delegations

列出可用于子网委派的服务。

az network vnet subnet list-available-delegations [--location]
                                                  [--max-items]
                                                  [--next-token]
                                                  [--resource-group]

示例

检索美国西部区域中可用委派的服务名称。

az network vnet subnet list-available-delegations -l westus --query [].serviceName

列出可用于子网委派的服务。 (自动生成)

az network vnet subnet list-available-delegations --resource-group MyResourceGroup

可选参数

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。 如果未指定,将使用资源组的位置。

--max-items

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

--next-token

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

--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 vnet subnet list-available-ips

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

列出子网中的一些可用 IP。

az network vnet subnet list-available-ips [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]
                                          [--vnet-name]

示例

列出子网中的一些可用 IP。

az network vnet subnet list-available-ips --resource-group MyResourceGroup --vnet-name MyVNet -n MySubnet

可选参数

--ids

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

--name -n

子网名称。

--resource-group -g

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

--subscription

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

--vnet-name

虚拟网络(VNet)名称。

全局参数
--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 vnet subnet show

显示子网的详细信息。

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

示例

显示与虚拟网络关联的子网的详细信息。

az network vnet subnet show -g MyResourceGroup -n MySubnet --vnet-name MyVNet

可选参数

--expand

展开引用的资源。 默认值为无。

--ids

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

--name -n

子网名称。

--resource-group -g

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

--subscription

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

--vnet-name

虚拟网络(VNet)名称。

全局参数
--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 vnet subnet update

更新子网。

az network vnet subnet update [--add]
                              [--address-prefixes]
                              [--default-outbound {0, 1, f, false, n, no, t, true, y, yes}]
                              [--delegations]
                              [--disable-private-endpoint-network-policies {0, 1, f, false, n, no, t, true, y, yes}]
                              [--disable-private-link-service-network-policies {0, 1, f, false, n, no, t, true, y, yes}]
                              [--endpoints]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--name]
                              [--nat-gateway]
                              [--network-security-group]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ple-network-policies {Disabled, Enabled, NetworkSecurityGroupEnabled, RouteTableEnabled}]
                              [--pls-network-policies {Disabled, Enabled}]
                              [--remove]
                              [--resource-group]
                              [--route-table]
                              [--service-endpoint-policy]
                              [--service-endpoints]
                              [--set]
                              [--sharing-scope {DelegatedServices, Tenant}]
                              [--subscription]
                              [--vnet-name]

示例

将网络安全组关联到子网。

az network vnet subnet update -g MyResourceGroup -n MySubnet --vnet-name MyVNet --network-security-group MyNsg

使用 NAT 网关更新子网。

az network vnet subnet update -n MySubnet --vnet-name MyVnet -g MyResourceGroup --nat-gateway MyNatGateway --address-prefixes "10.0.0.0/21"

禁用专用终结点网络策略。

az network vnet subnet update -n MySubnet --vnet-name MyVnet -g MyResourceGroup --private-endpoint-network-policies Disabled

分离子网中的网络安全组。

az network vnet subnet update -g MyResourceGroup --vnet-name MyVNet -n MySubnet --nsg null

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value、string 或 JSON 字符串>。

--address-prefixes

以 CIDR 格式分隔的地址前缀的空格分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--default-outbound --default-outbound-access

将此属性设置为 false,以禁用子网中所有 VM 的默认出站连接。 此属性只能在创建子网时设置,并且不能为现有子网更新。

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

子网应委托给其空间分隔的服务列表,例如Microsoft.Sql/servers。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--disable-private-endpoint-network-policies

禁用子网上的专用终结点网络策略。 请注意,它将很快被 --private-endpoint-network-policies 替换。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--disable-private-link-service-network-policies

禁用子网上的专用链接服务网络策略。 请注意,它将很快被 --private-link-service-network-policies 替换。

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

服务终结点数组。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--force-string

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

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

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

--name -n

子网名称。

--nat-gateway

要附加的 NAT 网关的名称或 ID。 使用 null 将其分离。

--network-security-group --nsg

网络安全组的名称或 ID(NSG)。 使用 null 将其分离。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ple-network-policies --private-endpoint-network-policies

管理专用终结点的网络策略。

接受的值: Disabled, Enabled, NetworkSecurityGroupEnabled, RouteTableEnabled
--pls-network-policies --private-link-service-network-policies

管理专用链接服务的网络策略。

接受的值: Disabled, Enabled
--remove

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

--resource-group -g

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

--route-table

要与子网关联的路由表的名称或 ID。 使用 null 将其分离。

--service-endpoint-policy

要应用的服务终结点策略的名称或 ID 的空格分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--service-endpoints

允许对此子网进行专用访问的服务的空间分隔列表。 值来源:az network vnet list-endpoint-services。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--set

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

--sharing-scope

将此属性设置为“租户”,以允许与 AAD 租户中的其他订阅共享子网。 仅当 defaultOutboundAccess 设置为 false 时,才能设置此属性,仅当子网为空时,才能设置这两个属性。

接受的值: DelegatedServices, Tenant
--subscription

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

--vnet-name

虚拟网络(VNet)名称。

全局参数
--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 vnet subnet wait

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

az network vnet subnet wait [--created]
                            [--custom]
                            [--deleted]
                            [--exists]
                            [--expand]
                            [--ids]
                            [--interval]
                            [--name]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]
                            [--vnet-name]

可选参数

--created

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

默认值: False
--custom

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

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--expand

展开引用的资源。 默认值为无。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource 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
--vnet-name

虚拟网络(VNet)名称。

全局参数
--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 获取完整的调试日志。