Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

New-AzNetworkInterfaceIpConfig

Creates a network interface IP configuration.

Syntax

SetByResource (Default)

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

SetByResourceId

New-AzNetworkInterfaceIpConfig
 -Name <String>
 [-PrivateIPAddressPrefixLength <Int32>]
 [-PrivateIpAddressVersion <String>]
 [-PrivateIpAddress <String>]
 [-Primary]
 [-SubnetId <String>]
 [-PublicIpAddressId <String>]
 [-LoadBalancerBackendAddressPoolId <String[]>]
 [-LoadBalancerInboundNatRuleId <String[]>]
 [-ApplicationGatewayBackendAddressPoolId <String[]>]
 [-ApplicationSecurityGroupId <String[]>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

The New-AzNetworkInterfaceIpConfig cmdlet creates an Azure network interface IP configuration for a network interface.

Examples

Example 1: Create an IP configuration with a public IP address for a network interface

$vnet = Get-AzVirtualNetwork -Name myvnet -ResourceGroupName myrg
$Subnet = Get-AzVirtualNetworkSubnetConfig -Name mysubnet -VirtualNetwork $vnet
$PIP1 = Get-AzPublicIpAddress -Name "PIP1" -ResourceGroupName "RG1"

$IPConfig1 = New-AzNetworkInterfaceIpConfig -Name "IPConfig-1" -Subnet $Subnet -PublicIpAddress $PIP1 -Primary

$nic = New-AzNetworkInterface -Name mynic1 -ResourceGroupName myrg -Location westus -IpConfiguration $IpConfig1

The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were previously created. These are stored in $vnet and $Subnet respectively. The third command gets a previously created public IP address called PIP1. The forth command creates a new IP configuration called "IPConfig-1" as the primary IP configuration with a public IP address associated with it. The last command then creates a network interface called mynic1 using this IP configuration.

Example 2: Create an IP configuration with a private IP address

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

$IPConfig2 = New-AzNetworkInterfaceIpConfig -Name "IP-Config2" -Subnet $Subnet -PrivateIpAddress 10.0.0.5

$nic = New-AzNetworkInterface -Name mynic1 -ResourceGroupName myrg -Location westus -IpConfiguration $IpConfig2

The first two commands get a virtual network called myvnet and a subnet called mysubnet respectively that were previously created. These are stored in $vnet and $Subnet respectively. The third command creates a new IP configuration called "IPConfig-2" with a private IP address 10.0.0.5 associated with it. The last command then creates a network interface called mynic1 using this IP configuration.

Example 3

Creates a network interface IP configuration. (autogenerated)

New-AzNetworkInterfaceIpConfig -Name 'IP-Config2' -PrivateIpAddress '10.0.1.10' -PrivateIpAddressVersion IPv4 -SubnetId <String>

Parameters

-ApplicationGatewayBackendAddressPool

Specifies a collection of application gateway backend address pool references to which this network interface IP configuration belongs.

Parameter properties

Type:

PSApplicationGatewayBackendAddressPool[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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

-ApplicationSecurityGroup

Specifies a collection of application security group references to which this network interface IP configuration belongs.

Parameter properties

Type:

PSApplicationSecurityGroup[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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

-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

-GatewayLoadBalancerId

The reference of Gateway LoadBalancer Provider resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-LoadBalancerBackendAddressPool

Specifies a collection of load balancer backend address pool references to which this network interface IP configuration belongs.

Parameter properties

Type:

PSBackendAddressPool[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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

-LoadBalancerInboundNatRule

Specifies a collection of load balancer inbound Nat Rule references to which this network interface IPConfiguration belongs.

Parameter properties

Type:

PSInboundNatRule[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-LoadBalancerInboundNatRuleId

Specifies a collection of load balancer inbound network address translation (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

-Name

Specifies the name of the network interface IP configuration.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Primary

The New-AzNetworkInterfaceIpConfig cmdlet creates an Azure network interface IP configuration for a network interface.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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

-PrivateIPAddressPrefixLength

Specifies the static IP address prefix length of the network interface IP configuration.

Parameter properties

Type:

Nullable<T>[Int32]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-PrivateIpAddressVersion

Specifies the IP address version of a network interface IP configuration. The acceptable values for this parameter are:

  • IPv4
  • IPv6

Parameter properties

Type:String
Default value:None
Accepted values:IPv4, IPv6
Supports wildcards:False
DontShow:False

Parameter sets

-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

Type:PSPublicIpAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-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

-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

-SubnetId

Specifies 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

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.

Inputs

String

PSBackendAddressPool

PSInboundNatRule

PSApplicationGatewayBackendAddressPool

PSApplicationSecurityGroup

Outputs

PSNetworkInterfaceIPConfiguration

Notes

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

Related Links


Feedback

Was this page helpful?