VM network interfaces - az vm nic

Manage network interfaces, see also 'az network nic'.

A network interface (NIC) is the interconnection between a VM and the underlying software network. For more information, see https://docs.microsoft.com/azure/virtual-network/virtual-network-network-interface-overview.

Commands

az vm nic add Add network interface configurations to the virtual machine.
az vm nic list List network interface configurations attached to a virtual machine.
az vm nic remove Remove network interface configurations from the virtual machine.
az vm nic set Replace existing network interface configurations on the virtual machine.
az vm nic show Show details of a network interface configuration attached to a virtual machine.

az vm nic add

Add network interface configurations to the virtual machine.

az vm nic add --nics
--resource-group
--vm-name
[--primary-nic]

Examples

Add two NICs to a VM.

az vm nic add -g MyResourceGroup --vm-name MyVm --nics nic_name1 nic_name2

Required Parameters

--nics

Names or IDs of NICs.

--resource-group -g

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

--vm-name

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=.

Optional Parameters

--primary-nic

Name or id of the primary NIC. If missing, the first of the NIC list will be the primary.

az vm nic list

List network interface configurations attached to a virtual machine.

az vm nic list --resource-group
--vm-name

Examples

List all of the NICs on a VM.

az vm nic list -g MyResourceGroup --vm-name MyVm

Required Parameters

--resource-group -g

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

--vm-name

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=.

az vm nic remove

Remove network interface configurations from the virtual machine.

az vm nic remove --nics
--resource-group
--vm-name
[--primary-nic]

Examples

Remove two NICs from a VM.

az vm nic remove -g MyResourceGroup --vm-name MyVm --nics nic_name1 nic_name2

Required Parameters

--nics

Names or IDs of NICs.

--resource-group -g

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

--vm-name

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=.

Optional Parameters

--primary-nic

Name or id of the primary NIC. If missing, the first of the NIC list will be the primary.

az vm nic set

Replace existing network interface configurations on the virtual machine.

az vm nic set --nics
--resource-group
--vm-name
[--primary-nic]

Examples

Set a NIC on a VM to be primary.

az vm nic set -g MyResourceGroup --vm-name MyVm --nic nic_name1 nic_name2 --primary-nic nic_name2

Required Parameters

--nics

Names or IDs of NICs.

--resource-group -g

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

--vm-name

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=.

Optional Parameters

--primary-nic

Name or id of the primary nic. If missing, the first element of nic list will be set to the primary.

az vm nic show

Show details of a network interface configuration attached to a virtual machine.

az vm nic show --nic
--resource-group
--vm-name

Examples

Show details of a NIC on a VM.

az vm nic show -g MyResourceGroup --vm-name MyVm --nic nic_name1

Required Parameters

--nic

NIC name or ID.

--resource-group -g

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

--vm-name

The name of the Virtual Machine. You can configure the default using az configure --defaults vm=.