Set-AzNetworkInterfaceIpConfig
Updates an IP configuration for a network interface.
Syntax
SetByResource (Default)
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>]
SetByResourceId
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>]
Description
The Set-AzNetworkInterfaceIpConfig cmdlet updates an IP configuration for a network interface.
Examples
Example 1: Changing the IP address of an IP configuration
$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.
Example 2: Associating an IP configuration with an application security group
$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.
Example 3: Disassociating an IP configuration with an application gateway backend address pool
$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.
Parameters
-ApplicationGatewayBackendAddressPool
Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs.
Parameter properties
Parameter sets
SetByResource
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ApplicationGatewayBackendAddressPoolId
Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ApplicationSecurityGroup
Specifies a collection of application security group references to which this network interface IP configuration belongs.
Parameter properties
Parameter sets
SetByResource
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ApplicationSecurityGroupId
Specifies a collection of application security group references to which this network interface IP configuration belongs.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GatewayLoadBalancerId
Specifies the ID of the Gateway Load Balancer Provider Frontend Ip Configuration.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResource
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-LoadBalancerBackendAddressPool
Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs.
Parameter properties
Parameter sets
SetByResource
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-LoadBalancerBackendAddressPoolId
Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-LoadBalancerInboundNatRule
Specifies a collection of load balancer inbound network address translation (NAT) rule references to which this network interface IP configuration belongs.
Parameter properties
Type: PSInboundNatRule [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResource
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-LoadBalancerInboundNatRuleId
Specifies a collection of load balancer inbound NAT rule references to which this network interface IP configuration belongs.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Name
Specifies the name of the network IP configuration for which this cmdlet sets.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NetworkInterface
Specifies a NetworkInterface object.
This cmdlet adds a network interface IP configuration to the object that this parameter specifies.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Primary
The Set-AzNetworkInterfaceIpConfig cmdlet updates an IP configuration for a network interface.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PrivateIpAddress
Specifies the static IP address of the network interface IP configuration.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PrivateIpAddressVersion
Specifies the IP address version of a network interface IP configuration.
The acceptable values for this parameter are:
Parameter properties
Type: String
Default value: None Accepted values: IPv4, IPv6 Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PublicIpAddress
Specifies a PublicIPAddress object.
This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration.
Parameter properties
Parameter sets
SetByResource
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PublicIpAddressId
This cmdlet creates a reference to a public IP Address to associate with this network interface IP configuration.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Subnet
Specifies a Subnet object.
This cmdlet creates a reference to a subnet in which this network interface IP configuration is created.
Parameter properties
Type: PSSubnet
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResource
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubnetId
This cmdlet creates a reference to a subnet in which this network interface IP configuration is created.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
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 .
Outputs
Notes
Keywords: azure, azurerm, arm, resource, management, manager, network, networking
