Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. NetworkInterface

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.network.NetworkInterface

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Network Interface.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-network",
    addressSpaces: ["10.0.0.0/16"],
    location: example.location,
    resourceGroupName: example.name,
});
const exampleSubnet = new azure.network.Subnet("example", {
    name: "internal",
    resourceGroupName: example.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["10.0.2.0/24"],
});
const exampleNetworkInterface = new azure.network.NetworkInterface("example", {
    name: "example-nic",
    location: example.location,
    resourceGroupName: example.name,
    ipConfigurations: [{
        name: "internal",
        subnetId: exampleSubnet.id,
        privateIpAddressAllocation: "Dynamic",
    }],
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-network",
    address_spaces=["10.0.0.0/16"],
    location=example.location,
    resource_group_name=example.name)
example_subnet = azure.network.Subnet("example",
    name="internal",
    resource_group_name=example.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["10.0.2.0/24"])
example_network_interface = azure.network.NetworkInterface("example",
    name="example-nic",
    location=example.location,
    resource_group_name=example.name,
    ip_configurations=[{
        "name": "internal",
        "subnet_id": example_subnet.id,
        "private_ip_address_allocation": "Dynamic",
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name: pulumi.String("example-network"),
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
			Name:               pulumi.String("internal"),
			ResourceGroupName:  example.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("10.0.2.0/24"),
			},
		})
		if err != nil {
			return err
		}
		_, err = network.NewNetworkInterface(ctx, "example", &network.NetworkInterfaceArgs{
			Name:              pulumi.String("example-nic"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			IpConfigurations: network.NetworkInterfaceIpConfigurationArray{
				&network.NetworkInterfaceIpConfigurationArgs{
					Name:                       pulumi.String("internal"),
					SubnetId:                   exampleSubnet.ID(),
					PrivateIpAddressAllocation: pulumi.String("Dynamic"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-network",
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
        Location = example.Location,
        ResourceGroupName = example.Name,
    });

    var exampleSubnet = new Azure.Network.Subnet("example", new()
    {
        Name = "internal",
        ResourceGroupName = example.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "10.0.2.0/24",
        },
    });

    var exampleNetworkInterface = new Azure.Network.NetworkInterface("example", new()
    {
        Name = "example-nic",
        Location = example.Location,
        ResourceGroupName = example.Name,
        IpConfigurations = new[]
        {
            new Azure.Network.Inputs.NetworkInterfaceIpConfigurationArgs
            {
                Name = "internal",
                SubnetId = exampleSubnet.Id,
                PrivateIpAddressAllocation = "Dynamic",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.NetworkInterface;
import com.pulumi.azure.network.NetworkInterfaceArgs;
import com.pulumi.azure.network.inputs.NetworkInterfaceIpConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("example-network")
            .addressSpaces("10.0.0.0/16")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("internal")
            .resourceGroupName(example.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("10.0.2.0/24")
            .build());

        var exampleNetworkInterface = new NetworkInterface("exampleNetworkInterface", NetworkInterfaceArgs.builder()
            .name("example-nic")
            .location(example.location())
            .resourceGroupName(example.name())
            .ipConfigurations(NetworkInterfaceIpConfigurationArgs.builder()
                .name("internal")
                .subnetId(exampleSubnet.id())
                .privateIpAddressAllocation("Dynamic")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-network
      addressSpaces:
        - 10.0.0.0/16
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: internal
      resourceGroupName: ${example.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.2.0/24
  exampleNetworkInterface:
    type: azure:network:NetworkInterface
    name: example
    properties:
      name: example-nic
      location: ${example.location}
      resourceGroupName: ${example.name}
      ipConfigurations:
        - name: internal
          subnetId: ${exampleSubnet.id}
          privateIpAddressAllocation: Dynamic
Copy

Create NetworkInterface Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NetworkInterface(name: string, args: NetworkInterfaceArgs, opts?: CustomResourceOptions);
@overload
def NetworkInterface(resource_name: str,
                     args: NetworkInterfaceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def NetworkInterface(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     ip_configurations: Optional[Sequence[NetworkInterfaceIpConfigurationArgs]] = None,
                     resource_group_name: Optional[str] = None,
                     accelerated_networking_enabled: Optional[bool] = None,
                     auxiliary_mode: Optional[str] = None,
                     auxiliary_sku: Optional[str] = None,
                     dns_servers: Optional[Sequence[str]] = None,
                     edge_zone: Optional[str] = None,
                     internal_dns_name_label: Optional[str] = None,
                     ip_forwarding_enabled: Optional[bool] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
func NewNetworkInterface(ctx *Context, name string, args NetworkInterfaceArgs, opts ...ResourceOption) (*NetworkInterface, error)
public NetworkInterface(string name, NetworkInterfaceArgs args, CustomResourceOptions? opts = null)
public NetworkInterface(String name, NetworkInterfaceArgs args)
public NetworkInterface(String name, NetworkInterfaceArgs args, CustomResourceOptions options)

type: azure:network:NetworkInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NetworkInterfaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var networkInterfaceResource = new Azure.Network.NetworkInterface("networkInterfaceResource", new()
{
    IpConfigurations = new[]
    {
        new Azure.Network.Inputs.NetworkInterfaceIpConfigurationArgs
        {
            Name = "string",
            PrivateIpAddressAllocation = "string",
            GatewayLoadBalancerFrontendIpConfigurationId = "string",
            Primary = false,
            PrivateIpAddress = "string",
            PrivateIpAddressVersion = "string",
            PublicIpAddressId = "string",
            SubnetId = "string",
        },
    },
    ResourceGroupName = "string",
    AcceleratedNetworkingEnabled = false,
    AuxiliaryMode = "string",
    AuxiliarySku = "string",
    DnsServers = new[]
    {
        "string",
    },
    EdgeZone = "string",
    InternalDnsNameLabel = "string",
    IpForwardingEnabled = false,
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := network.NewNetworkInterface(ctx, "networkInterfaceResource", &network.NetworkInterfaceArgs{
	IpConfigurations: network.NetworkInterfaceIpConfigurationArray{
		&network.NetworkInterfaceIpConfigurationArgs{
			Name:                       pulumi.String("string"),
			PrivateIpAddressAllocation: pulumi.String("string"),
			GatewayLoadBalancerFrontendIpConfigurationId: pulumi.String("string"),
			Primary:                 pulumi.Bool(false),
			PrivateIpAddress:        pulumi.String("string"),
			PrivateIpAddressVersion: pulumi.String("string"),
			PublicIpAddressId:       pulumi.String("string"),
			SubnetId:                pulumi.String("string"),
		},
	},
	ResourceGroupName:            pulumi.String("string"),
	AcceleratedNetworkingEnabled: pulumi.Bool(false),
	AuxiliaryMode:                pulumi.String("string"),
	AuxiliarySku:                 pulumi.String("string"),
	DnsServers: pulumi.StringArray{
		pulumi.String("string"),
	},
	EdgeZone:             pulumi.String("string"),
	InternalDnsNameLabel: pulumi.String("string"),
	IpForwardingEnabled:  pulumi.Bool(false),
	Location:             pulumi.String("string"),
	Name:                 pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var networkInterfaceResource = new NetworkInterface("networkInterfaceResource", NetworkInterfaceArgs.builder()
    .ipConfigurations(NetworkInterfaceIpConfigurationArgs.builder()
        .name("string")
        .privateIpAddressAllocation("string")
        .gatewayLoadBalancerFrontendIpConfigurationId("string")
        .primary(false)
        .privateIpAddress("string")
        .privateIpAddressVersion("string")
        .publicIpAddressId("string")
        .subnetId("string")
        .build())
    .resourceGroupName("string")
    .acceleratedNetworkingEnabled(false)
    .auxiliaryMode("string")
    .auxiliarySku("string")
    .dnsServers("string")
    .edgeZone("string")
    .internalDnsNameLabel("string")
    .ipForwardingEnabled(false)
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
network_interface_resource = azure.network.NetworkInterface("networkInterfaceResource",
    ip_configurations=[{
        "name": "string",
        "private_ip_address_allocation": "string",
        "gateway_load_balancer_frontend_ip_configuration_id": "string",
        "primary": False,
        "private_ip_address": "string",
        "private_ip_address_version": "string",
        "public_ip_address_id": "string",
        "subnet_id": "string",
    }],
    resource_group_name="string",
    accelerated_networking_enabled=False,
    auxiliary_mode="string",
    auxiliary_sku="string",
    dns_servers=["string"],
    edge_zone="string",
    internal_dns_name_label="string",
    ip_forwarding_enabled=False,
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const networkInterfaceResource = new azure.network.NetworkInterface("networkInterfaceResource", {
    ipConfigurations: [{
        name: "string",
        privateIpAddressAllocation: "string",
        gatewayLoadBalancerFrontendIpConfigurationId: "string",
        primary: false,
        privateIpAddress: "string",
        privateIpAddressVersion: "string",
        publicIpAddressId: "string",
        subnetId: "string",
    }],
    resourceGroupName: "string",
    acceleratedNetworkingEnabled: false,
    auxiliaryMode: "string",
    auxiliarySku: "string",
    dnsServers: ["string"],
    edgeZone: "string",
    internalDnsNameLabel: "string",
    ipForwardingEnabled: false,
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:network:NetworkInterface
properties:
    acceleratedNetworkingEnabled: false
    auxiliaryMode: string
    auxiliarySku: string
    dnsServers:
        - string
    edgeZone: string
    internalDnsNameLabel: string
    ipConfigurations:
        - gatewayLoadBalancerFrontendIpConfigurationId: string
          name: string
          primary: false
          privateIpAddress: string
          privateIpAddressAllocation: string
          privateIpAddressVersion: string
          publicIpAddressId: string
          subnetId: string
    ipForwardingEnabled: false
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
Copy

NetworkInterface Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NetworkInterface resource accepts the following input properties:

IpConfigurations This property is required. List<NetworkInterfaceIpConfiguration>
One or more ip_configuration blocks as defined below.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
AcceleratedNetworkingEnabled bool

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

AuxiliaryMode string

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

AuxiliarySku string

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

DnsServers List<string>

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

EdgeZone Changes to this property will trigger replacement. string
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
InternalDnsNameLabel string
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
IpForwardingEnabled bool
Should IP Forwarding be enabled? Defaults to false.
Location Changes to this property will trigger replacement. string
The location where the Network Interface should exist. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Network Interface. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
IpConfigurations This property is required. []NetworkInterfaceIpConfigurationArgs
One or more ip_configuration blocks as defined below.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
AcceleratedNetworkingEnabled bool

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

AuxiliaryMode string

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

AuxiliarySku string

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

DnsServers []string

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

EdgeZone Changes to this property will trigger replacement. string
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
InternalDnsNameLabel string
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
IpForwardingEnabled bool
Should IP Forwarding be enabled? Defaults to false.
Location Changes to this property will trigger replacement. string
The location where the Network Interface should exist. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Network Interface. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
ipConfigurations This property is required. List<NetworkInterfaceIpConfiguration>
One or more ip_configuration blocks as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
acceleratedNetworkingEnabled Boolean

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

auxiliaryMode String

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

auxiliarySku String

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

dnsServers List<String>

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

edgeZone Changes to this property will trigger replacement. String
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
internalDnsNameLabel String
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
ipForwardingEnabled Boolean
Should IP Forwarding be enabled? Defaults to false.
location Changes to this property will trigger replacement. String
The location where the Network Interface should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Network Interface. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
ipConfigurations This property is required. NetworkInterfaceIpConfiguration[]
One or more ip_configuration blocks as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
acceleratedNetworkingEnabled boolean

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

auxiliaryMode string

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

auxiliarySku string

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

dnsServers string[]

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

edgeZone Changes to this property will trigger replacement. string
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
internalDnsNameLabel string
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
ipForwardingEnabled boolean
Should IP Forwarding be enabled? Defaults to false.
location Changes to this property will trigger replacement. string
The location where the Network Interface should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the Network Interface. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
ip_configurations This property is required. Sequence[NetworkInterfaceIpConfigurationArgs]
One or more ip_configuration blocks as defined below.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
accelerated_networking_enabled bool

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

auxiliary_mode str

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

auxiliary_sku str

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

dns_servers Sequence[str]

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

edge_zone Changes to this property will trigger replacement. str
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
internal_dns_name_label str
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
ip_forwarding_enabled bool
Should IP Forwarding be enabled? Defaults to false.
location Changes to this property will trigger replacement. str
The location where the Network Interface should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the Network Interface. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
ipConfigurations This property is required. List<Property Map>
One or more ip_configuration blocks as defined below.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
acceleratedNetworkingEnabled Boolean

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

auxiliaryMode String

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

auxiliarySku String

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

dnsServers List<String>

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

edgeZone Changes to this property will trigger replacement. String
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
internalDnsNameLabel String
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
ipForwardingEnabled Boolean
Should IP Forwarding be enabled? Defaults to false.
location Changes to this property will trigger replacement. String
The location where the Network Interface should exist. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Network Interface. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkInterface resource produces the following output properties:

AppliedDnsServers List<string>
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
Id string
The provider-assigned unique ID for this managed resource.
InternalDomainNameSuffix string
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
MacAddress string
The Media Access Control (MAC) Address of the Network Interface.
PrivateIpAddress string
The first private IP address of the network interface.
PrivateIpAddresses List<string>
The private IP addresses of the network interface.
VirtualMachineId string
The ID of the Virtual Machine which this Network Interface is connected to.
AppliedDnsServers []string
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
Id string
The provider-assigned unique ID for this managed resource.
InternalDomainNameSuffix string
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
MacAddress string
The Media Access Control (MAC) Address of the Network Interface.
PrivateIpAddress string
The first private IP address of the network interface.
PrivateIpAddresses []string
The private IP addresses of the network interface.
VirtualMachineId string
The ID of the Virtual Machine which this Network Interface is connected to.
appliedDnsServers List<String>
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
id String
The provider-assigned unique ID for this managed resource.
internalDomainNameSuffix String
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
macAddress String
The Media Access Control (MAC) Address of the Network Interface.
privateIpAddress String
The first private IP address of the network interface.
privateIpAddresses List<String>
The private IP addresses of the network interface.
virtualMachineId String
The ID of the Virtual Machine which this Network Interface is connected to.
appliedDnsServers string[]
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
id string
The provider-assigned unique ID for this managed resource.
internalDomainNameSuffix string
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
macAddress string
The Media Access Control (MAC) Address of the Network Interface.
privateIpAddress string
The first private IP address of the network interface.
privateIpAddresses string[]
The private IP addresses of the network interface.
virtualMachineId string
The ID of the Virtual Machine which this Network Interface is connected to.
applied_dns_servers Sequence[str]
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
id str
The provider-assigned unique ID for this managed resource.
internal_domain_name_suffix str
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
mac_address str
The Media Access Control (MAC) Address of the Network Interface.
private_ip_address str
The first private IP address of the network interface.
private_ip_addresses Sequence[str]
The private IP addresses of the network interface.
virtual_machine_id str
The ID of the Virtual Machine which this Network Interface is connected to.
appliedDnsServers List<String>
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
id String
The provider-assigned unique ID for this managed resource.
internalDomainNameSuffix String
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
macAddress String
The Media Access Control (MAC) Address of the Network Interface.
privateIpAddress String
The first private IP address of the network interface.
privateIpAddresses List<String>
The private IP addresses of the network interface.
virtualMachineId String
The ID of the Virtual Machine which this Network Interface is connected to.

Look up Existing NetworkInterface Resource

Get an existing NetworkInterface resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NetworkInterfaceState, opts?: CustomResourceOptions): NetworkInterface
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accelerated_networking_enabled: Optional[bool] = None,
        applied_dns_servers: Optional[Sequence[str]] = None,
        auxiliary_mode: Optional[str] = None,
        auxiliary_sku: Optional[str] = None,
        dns_servers: Optional[Sequence[str]] = None,
        edge_zone: Optional[str] = None,
        internal_dns_name_label: Optional[str] = None,
        internal_domain_name_suffix: Optional[str] = None,
        ip_configurations: Optional[Sequence[NetworkInterfaceIpConfigurationArgs]] = None,
        ip_forwarding_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        mac_address: Optional[str] = None,
        name: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        private_ip_addresses: Optional[Sequence[str]] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_machine_id: Optional[str] = None) -> NetworkInterface
func GetNetworkInterface(ctx *Context, name string, id IDInput, state *NetworkInterfaceState, opts ...ResourceOption) (*NetworkInterface, error)
public static NetworkInterface Get(string name, Input<string> id, NetworkInterfaceState? state, CustomResourceOptions? opts = null)
public static NetworkInterface get(String name, Output<String> id, NetworkInterfaceState state, CustomResourceOptions options)
resources:  _:    type: azure:network:NetworkInterface    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AcceleratedNetworkingEnabled bool

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

AppliedDnsServers List<string>
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
AuxiliaryMode string

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

AuxiliarySku string

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

DnsServers List<string>

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

EdgeZone Changes to this property will trigger replacement. string
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
InternalDnsNameLabel string
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
InternalDomainNameSuffix string
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
IpConfigurations List<NetworkInterfaceIpConfiguration>
One or more ip_configuration blocks as defined below.
IpForwardingEnabled bool
Should IP Forwarding be enabled? Defaults to false.
Location Changes to this property will trigger replacement. string
The location where the Network Interface should exist. Changing this forces a new resource to be created.
MacAddress string
The Media Access Control (MAC) Address of the Network Interface.
Name Changes to this property will trigger replacement. string
The name of the Network Interface. Changing this forces a new resource to be created.
PrivateIpAddress string
The first private IP address of the network interface.
PrivateIpAddresses List<string>
The private IP addresses of the network interface.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
VirtualMachineId string
The ID of the Virtual Machine which this Network Interface is connected to.
AcceleratedNetworkingEnabled bool

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

AppliedDnsServers []string
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
AuxiliaryMode string

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

AuxiliarySku string

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

DnsServers []string

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

EdgeZone Changes to this property will trigger replacement. string
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
InternalDnsNameLabel string
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
InternalDomainNameSuffix string
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
IpConfigurations []NetworkInterfaceIpConfigurationArgs
One or more ip_configuration blocks as defined below.
IpForwardingEnabled bool
Should IP Forwarding be enabled? Defaults to false.
Location Changes to this property will trigger replacement. string
The location where the Network Interface should exist. Changing this forces a new resource to be created.
MacAddress string
The Media Access Control (MAC) Address of the Network Interface.
Name Changes to this property will trigger replacement. string
The name of the Network Interface. Changing this forces a new resource to be created.
PrivateIpAddress string
The first private IP address of the network interface.
PrivateIpAddresses []string
The private IP addresses of the network interface.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
VirtualMachineId string
The ID of the Virtual Machine which this Network Interface is connected to.
acceleratedNetworkingEnabled Boolean

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

appliedDnsServers List<String>
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
auxiliaryMode String

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

auxiliarySku String

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

dnsServers List<String>

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

edgeZone Changes to this property will trigger replacement. String
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
internalDnsNameLabel String
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
internalDomainNameSuffix String
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
ipConfigurations List<NetworkInterfaceIpConfiguration>
One or more ip_configuration blocks as defined below.
ipForwardingEnabled Boolean
Should IP Forwarding be enabled? Defaults to false.
location Changes to this property will trigger replacement. String
The location where the Network Interface should exist. Changing this forces a new resource to be created.
macAddress String
The Media Access Control (MAC) Address of the Network Interface.
name Changes to this property will trigger replacement. String
The name of the Network Interface. Changing this forces a new resource to be created.
privateIpAddress String
The first private IP address of the network interface.
privateIpAddresses List<String>
The private IP addresses of the network interface.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
virtualMachineId String
The ID of the Virtual Machine which this Network Interface is connected to.
acceleratedNetworkingEnabled boolean

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

appliedDnsServers string[]
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
auxiliaryMode string

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

auxiliarySku string

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

dnsServers string[]

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

edgeZone Changes to this property will trigger replacement. string
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
internalDnsNameLabel string
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
internalDomainNameSuffix string
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
ipConfigurations NetworkInterfaceIpConfiguration[]
One or more ip_configuration blocks as defined below.
ipForwardingEnabled boolean
Should IP Forwarding be enabled? Defaults to false.
location Changes to this property will trigger replacement. string
The location where the Network Interface should exist. Changing this forces a new resource to be created.
macAddress string
The Media Access Control (MAC) Address of the Network Interface.
name Changes to this property will trigger replacement. string
The name of the Network Interface. Changing this forces a new resource to be created.
privateIpAddress string
The first private IP address of the network interface.
privateIpAddresses string[]
The private IP addresses of the network interface.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
virtualMachineId string
The ID of the Virtual Machine which this Network Interface is connected to.
accelerated_networking_enabled bool

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

applied_dns_servers Sequence[str]
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
auxiliary_mode str

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

auxiliary_sku str

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

dns_servers Sequence[str]

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

edge_zone Changes to this property will trigger replacement. str
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
internal_dns_name_label str
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
internal_domain_name_suffix str
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
ip_configurations Sequence[NetworkInterfaceIpConfigurationArgs]
One or more ip_configuration blocks as defined below.
ip_forwarding_enabled bool
Should IP Forwarding be enabled? Defaults to false.
location Changes to this property will trigger replacement. str
The location where the Network Interface should exist. Changing this forces a new resource to be created.
mac_address str
The Media Access Control (MAC) Address of the Network Interface.
name Changes to this property will trigger replacement. str
The name of the Network Interface. Changing this forces a new resource to be created.
private_ip_address str
The first private IP address of the network interface.
private_ip_addresses Sequence[str]
The private IP addresses of the network interface.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
virtual_machine_id str
The ID of the Virtual Machine which this Network Interface is connected to.
acceleratedNetworkingEnabled Boolean

Should Accelerated Networking be enabled? Defaults to false.

Note: Only certain Virtual Machine sizes are supported for Accelerated Networking - more information can be found in this document.

Note: To use Accelerated Networking in an Availability Set, the Availability Set must be deployed onto an Accelerated Networking enabled cluster.

appliedDnsServers List<String>
If the Virtual Machine using this Network Interface is part of an Availability Set, then this list will have the union of all DNS servers from all Network Interfaces that are part of the Availability Set.
auxiliaryMode String

Specifies the auxiliary mode used to enable network high-performance feature on Network Virtual Appliances (NVAs). This feature offers competitive performance in Connections Per Second (CPS) optimization, along with improvements to handling large amounts of simultaneous connections. Possible values are AcceleratedConnections, Floating, MaxConnections and None.

Note: auxiliary_mode is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

auxiliarySku String

Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are A8, A4, A1, A2 and None.

Note: auxiliary_sku is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.

dnsServers List<String>

A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.

Note: Configuring DNS Servers on the Network Interface will override the DNS Servers defined on the Virtual Network.

edgeZone Changes to this property will trigger replacement. String
Specifies the Edge Zone within the Azure Region where this Network Interface should exist. Changing this forces a new Network Interface to be created.
internalDnsNameLabel String
The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
internalDomainNameSuffix String
Even if internal_dns_name_label is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internal_domain_name_suffix.
ipConfigurations List<Property Map>
One or more ip_configuration blocks as defined below.
ipForwardingEnabled Boolean
Should IP Forwarding be enabled? Defaults to false.
location Changes to this property will trigger replacement. String
The location where the Network Interface should exist. Changing this forces a new resource to be created.
macAddress String
The Media Access Control (MAC) Address of the Network Interface.
name Changes to this property will trigger replacement. String
The name of the Network Interface. Changing this forces a new resource to be created.
privateIpAddress String
The first private IP address of the network interface.
privateIpAddresses List<String>
The private IP addresses of the network interface.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.
virtualMachineId String
The ID of the Virtual Machine which this Network Interface is connected to.

Supporting Types

NetworkInterfaceIpConfiguration
, NetworkInterfaceIpConfigurationArgs

Name This property is required. string
A name used for this IP Configuration.
PrivateIpAddressAllocation This property is required. string

The allocation method used for the Private IP Address. Possible values are Dynamic and Static.

Note: Dynamic means "An IP is automatically assigned during creation of this Network Interface"; Static means "User supplied IP address will be used"

GatewayLoadBalancerFrontendIpConfigurationId string
The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
Primary bool
Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
PrivateIpAddress string
The first private IP address of the network interface.
PrivateIpAddressVersion string
The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
PublicIpAddressId string
Reference to a Public IP Address to associate with this NIC
SubnetId string

The ID of the Subnet where this Network Interface should be located in.

Note: This is required when private_ip_address_version is set to IPv4.

Name This property is required. string
A name used for this IP Configuration.
PrivateIpAddressAllocation This property is required. string

The allocation method used for the Private IP Address. Possible values are Dynamic and Static.

Note: Dynamic means "An IP is automatically assigned during creation of this Network Interface"; Static means "User supplied IP address will be used"

GatewayLoadBalancerFrontendIpConfigurationId string
The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
Primary bool
Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
PrivateIpAddress string
The first private IP address of the network interface.
PrivateIpAddressVersion string
The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
PublicIpAddressId string
Reference to a Public IP Address to associate with this NIC
SubnetId string

The ID of the Subnet where this Network Interface should be located in.

Note: This is required when private_ip_address_version is set to IPv4.

name This property is required. String
A name used for this IP Configuration.
privateIpAddressAllocation This property is required. String

The allocation method used for the Private IP Address. Possible values are Dynamic and Static.

Note: Dynamic means "An IP is automatically assigned during creation of this Network Interface"; Static means "User supplied IP address will be used"

gatewayLoadBalancerFrontendIpConfigurationId String
The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
primary Boolean
Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
privateIpAddress String
The first private IP address of the network interface.
privateIpAddressVersion String
The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
publicIpAddressId String
Reference to a Public IP Address to associate with this NIC
subnetId String

The ID of the Subnet where this Network Interface should be located in.

Note: This is required when private_ip_address_version is set to IPv4.

name This property is required. string
A name used for this IP Configuration.
privateIpAddressAllocation This property is required. string

The allocation method used for the Private IP Address. Possible values are Dynamic and Static.

Note: Dynamic means "An IP is automatically assigned during creation of this Network Interface"; Static means "User supplied IP address will be used"

gatewayLoadBalancerFrontendIpConfigurationId string
The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
primary boolean
Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
privateIpAddress string
The first private IP address of the network interface.
privateIpAddressVersion string
The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
publicIpAddressId string
Reference to a Public IP Address to associate with this NIC
subnetId string

The ID of the Subnet where this Network Interface should be located in.

Note: This is required when private_ip_address_version is set to IPv4.

name This property is required. str
A name used for this IP Configuration.
private_ip_address_allocation This property is required. str

The allocation method used for the Private IP Address. Possible values are Dynamic and Static.

Note: Dynamic means "An IP is automatically assigned during creation of this Network Interface"; Static means "User supplied IP address will be used"

gateway_load_balancer_frontend_ip_configuration_id str
The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
primary bool
Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
private_ip_address str
The first private IP address of the network interface.
private_ip_address_version str
The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
public_ip_address_id str
Reference to a Public IP Address to associate with this NIC
subnet_id str

The ID of the Subnet where this Network Interface should be located in.

Note: This is required when private_ip_address_version is set to IPv4.

name This property is required. String
A name used for this IP Configuration.
privateIpAddressAllocation This property is required. String

The allocation method used for the Private IP Address. Possible values are Dynamic and Static.

Note: Dynamic means "An IP is automatically assigned during creation of this Network Interface"; Static means "User supplied IP address will be used"

gatewayLoadBalancerFrontendIpConfigurationId String
The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
primary Boolean
Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
privateIpAddress String
The first private IP address of the network interface.
privateIpAddressVersion String
The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
publicIpAddressId String
Reference to a Public IP Address to associate with this NIC
subnetId String

The ID of the Subnet where this Network Interface should be located in.

Note: This is required when private_ip_address_version is set to IPv4.

Import

Network Interfaces can be imported using the resource id, e.g.

$ pulumi import azure:network/networkInterface:NetworkInterface example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/networkInterfaces/nic1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure