az network vnet subnet
Manage subnets in an Azure Virtual Network.
To learn more about subnets visit https://docs.microsoft.com/azure/virtual-network/virtual-network-manage-subnet.
Commands
az network vnet subnet create |
Create a subnet and associate an existing NSG and route table. |
az network vnet subnet delete |
Delete a subnet. |
az network vnet subnet list |
List the subnets in a virtual network. |
az network vnet subnet list-available-delegations |
List the services available for subnet delegation. |
az network vnet subnet show |
Show details of a subnet. |
az network vnet subnet update |
Update a subnet. |
az network vnet subnet create
Create a subnet and associate an existing NSG and route table.
az network vnet subnet create --address-prefixes
--name
--resource-group
--vnet-name
[--defer]
[--delegations]
[--disable-private-endpoint-network-policies {false, true}]
[--disable-private-link-service-network-policies {false, true}]
[--nat-gateway]
[--network-security-group]
[--route-table]
[--service-endpoint-policy]
[--service-endpoints]
[--subscription]
Examples
Create new subnet attached to an NSG with a custom route table.
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
Create new subnet attached to a NAT gateway.
az network vnet subnet create -n MySubnet --vnet-name MyVnet -g MyResourceGroup --nat-gateway MyNatGateway --address-prefixes "10.0.0.0/21"
Required Parameters
Space-separated list of address prefixes in CIDR format.
The subnet name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The virtual network (VNet) name.
Optional Parameters
Temporarily store the object in the local cache instead of sending to Azure. Use az cache
commands to view/clear.
Space-separated list of services to whom the subnet should be delegated. (e.g. Microsoft.Sql/servers).
Disable private endpoint network policies on the subnet.
Disable private link service network policies on the subnet.
Attach Nat Gateway to subnet.
Name or ID of a network security group (NSG).
Name or ID of a route table to associate with the subnet.
Space-separated list of names or IDs of service endpoint policies to apply.
Space-separated list of services allowed private access to this subnet.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet subnet delete
Delete a subnet.
az network vnet subnet delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--vnet-name]
Examples
Delete a subnet.
az network vnet subnet delete -g MyResourceGroup -n MySubnet
Delete a subnet. (autogenerated)
az network vnet subnet delete --name MySubnet --resource-group MyResourceGroup --vnet-name MyVnet
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The subnet name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The virtual network (VNet) name.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet subnet list
List the subnets in a virtual network.
az network vnet subnet list --resource-group
--vnet-name
[--query-examples]
[--subscription]
Examples
List the subnets in a virtual network.
az network vnet subnet list -g MyResourceGroup --vnet-name MyVNet
Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The virtual network (VNet) name.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet subnet list-available-delegations
List the services available for subnet delegation.
az network vnet subnet list-available-delegations [--location]
[--resource-group]
[--subscription]
Examples
Retrieve the service names for available delegations in the West US region.
az network vnet subnet list-available-delegations -l westus --query [].serviceName
List the services available for subnet delegation. (autogenerated)
az network vnet subnet list-available-delegations --resource-group MyResourceGroup
Optional Parameters
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet subnet show
Show details of a subnet.
az network vnet subnet show [--expand]
[--ids]
[--name]
[--query-examples]
[--resource-group]
[--subscription]
[--vnet-name]
Examples
Show the details of a subnet associated with a virtual network.
az network vnet subnet show -g MyResourceGroup -n MySubnet --vnet-name MyVNet
Optional Parameters
Expands referenced resources.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The subnet name.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The virtual network (VNet) name.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet subnet update
Update a subnet.
az network vnet subnet update [--add]
[--address-prefixes]
[--delegations]
[--disable-private-endpoint-network-policies {false, true}]
[--disable-private-link-service-network-policies {false, true}]
[--force-string]
[--ids]
[--name]
[--nat-gateway]
[--network-security-group]
[--remove]
[--resource-group]
[--route-table]
[--service-endpoint-policy]
[--service-endpoints]
[--set]
[--subscription]
[--vnet-name]
Examples
Associate a network security group to a subnet.
az network vnet subnet update -g MyResourceGroup -n MySubnet --vnet-name MyVNet --network-security-group MyNsg
Update subnet with NAT gateway.
az network vnet subnet update -n MySubnet --vnet-name MyVnet -g MyResourceGroup --nat-gateway MyNatGateway --address-prefixes "10.0.0.0/21"
Disable the private endpoint network policies
az network vnet subnet update -n MySubnet --vnet-name MyVnet -g MyResourceGroup --disable-private-endpoint-network-policies
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Space-separated list of address prefixes in CIDR format.
Space-separated list of services to whom the subnet should be delegated. (e.g. Microsoft.Sql/servers).
Disable private endpoint network policies on the subnet.
Disable private link service network policies on the subnet.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The subnet name.
Attach Nat Gateway to subnet.
Name or ID of a network security group (NSG). Use empty string ""('""' in PowerShell) to detach it.
Remove a property or an element from a list. Example: --remove property.list
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of a route table to associate with the subnet. Use empty string ""('""' in PowerShell) to detach it. You can also append "--remove routeTable" in "az network vnet subnet update" to detach it.
Space-separated list of names or IDs of service endpoint policies to apply.
Space-separated list of services allowed private access to this subnet.
Update an object by specifying a property path and value to set. Example: --set property1.property2=
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The virtual network (VNet) name.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.