az network vnet

Reference

Manage Azure Virtual Networks.

To learn more about Virtual Networks visit https://docs.microsoft.com/azure/virtual-network/virtual-network-manage-network.

Commands

az network vnet check-ip-address	Check if a private IP address is available for use within a virtual network.
az network vnet create	Create a virtual network.
az network vnet delete	Delete a virtual network.
az network vnet list	List virtual networks.
az network vnet list-available-ips	List some available ips in the vnet.
az network vnet list-endpoint-services	List which services support VNET service tunneling in a given region.
az network vnet peering	Manage peering connections between Azure Virtual Networks.
az network vnet peering create	Create a virtual network peering connection.
az network vnet peering delete	Delete a peering.
az network vnet peering list	List peerings.
az network vnet peering show	Show details of a peering.
az network vnet peering sync	Sync a virtual network peering connection.
az network vnet peering update	Update a peering.
az network vnet show	Get the details of a virtual network.
az network vnet subnet	Manage subnets in an Azure Virtual Network.
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 list-available-ips	List some available ips in the subnet.
az network vnet subnet show	Show details of a subnet.
az network vnet subnet update	Update a subnet.
az network vnet tap	Manage virtual network taps.
az network vnet tap create	Create a virtual network tap.
az network vnet tap delete	Delete a virtual network tap.
az network vnet tap list	List virtual network taps.
az network vnet tap show	Get the details of a virtual network tap.
az network vnet tap update	Update settings of a virtual network tap.
az network vnet update	Update a virtual network.

az network vnet check-ip-address

Edit

Check if a private IP address is available for use within a virtual network.

az network vnet check-ip-address --ip-address
                                 [--ids]
                                 [--name]
                                 [--resource-group]

Examples

Check whether 10.0.0.4 is available within MyVnet.

az network vnet check-ip-address -g MyResourceGroup -n MyVnet --ip-address 10.0.0.4

Required Parameters

--ip-address

The private IP address to be verified.

Optional Parameters

--ids

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.

--name -n

The virtual network (VNet) name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network vnet create

Edit

Create a virtual network.

You may also create a subnet at the same time by specifying a subnet name and (optionally) an address prefix. To learn about how to create a virtual network visit https://docs.microsoft.com/azure/virtual-network/manage-virtual-network#create-a-virtual-network.

az network vnet create --name
                       --resource-group
                       [--address-prefixes]
                       [--bgp-community]
                       [--ddos-protection {false, true}]
                       [--ddos-protection-plan]
                       [--defer]
                       [--dns-servers]
                       [--edge-zone]
                       [--enable-encryption {false, true}]
                       [--encryption-enforcement-policy {allowUnencrypted, dropUnencrypted}]
                       [--flowtimeout]
                       [--location]
                       [--network-security-group]
                       [--subnet-name]
                       [--subnet-prefixes]
                       [--tags]
                       [--vm-protection {false, true}]

Examples

Create a virtual network.

az network vnet create -g MyResourceGroup -n MyVnet

Create a virtual network with a specific address prefix and one subnet.

az network vnet create -g MyResourceGroup -n MyVnet --address-prefix 10.0.0.0/16 \
    --subnet-name MySubnet --subnet-prefix 10.0.0.0/24

Create a virtual network. (autogenerated)

az network vnet create --address-prefixes 10.0.0.0/16 --name MyVirtualNetwork --resource-group MyResourceGroup --subnet-name MyAseSubnet --subnet-prefixes 10.0.0.0/24

Required Parameters

--name -n

The virtual network (VNet) name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--address-prefixes

Space-separated list of IP address prefixes for the VNet.

default value: 10.0.0.0/16

--bgp-community

The BGP community associated with the virtual network.

--ddos-protection

Control whether DDoS protection is enabled.

accepted values: false, true

--ddos-protection-plan

Name or ID of a DDoS protection plan to associate with the VNet.

--defer

Temporarily store the object in the local cache instead of sending to Azure. Use az cache commands to view/clear.

--dns-servers

Space-separated list of DNS server IP addresses.

--edge-zone

The name of edge zone.

--enable-encryption

Enable encryption on the virtual network.

accepted values: false, true

--encryption-enforcement-policy --encryption-policy

To control if the Virtual Machine without encryption is allowed in encrypted Virtual Network or not.

accepted values: allowUnencrypted, dropUnencrypted

--flowtimeout

The FlowTimeout value (in minutes) for the Virtual Network.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--network-security-group --nsg

