Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-AzNetworkInterface
- Module:
- Az.Network Module
Creates a network interface.
Syntax
SetByIpConfigurationResource (Default)
New-AzNetworkInterface
-Name <String>
-ResourceGroupName <String>
-Location <String>
-IpConfiguration <PSNetworkInterfaceIPConfiguration[]>
[-EdgeZone <String>]
[-DnsServer <String[]>]
[-InternalDnsNameLabel <String>]
[-DisableTcpStateTracking <String>]
[-EnableIPForwarding]
[-EnableAcceleratedNetworking]
[-AuxiliaryMode <String>]
[-AuxiliarySku <String>]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByIpConfigurationResourceId
New-AzNetworkInterface
-Name <String>
-ResourceGroupName <String>
-Location <String>
-IpConfiguration <PSNetworkInterfaceIPConfiguration[]>
[-EdgeZone <String>]
[-NetworkSecurityGroupId <String>]
[-NetworkSecurityGroup <PSNetworkSecurityGroup>]
[-DnsServer <String[]>]
[-InternalDnsNameLabel <String>]
[-DisableTcpStateTracking <String>]
[-EnableIPForwarding]
[-EnableAcceleratedNetworking]
[-AuxiliaryMode <String>]
[-AuxiliarySku <String>]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByResourceId
New-AzNetworkInterface
-Name <String>
-ResourceGroupName <String>
-Location <String>
-SubnetId <String>
[-EdgeZone <String>]
[-PublicIpAddressId <String>]
[-NetworkSecurityGroupId <String>]
[-LoadBalancerBackendAddressPoolId <String[]>]
[-LoadBalancerInboundNatRuleId <String[]>]
[-ApplicationGatewayBackendAddressPoolId <String[]>]
[-ApplicationSecurityGroupId <String[]>]
[-PrivateIpAddress <String>]
[-IpConfigurationName <String>]
[-DnsServer <String[]>]
[-InternalDnsNameLabel <String>]
[-DisableTcpStateTracking <String>]
[-EnableIPForwarding]
[-EnableAcceleratedNetworking]
[-AuxiliaryMode <String>]
[-AuxiliarySku <String>]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByResource
New-AzNetworkInterface
-Name <String>
-ResourceGroupName <String>
-Location <String>
-Subnet <PSSubnet>
[-EdgeZone <String>]
[-PublicIpAddress <PSPublicIpAddress>]
[-NetworkSecurityGroup <PSNetworkSecurityGroup>]
[-LoadBalancerBackendAddressPool <PSBackendAddressPool[]>]
[-LoadBalancerInboundNatRule <PSInboundNatRule[]>]
[-ApplicationGatewayBackendAddressPool <PSApplicationGatewayBackendAddressPool[]>]
[-ApplicationSecurityGroup <PSApplicationSecurityGroup[]>]
[-PrivateIpAddress <String>]
[-IpConfigurationName <String>]
[-DnsServer <String[]>]
[-InternalDnsNameLabel <String>]
[-DisableTcpStateTracking <String>]
[-EnableIPForwarding]
[-EnableAcceleratedNetworking]
[-AuxiliaryMode <String>]
[-AuxiliarySku <String>]
[-Tag <Hashtable>]
[-Force]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzNetworkInterface cmdlet creates an Azure network interface.
Examples
Example 1: Create an Azure network interface
New-AzNetworkInterface -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
$Subnet = Get-AzVirtualNetwork -Name "VirtualNetwork1" -ResourceGroupName "ResourceGroup1"
$IPconfig = New-AzNetworkInterfaceIpConfig -Name "IPConfig1" -PrivateIpAddressVersion IPv4 -PrivateIpAddress "10.0.1.10" -SubnetId $Subnet.Subnets[0].Id
New-AzNetworkInterface -Name "NetworkInterface1" -ResourceGroupName "ResourceGroup1" -Location "centralus" -IpConfiguration $IPconfig
This example creates a new network interface using an IP configuration object. The IP configuration object specifies a static private IPv4 address. The first command retrieves an existing specified virtual network used to assign the subnet in the second command. The second command creates a network interface IP configuration named IPConfig1 and stores the configuration in the variable named $IPconfig. The third command creates a network interface named NetworkInterface1 that uses the network interface IP configuration stored in the variable named $IPconfig.
Example 3
Creates a network interface. (autogenerated)
New-AzNetworkInterface -Location 'West US' -Name 'NetworkInterface1' -PrivateIpAddress '10.0.1.10' -ResourceGroupName 'ResourceGroup1' -SubnetId '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup1/providers/Microsoft.Network/virtualNetworks/VirtualNetwork1/subnets/Subnet1'
Parameters
-ApplicationGatewayBackendAddressPool
Specifies an ApplicationGatewayBackendAddressPool object.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApplicationGatewayBackendAddressPoolId
Specifies the ID of a ApplicationGatewayBackendAddressPool object.
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 the network interface IP configuration should belong to.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApplicationSecurityGroupId
Specifies a collection of application security group references to which the network interface IP configuration should belong to.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AsJob
Run cmdlet in the background
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AuxiliaryMode
The auxiliary mode of the Network Interface
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | None, MaxConnections, AcceleratedConnections, Floating |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AuxiliarySku
The auxiliary sku of the Network Interface
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | None, A1, A2, A4, A8 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
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
-DisableTcpStateTracking
Indicates whether to disable tcp state tracking.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DnsServer
Specifies the DNS server for the network interface.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EdgeZone
The edge zone of the network interface
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableAcceleratedNetworking
Enables accelerated networking.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Force
Forces the creation of the network interface even if a network interface with the same name already exists.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InternalDnsNameLabel
Specifies the internal DNS name label for the new network interface.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IpConfiguration
Specifies the IP configuration that this cmdlet uses for the network interface.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IpConfigurationName
Specifies the name of an IP configuration.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerBackendAddressPool
Specifies a BackendAddressPool object.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerBackendAddressPoolId
Specifies the ID of a BackendAddressPool object.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerInboundNatRule
Specifies an inbound NAT rule configuration for a load balancer.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerInboundNatRuleId
Specifies the ID of an inbound NAT rule configuration for a load balancer.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Location
Specifies the region for a network interface.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Specifies the name of the network interface to create.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ResourceName |
Parameter sets
-NetworkSecurityGroup
Specifies a NetworkSecurityGroup object.
Parameter properties
| Type: | PSNetworkSecurityGroup |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NetworkSecurityGroupId
Specifies the ID of a network security group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PrivateIpAddress
Specifies a static IPv4 IP address to assign to this network interface.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublicIpAddress
Specifies a PublicIPAddress object to assign to a network interface.
Parameter properties
| Type: | PSPublicIpAddress |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublicIpAddressId
Specifies the ID of a PublicIPAddress object to assign to a network interface.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Specifies the name of a resource group that the network interface belongs to.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Subnet
Specifies a Subnet object. This cmdlet creates a network interface for the subnet that this parameter specifies.
Parameter properties
| Type: | PSSubnet |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubnetId
Specifies the ID of the subnet for which to create a network interface.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tag
Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
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
PSNetworkInterfaceIPConfiguration
PSSubnet
PSPublicIpAddress
PSNetworkSecurityGroup
String
PSBackendAddressPool
PSInboundNatRule
PSApplicationGatewayBackendAddressPool
PSApplicationSecurityGroup
Hashtable
Outputs
PSNetworkInterface
Related Links
Azure PowerShell
Feedback
Was this page helpful?
