New-AzureRmNetworkInterface
Creates a network interface.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
New-AzureRmNetworkInterface
-Name <String>
-ResourceGroupName <String>
-Location <String>
-IpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration]>
[-DnsServer <System.Collections.Generic.List`1[System.String]>]
[-InternalDnsNameLabel <String>]
[-EnableIPForwarding]
[-EnableAcceleratedNetworking]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmNetworkInterface
-Name <String>
-ResourceGroupName <String>
-Location <String>
-IpConfiguration <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration]>
[-NetworkSecurityGroupId <String>]
[-NetworkSecurityGroup <PSNetworkSecurityGroup>]
[-DnsServer <System.Collections.Generic.List`1[System.String]>]
[-InternalDnsNameLabel <String>]
[-EnableIPForwarding]
[-EnableAcceleratedNetworking]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmNetworkInterface
-Name <String>
-ResourceGroupName <String>
-Location <String>
-SubnetId <String>
[-PublicIpAddressId <String>]
[-NetworkSecurityGroupId <String>]
[-LoadBalancerBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>]
[-LoadBalancerInboundNatRuleId <System.Collections.Generic.List`1[System.String]>]
[-ApplicationGatewayBackendAddressPoolId <System.Collections.Generic.List`1[System.String]>]
[-ApplicationSecurityGroupId <System.Collections.Generic.List`1[System.String]>]
[-PrivateIpAddress <String>]
[-IpConfigurationName <String>]
[-DnsServer <System.Collections.Generic.List`1[System.String]>]
[-InternalDnsNameLabel <String>]
[-EnableIPForwarding]
[-EnableAcceleratedNetworking]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmNetworkInterface
-Name <String>
-ResourceGroupName <String>
-Location <String>
-Subnet <PSSubnet>
[-PublicIpAddress <PSPublicIpAddress>]
[-NetworkSecurityGroup <PSNetworkSecurityGroup>]
[-LoadBalancerBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool]>]
[-LoadBalancerInboundNatRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule]>]
[-ApplicationGatewayBackendAddressPool <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool]>]
[-ApplicationSecurityGroup <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup]>]
[-PrivateIpAddress <String>]
[-IpConfigurationName <String>]
[-DnsServer <System.Collections.Generic.List`1[System.String]>]
[-InternalDnsNameLabel <String>]
[-EnableIPForwarding]
[-EnableAcceleratedNetworking]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-AzureRmNetworkInterface cmdlet creates an Azure network interface.
Examples
Example 1: Create an Azure network interface
PS C:\>New-AzureRmNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1" -IpConfigurationName "IPConfiguration1" -DnsServer "8.8.8.8", "8.8.4.4"This command creates a network interface named NetworkInterface001 with a dynamically assigned private IP address from Subnet1 in the virtual network named VirtualNetwork1. The command also assigns two DNS servers to the network interface. The IPConfiguration child resource will be created automatically using the name IPConfiguration1.
Example 2: Create an Azure network interface using an IP configuration object
PS C:\>$IPconfig = New-AzureRmNetworkInterfaceIpConfig -Name "IPConfig1" -PrivateIpAddressVersion IPv4 -PrivateIpAddress "10.0.1.10" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1"
PS C:\> New-AzureRmNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -IpConfiguration $IPconfigThis example creates a new network interface using an IP configuration object. The IP configuration object specifies a static private IPv4 address. The first command creates a network interface IP configuration named IPConfig1 and stores the configuration in the variable named $IPconfig. The second command creates a network interface named NetworkInterface1 that uses the network interface IP configuration stored in the variable named $IPconfig.
Parameters
-ApplicationGatewayBackendAddressPool
Specifies an ApplicationGatewayBackendAddressPool object.
| Type: | List<T>[PSApplicationGatewayBackendAddressPool] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApplicationGatewayBackendAddressPoolId
Specifies the ID of a ApplicationGatewayBackendAddressPool object.
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApplicationSecurityGroup
Specifies a collection of application security group references to which the network interface IP configuration should belong to.
| Type: | List<T>[PSApplicationSecurityGroup] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApplicationSecurityGroupId
Specifies a collection of application security group references to which the network interface IP configuration should belong to.
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DnsServer
Specifies the DNS server for the network interface.
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EnableAcceleratedNetworking
Enables accelerated networking.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableIPForwarding
Indicates that this cmdlet enables IP forwarding for the network interface. IP forwarding allows a virtual machine to receive traffic addressed to other destinations.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Forces the creation of the network interface even if a network interface with the same name already exists.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InternalDnsNameLabel
Specifies the internal DNS name label for the new network interface.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IpConfiguration
Specifies the IP configuration that this cmdlet uses for the network interface.
| Type: | List<T>[PSNetworkInterfaceIPConfiguration] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IpConfigurationName
Specifies the name of an IP configuration.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LoadBalancerBackendAddressPool
Specifies a BackendAddressPool object.
| Type: | List<T>[PSBackendAddressPool] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LoadBalancerBackendAddressPoolId
Specifies the ID of a BackendAddressPool object.
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LoadBalancerInboundNatRule
Specifies an inbound NAT rule configuration for a load balancer.
| Type: | List<T>[PSInboundNatRule] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LoadBalancerInboundNatRuleId
Specifies the ID of an inbound NAT rule configuration for a load balancer.
| Type: | List<T>[String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Location
Specifies the region for a network interface.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the network interface to create.
| Type: | String |
| Aliases: | ResourceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NetworkSecurityGroup
Specifies a NetworkSecurityGroup object.
| Type: | PSNetworkSecurityGroup |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NetworkSecurityGroupId
Specifies the ID of a network security group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PrivateIpAddress
Specifies a static IPv4 IP address to assign to this network interface.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PublicIpAddress
Specifies a PublicIPAddress object to assign to a network interface.
| Type: | PSPublicIpAddress |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PublicIpAddressId
Specifies the ID of a PublicIPAddress object to assign to a network interface.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of a resource group that the network interface belongs to.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Subnet
Specifies a Subnet object. This cmdlet creates a network interface for the subnet that this parameter specifies.
| Type: | PSSubnet |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubnetId
Specifies the ID of the subnet for which to create a network interface.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Tag
Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
List<T>[[Microsoft.Azure.Commands.Network.Models.PSNetworkInterfaceIPConfiguration, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]
List<T>[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
List<T>[[Microsoft.Azure.Commands.Network.Models.PSBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]
List<T>[[Microsoft.Azure.Commands.Network.Models.PSInboundNatRule, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]
List<T>[[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayBackendAddressPool, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]
List<T>[[Microsoft.Azure.Commands.Network.Models.PSApplicationSecurityGroup, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]