Name or ID of a network security group (NSG).

--subnet-name

Name of a new subnet to create within the VNet.

--subnet-prefixes

Space-separated list of address prefixes in CIDR format for the new subnet. If omitted, automatically reserves a /24 (or as large as available) block within the VNet address space.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--vm-protection

Enable VM protection for all subnets in the VNet.

accepted values: false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network vnet delete

Edit

Delete a virtual network.

az network vnet delete [--ids]
                       [--name]
                       [--resource-group]

Examples

Delete a virtual network.

az network vnet delete -g MyResourceGroup -n myVNet

Optional Parameters

--ids

--name -n

The virtual network (VNet) name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network vnet list

Edit

List virtual networks.

az network vnet list [--resource-group]

Examples

List all virtual networks in a subscription.

az network vnet list

List all virtual networks in a resource group.

az network vnet list -g MyResourceGroup

List virtual networks in a subscription which specify a certain address prefix.

az network vnet list --query "[?contains(addressSpace.addressPrefixes, '10.0.0.0/16')]"

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network vnet list-available-ips

Edit

List some available ips in the vnet.

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

Examples

List some available ips in the vnet.

az network vnet list-available-ips -g MyResourceGroup -n MyVNet

Optional Parameters

--ids

--name -n

The virtual network (VNet) name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network vnet list-endpoint-services

Edit

List which services support VNET service tunneling in a given region.

To learn more about service endpoints visit https://docs.microsoft.com/azure/virtual-network/virtual-network-service-endpoints-configure#azure-cli.

az network vnet list-endpoint-services --location

Examples

List the endpoint services available for use in the West US region.

az network vnet list-endpoint-services -l westus -o table

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network vnet show

Edit

Get the details of a virtual network.

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

Examples

Get details for MyVNet.

az network vnet show -g MyResourceGroup -n MyVNet

Optional Parameters

--expand

Expands referenced resources. Default value is None.

--ids

--name -n

The virtual network (VNet) name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network vnet update

Edit

Update a virtual network.

az network vnet update [--add]
                       [--address-prefixes]
                       [--bgp-community]
                       [--ddos-protection {false, true}]
                       [--ddos-protection-plan]
                       [--defer]
                       [--dns-servers]
                       [--enable-encryption {false, true}]
                       [--encryption-enforcement-policy {allowUnencrypted, dropUnencrypted}]
                       [--flowtimeout]
                       [--force-string]
                       [--ids]
                       [--name]
                       [--remove]
                       [--resource-group]
                       [--set]
                       [--vm-protection {false, true}]

Examples

Update a virtual network with the IP address of a DNS server.

az network vnet update -g MyResourceGroup -n MyVNet --dns-servers 10.2.0.8

Update a virtual network to delete DNS server.

az network vnet update -g MyResourceGroup -n MyVNet --dns-servers ''

Update a virtual network. (autogenerated)

az network vnet update --address-prefixes 40.1.0.0/24 --name MyVNet --resource-group MyResourceGroup

Optional Parameters

--add

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

--address-prefixes

Space-separated list of IP address prefixes for the VNet.

--bgp-community

The BGP community associated with the virtual network.

--ddos-protection

Control whether DDoS protection is enabled.

accepted values: false, true

--ddos-protection-plan

Name or ID of a DDoS protection plan to associate with the VNet.

--defer

Temporarily store the object in the local cache instead of sending to Azure. Use az cache commands to view/clear.

--dns-servers

Space-separated list of DNS server IP addresses.

--enable-encryption

Enable encryption on the virtual network.

accepted values: false, true

--encryption-enforcement-policy --encryption-policy

To control if the Virtual Machine without encryption is allowed in encrypted Virtual Network or not.

accepted values: allowUnencrypted, dropUnencrypted

--flowtimeout

The FlowTimeout value (in minutes) for the Virtual Network.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

--name -n

The virtual network (VNet) name.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--vm-protection

Enable VM protection for all subnets in the VNet.

accepted values: false, true

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network vnet

Commands

az network vnet check-ip-address

Examples

Required Parameters

Optional Parameters

az network vnet create

Examples

Required Parameters

Optional Parameters

az network vnet delete

Examples

Optional Parameters

az network vnet list

Examples

Optional Parameters

az network vnet list-available-ips

Examples

Optional Parameters

az network vnet list-endpoint-services

Examples

Required Parameters

az network vnet show

Examples

Optional Parameters

az network vnet update

Examples

Optional Parameters

Feedback