NetworkInterface

Manages a Network Interface.

Create a NetworkInterface Resource

new NetworkInterface(name: string, args: NetworkInterfaceArgs, opts?: CustomResourceOptions);

def NetworkInterface(resource_name, opts=None, dns_servers=None, enable_accelerated_networking=None, enable_ip_forwarding=None, internal_dns_name_label=None, ip_configurations=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None);

func NewNetworkInterface(ctx *Context, name string, args NetworkInterfaceArgs, opts ...ResourceOption) (*NetworkInterface, error)

public NetworkInterface(string name, NetworkInterfaceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NetworkInterfaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NetworkInterfaceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NetworkInterfaceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NetworkInterface Resource Properties

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

Inputs

The NetworkInterface resource accepts the following input properties:

IpConfigurations List<NetworkInterfaceIpConfigurationArgs>: One or more ip_configuration blocks as defined below.
ResourceGroupName string: The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
DnsServers List<string>: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
EnableAcceleratedNetworking bool: Should Accelerated Networking be enabled? Defaults to false.
EnableIpForwarding bool: Should IP Forwarding be enabled? Defaults to false.
InternalDnsNameLabel string: The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
Location string: The location where the Network Interface should exist. Changing this forces a new resource to be created.
Name 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 []NetworkInterfaceIpConfiguration: One or more ip_configuration blocks as defined below.
ResourceGroupName string: The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
DnsServers []string: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
EnableAcceleratedNetworking bool: Should Accelerated Networking be enabled? Defaults to false.
EnableIpForwarding bool: Should IP Forwarding be enabled? Defaults to false.
InternalDnsNameLabel string: The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
Location string: The location where the Network Interface should exist. Changing this forces a new resource to be created.
Name 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 NetworkInterfaceIpConfiguration[]: One or more ip_configuration blocks as defined below.
resourceGroupName string: The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
dnsServers string[]: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
enableAcceleratedNetworking boolean: Should Accelerated Networking be enabled? Defaults to false.
enableIpForwarding boolean: Should IP Forwarding be enabled? Defaults to false.
internalDnsNameLabel string: The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
location string: The location where the Network Interface should exist. Changing this forces a new resource to be created.
name 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 List[NetworkInterfaceIpConfiguration]: One or more ip_configuration blocks as defined below.
resource_group_name str: The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
dns_servers List[str]: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
enable_accelerated_networking bool: Should Accelerated Networking be enabled? Defaults to false.
enable_ip_forwarding bool: Should IP Forwarding be enabled? Defaults to false.
internal_dns_name_label str: The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
location str: The location where the Network Interface should exist. Changing this forces a new resource to be created.
name str: The name of the Network Interface. Changing this forces a new resource to be created.
tags Dict[str, str]: 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 Static IP Address which should be used.
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 Static IP Address which should be used.
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 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 Static IP Address which should be used.
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 List[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 Static IP Address which should be used.
private_ip_addresses List[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.

Look up an 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

static get(resource_name, id, opts=None, applied_dns_servers=None, dns_servers=None, enable_accelerated_networking=None, enable_ip_forwarding=None, internal_dns_name_label=None, internal_domain_name_suffix=None, ip_configurations=None, location=None, mac_address=None, name=None, private_ip_address=None, private_ip_addresses=None, resource_group_name=None, tags=None, virtual_machine_id=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

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.
DnsServers List<string>: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
EnableAcceleratedNetworking bool: Should Accelerated Networking be enabled? Defaults to false.
EnableIpForwarding bool: Should IP Forwarding be enabled? Defaults to false.
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<NetworkInterfaceIpConfigurationArgs>: One or more ip_configuration blocks as defined below.
Location 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 string: The name of the Network Interface. Changing this forces a new resource to be created.
PrivateIpAddress string: The Static IP Address which should be used.
PrivateIpAddresses List<string>: The private IP addresses of the network interface.
ResourceGroupName 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.

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.
DnsServers []string: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
EnableAcceleratedNetworking bool: Should Accelerated Networking be enabled? Defaults to false.
EnableIpForwarding bool: Should IP Forwarding be enabled? Defaults to false.
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.
Location 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 string: The name of the Network Interface. Changing this forces a new resource to be created.
PrivateIpAddress string: The Static IP Address which should be used.
PrivateIpAddresses []string: The private IP addresses of the network interface.
ResourceGroupName 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.

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.
dnsServers string[]: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
enableAcceleratedNetworking boolean: Should Accelerated Networking be enabled? Defaults to false.
enableIpForwarding boolean: Should IP Forwarding be enabled? Defaults to false.
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.
location 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 string: The name of the Network Interface. Changing this forces a new resource to be created.
privateIpAddress string: The Static IP Address which should be used.
privateIpAddresses string[]: The private IP addresses of the network interface.
resourceGroupName 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.

applied_dns_servers List[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.
dns_servers List[str]: A list of IP Addresses defining the DNS Servers which should be used for this Network Interface.
enable_accelerated_networking bool: Should Accelerated Networking be enabled? Defaults to false.
enable_ip_forwarding bool: Should IP Forwarding be enabled? Defaults to false.
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 List[NetworkInterfaceIpConfiguration]: One or more ip_configuration blocks as defined below.
location 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 str: The name of the Network Interface. Changing this forces a new resource to be created.
private_ip_address str: The Static IP Address which should be used.
private_ip_addresses List[str]: The private IP addresses of the network interface.
resource_group_name str: The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
tags Dict[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.

Supporting Types

NetworkInterfaceIpConfiguration

See the input and output API doc for this type.

Name string: A name used for this IP Configuration.
PrivateIpAddressAllocation string: The allocation method used for the Private IP Address. Possible values are Dynamic and Static.
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 Static IP Address which should be used.
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.

Name string: A name used for this IP Configuration.
PrivateIpAddressAllocation string: The allocation method used for the Private IP Address. Possible values are Dynamic and Static.
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 Static IP Address which should be used.
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.

name string: A name used for this IP Configuration.
privateIpAddressAllocation string: The allocation method used for the Private IP Address. Possible values are Dynamic and Static.
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 Static IP Address which should be used.
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.

name str: A name used for this IP Configuration.
privateIpAddressAllocation str: The allocation method used for the Private IP Address. Possible values are Dynamic and Static.
primary bool: Is this the Primary IP Configuration? Must be true for the first ip_configuration when multiple are specified. Defaults to false.
privateIpAddressVersion str: The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.
private_ip_address str: The Static IP Address which should be used.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud