NIC IP configurations - az network nic ip-config

Manage IP configurations of a network interface.

Commands

az network nic ip-config address-pool Manage backend address pools in an IP configuration.
az network nic ip-config address-pool add Add a backend address pool.
az network nic ip-config address-pool remove Remove a backend address pool.
az network nic ip-config create Create an IP configuration.
az network nic ip-config delete Delete an IP configuration.
az network nic ip-config inbound-nat-rule Manage inbound NAT rules for an IP configuration.
az network nic ip-config inbound-nat-rule add Add an inbound NAT rule.
az network nic ip-config inbound-nat-rule remove Remove an inbound NAT rule.
az network nic ip-config list List IP configurations.
az network nic ip-config show Show details of an IP configuration.
az network nic ip-config update Update an IP configuration.

az network nic ip-config create

You must have the Microsoft.Network/AllowMultipleIpConfigurationsPerNic feature enabled for your subscription. Only one configuration may be designated as the primary IP configuration per NIC, using the --make-primary flag.

az network nic ip-config create --name
--nic-name
--resource-group
[--lb-address-pools]
[--lb-inbound-nat-rules]
[--lb-name]
[--make-primary]
[--private-ip-address]
[--private-ip-address-version {IPv4, IPv6}]
[--public-ip-address]
[--subnet]
[--vnet-name]

Required Parameters

--name -n

The name of the IP configuration.

--nic-name

The network interface (NIC).

--resource-group -g

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

Optional Parameters

--lb-address-pools

Space separated list of names or IDs of load balancer address pools to associate with the NIC. If names are used, --lb-name must be specified.

--lb-inbound-nat-rules

Space separated list of names or IDs of load balancer inbound NAT rules to associate with the NIC. If names are used, --lb-name must be specified.

--lb-name

The name of the load balancer to use when adding NAT rules or address pools by name (ignored when IDs are specified).

--make-primary

Set to make this configuration the primary one for the NIC.

--private-ip-address

Static private IP address to use.

--private-ip-address-version
accepted values: IPv4, IPv6
--public-ip-address

Name or ID of the public IP to use.

--subnet

Name or ID of an existing subnet. If name is specified, also specify --vnet-name.

--vnet-name

The virtual network (VNet) associated with the subnet (Omit if supplying a subnet id).

az network nic ip-config delete

A NIC must have at least one IP configuration.

az network nic ip-config delete --name
--nic-name
--resource-group
[--no-wait]

Required Parameters

--name -n

The name of the IP configuration.

--nic-name

The network interface (NIC).

--resource-group -g

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

Optional Parameters

--no-wait

az network nic ip-config list

List IP configurations.

az network nic ip-config list --nic-name
--resource-group

Required Parameters

--nic-name

The network interface (NIC).

--resource-group -g

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

az network nic ip-config show

Show details of an IP configuration.

az network nic ip-config show --name
--nic-name
--resource-group

Required Parameters

--name -n

The name of the IP configuration.

--nic-name

The network interface (NIC).

--resource-group -g

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

az network nic ip-config update

Update an IP configuration.

az network nic ip-config update --name
--nic-name
--resource-group
[--add]
[--lb-address-pools]
[--lb-inbound-nat-rules]
[--lb-name]
[--make-primary]
[--private-ip-address]
[--private-ip-address-version {IPv4, IPv6}]
[--public-ip-address]
[--remove]
[--set]
[--subnet]
[--vnet-name]

Examples

Update the NIC to use a new private IP address.

az network nic ip-config update -g MyResourceGroup --nic-name MyNic -n MyIpConfig --private-ip-address 10.0.0.9

Make this IP configuration the default for the supplied NIC.

az network nic ip-config update -g MyResourceGroup --nic-name MyNic -n MyIpConfig --make-primary

Required Parameters

--name -n

The name of the IP configuration.

--nic-name

The network interface (NIC).

--resource-group -g

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .

--lb-address-pools

Space separated list of names or IDs of load balancer address pools to associate with the NIC. If names are used, --lb-name must be specified.

--lb-inbound-nat-rules

Space separated list of names or IDs of load balancer inbound NAT rules to associate with the NIC. If names are used, --lb-name must be specified.

--lb-name

The name of the load balancer to use when adding NAT rules or address pools by name (ignored when IDs are specified).

--make-primary

Set to make this configuration the primary one for the NIC.

--private-ip-address

Static private IP address to use.

--private-ip-address-version
accepted values: IPv4, IPv6
default value: ipv4
--public-ip-address

Name or ID of the public IP to use.

--remove

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

--set

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

--subnet

Name or ID of an existing subnet. If name is specified, also specify --vnet-name.

--vnet-name

The virtual network (VNet) associated with the subnet (Omit if supplying a subnet id).