Set-AzNetworkInterfaceIpConfig

Module:

Az.Network Module

Updates an IP configuration for a network interface.

Set-AzNetworkInterfaceIpConfig
 -Name <String>
 -NetworkInterface <PSNetworkInterface>
 [-PrivateIpAddressVersion <String>]
 [-PrivateIpAddress <String>]
 [-Primary]
 [-Subnet <PSSubnet>]
 [-PublicIpAddress <PSPublicIpAddress>]
 [-LoadBalancerBackendAddressPool <PSBackendAddressPool[]>]
 [-LoadBalancerInboundNatRule <PSInboundNatRule[]>]
 [-ApplicationGatewayBackendAddressPool <PSApplicationGatewayBackendAddressPool[]>]
 [-ApplicationSecurityGroup <PSApplicationSecurityGroup[]>]
 [-GatewayLoadBalancerId <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Set-AzNetworkInterfaceIpConfig
 -Name <String>
 -NetworkInterface <PSNetworkInterface>
 [-PrivateIpAddressVersion <String>]
 [-PrivateIpAddress <String>]
 [-Primary]
 [-SubnetId <String>]
 [-PublicIpAddressId <String>]
 [-LoadBalancerBackendAddressPoolId <String[]>]
 [-LoadBalancerInboundNatRuleId <String[]>]
 [-ApplicationGatewayBackendAddressPoolId <String[]>]
 [-ApplicationSecurityGroupId <String[]>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

The Set-AzNetworkInterfaceIpConfig cmdlet updates an IP configuration for a network interface.

$vnet = Get-AzVirtualNetwork -Name myvnet -ResourceGroupName myrg
$subnet = Get-AzVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet

$nic = Get-AzNetworkInterface -Name nic1 -ResourceGroupName myrg

$nic | Set-AzNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet -Primary

$nic | Set-AzNetworkInterface

The first two commands get a virtual network called myvnet and a subnet called mysubnet and store it in the variables $vnet and $subnet respectively. The third command gets the network interface nic1 associated with the IP configuration that needs to be updated. The third command sets the private IP address of the primary IP configuration ipconfig1 to 10.0.0.11. Finally, the last command updates the network interface ensuring the changes have been made successfully.

$vnet = Get-AzVirtualNetwork -Name myvnet -ResourceGroupName myrg
$subnet = Get-AzVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet
$asg = Get-AzApplicationSecurityGroup -Name myasg -ResourceGroupName myrg

$nic = Get-AzNetworkInterface -Name nic1 -ResourceGroupName myrg

$nic | Set-AzNetworkInterfaceIpConfig -Name ipconfig1 -PrivateIpAddress 10.0.0.11 -Subnet $subnet -ApplicationSecurityGroup $asg -Primary

$nic | Set-AzNetworkInterface

In this example, the variable $asg contains a reference to an application security group. The fourth command gets the network interface nic1 associated with the IP configuration that needs to be updated. The Set-AzNetworkInterfaceIpConfig sets the private IP address of the primary IP configuration ipconfig1 to 10.0.0.11 and creates an association with the retrieved application security group. Finally, the last command updates the network interface ensuring the changes have been made successfully.

$nic = Get-AzNetworkInterface -Name nic1 -ResourceGroupName myrg

$nic | Set-AzNetworkInterfaceIpConfig -Name ipconfig1 -ApplicationGatewayBackendAddressPool $null

$nic | Set-AzNetworkInterface

The Set-AzNetworkInterfaceIpConfig sets the application gateway backend address pool of the IP configuration ipconfig1 to null and disassociate with the network interface. Finally, the last command updates the network interface ensuring the changes have been made successfully.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

• Keywords: azure, azurerm, arm, resource, management, manager, network, networking