We recommend using Azure Native.
azure.network.NetworkInterface
Explore with Pulumi AI
Manages a Network Interface.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new()
{
AddressSpaces = new[]
{
"10.0.0.0/16",
},
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
});
var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new()
{
ResourceGroupName = exampleResourceGroup.Name,
VirtualNetworkName = exampleVirtualNetwork.Name,
AddressPrefixes = new[]
{
"10.0.2.0/24",
},
});
var exampleNetworkInterface = new Azure.Network.NetworkInterface("exampleNetworkInterface", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
IpConfigurations = new[]
{
new Azure.Network.Inputs.NetworkInterfaceIpConfigurationArgs
{
Name = "internal",
SubnetId = exampleSubnet.Id,
PrivateIpAddressAllocation = "Dynamic",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
AddressSpaces: pulumi.StringArray{
pulumi.String("10.0.0.0/16"),
},
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
})
if err != nil {
return err
}
exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{
ResourceGroupName: exampleResourceGroup.Name,
VirtualNetworkName: exampleVirtualNetwork.Name,
AddressPrefixes: pulumi.StringArray{
pulumi.String("10.0.2.0/24"),
},
})
if err != nil {
return err
}
_, err = network.NewNetworkInterface(ctx, "exampleNetworkInterface", &network.NetworkInterfaceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
IpConfigurations: network.NetworkInterfaceIpConfigurationArray{
&network.NetworkInterfaceIpConfigurationArgs{
Name: pulumi.String("internal"),
SubnetId: exampleSubnet.ID(),
PrivateIpAddressAllocation: pulumi.String("Dynamic"),
},
},
})
if err != nil {
return err
}
return nil
})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
.addressSpaces("10.0.0.0/16")
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.build());
var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.virtualNetworkName(exampleVirtualNetwork.name())
.addressPrefixes("10.0.2.0/24")
.build());
var exampleNetworkInterface = new NetworkInterface("exampleNetworkInterface", NetworkInterfaceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.ipConfigurations(NetworkInterfaceIpConfigurationArgs.builder()
.name("internal")
.subnetId(exampleSubnet.id())
.privateIpAddressAllocation("Dynamic")
.build())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
address_spaces=["10.0.0.0/16"],
location=example_resource_group.location,
resource_group_name=example_resource_group.name)
example_subnet = azure.network.Subnet("exampleSubnet",
resource_group_name=example_resource_group.name,
virtual_network_name=example_virtual_network.name,
address_prefixes=["10.0.2.0/24"])
example_network_interface = azure.network.NetworkInterface("exampleNetworkInterface",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
ip_configurations=[azure.network.NetworkInterfaceIpConfigurationArgs(
name="internal",
subnet_id=example_subnet.id,
private_ip_address_allocation="Dynamic",
)])
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
addressSpaces: ["10.0.0.0/16"],
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
});
const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
resourceGroupName: exampleResourceGroup.name,
virtualNetworkName: exampleVirtualNetwork.name,
addressPrefixes: ["10.0.2.0/24"],
});
const exampleNetworkInterface = new azure.network.NetworkInterface("exampleNetworkInterface", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
ipConfigurations: [{
name: "internal",
subnetId: exampleSubnet.id,
privateIpAddressAllocation: "Dynamic",
}],
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleVirtualNetwork:
type: azure:network:VirtualNetwork
properties:
addressSpaces:
- 10.0.0.0/16
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
exampleSubnet:
type: azure:network:Subnet
properties:
resourceGroupName: ${exampleResourceGroup.name}
virtualNetworkName: ${exampleVirtualNetwork.name}
addressPrefixes:
- 10.0.2.0/24
exampleNetworkInterface:
type: azure:network:NetworkInterface
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
ipConfigurations:
- name: internal
subnetId: ${exampleSubnet.id}
privateIpAddressAllocation: Dynamic
Create NetworkInterface Resource
new NetworkInterface(name: string, args: NetworkInterfaceArgs, opts?: CustomResourceOptions);
@overload
def NetworkInterface(resource_name: str,
opts: Optional[ResourceOptions] = None,
auxiliary_mode: Optional[str] = None,
auxiliary_sku: Optional[str] = None,
dns_servers: Optional[Sequence[str]] = None,
edge_zone: Optional[str] = None,
enable_accelerated_networking: Optional[bool] = None,
enable_ip_forwarding: Optional[bool] = None,
internal_dns_name_label: Optional[str] = None,
ip_configurations: Optional[Sequence[NetworkInterfaceIpConfigurationArgs]] = None,
location: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def NetworkInterface(resource_name: str,
args: NetworkInterfaceArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
- args 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 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.
- name String
- The unique name of the resource.
- args NetworkInterfaceArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts docs.
Inputs
The NetworkInterface resource accepts the following input properties:
- Ip
Configurations List<NetworkInterface Ip Configuration> One or more
ip_configuration
blocks as defined below.- Resource
Group stringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- Auxiliary
Mode 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- Auxiliary
Sku string Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- Dns
Servers 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.
- Edge
Zone 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.
- Enable
Accelerated boolNetworking 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.
- Enable
Ip boolForwarding Should IP Forwarding be enabled? Defaults to
false
.- Internal
Dns stringName Label 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.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Ip
Configurations []NetworkInterface Ip Configuration Args One or more
ip_configuration
blocks as defined below.- Resource
Group stringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- Auxiliary
Mode 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- Auxiliary
Sku string Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- Dns
Servers []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.
- Edge
Zone 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.
- Enable
Accelerated boolNetworking 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.
- Enable
Ip boolForwarding Should IP Forwarding be enabled? Defaults to
false
.- Internal
Dns stringName Label 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.
- map[string]string
A mapping of tags to assign to the resource.
- ip
Configurations List<NetworkInterface Ip Configuration> One or more
ip_configuration
blocks as defined below.- resource
Group StringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- auxiliary
Mode 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- auxiliary
Sku String Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- dns
Servers 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.
- edge
Zone 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.
- enable
Accelerated BooleanNetworking 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.
- enable
Ip BooleanForwarding Should IP Forwarding be enabled? Defaults to
false
.- internal
Dns StringName Label 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.
- Map<String,String>
A mapping of tags to assign to the resource.
- ip
Configurations NetworkInterface Ip Configuration[] One or more
ip_configuration
blocks as defined below.- resource
Group stringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- auxiliary
Mode 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- auxiliary
Sku string Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- dns
Servers 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.
- edge
Zone 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.
- enable
Accelerated booleanNetworking 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.
- enable
Ip booleanForwarding Should IP Forwarding be enabled? Defaults to
false
.- internal
Dns stringName Label 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.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- ip_
configurations Sequence[NetworkInterface Ip Configuration Args] One or more
ip_configuration
blocks as defined below.- resource_
group_ strname The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- 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
andNone
.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
andNone
.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 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.
- enable_
accelerated_ boolnetworking 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.
- enable_
ip_ boolforwarding Should IP Forwarding be enabled? Defaults to
false
.- internal_
dns_ strname_ label 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.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- ip
Configurations List<Property Map> One or more
ip_configuration
blocks as defined below.- resource
Group StringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- auxiliary
Mode 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- auxiliary
Sku String Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- dns
Servers 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.
- edge
Zone 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.
- enable
Accelerated BooleanNetworking 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.
- enable
Ip BooleanForwarding Should IP Forwarding be enabled? Defaults to
false
.- internal
Dns StringName Label 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.
- 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:
- Applied
Dns List<string>Servers 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.
- Internal
Domain stringName Suffix 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 ofinternal_domain_name_suffix
.- Mac
Address string The Media Access Control (MAC) Address of the Network Interface.
- Private
Ip stringAddress The Static IP Address which should be used.
- Private
Ip List<string>Addresses The private IP addresses of the network interface.
- Virtual
Machine stringId The ID of the Virtual Machine which this Network Interface is connected to.
- Applied
Dns []stringServers 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.
- Internal
Domain stringName Suffix 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 ofinternal_domain_name_suffix
.- Mac
Address string The Media Access Control (MAC) Address of the Network Interface.
- Private
Ip stringAddress The Static IP Address which should be used.
- Private
Ip []stringAddresses The private IP addresses of the network interface.
- Virtual
Machine stringId The ID of the Virtual Machine which this Network Interface is connected to.
- applied
Dns List<String>Servers 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.
- internal
Domain StringName Suffix 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 ofinternal_domain_name_suffix
.- mac
Address String The Media Access Control (MAC) Address of the Network Interface.
- private
Ip StringAddress The Static IP Address which should be used.
- private
Ip List<String>Addresses The private IP addresses of the network interface.
- virtual
Machine StringId The ID of the Virtual Machine which this Network Interface is connected to.
- applied
Dns string[]Servers 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.
- internal
Domain stringName Suffix 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 ofinternal_domain_name_suffix
.- mac
Address string The Media Access Control (MAC) Address of the Network Interface.
- private
Ip stringAddress The Static IP Address which should be used.
- private
Ip string[]Addresses The private IP addresses of the network interface.
- virtual
Machine stringId The ID of the Virtual Machine which this Network Interface is connected to.
- applied_
dns_ Sequence[str]servers 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_ strname_ suffix 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 ofinternal_domain_name_suffix
.- mac_
address str The Media Access Control (MAC) Address of the Network Interface.
- private_
ip_ straddress The Static IP Address which should be used.
- private_
ip_ Sequence[str]addresses The private IP addresses of the network interface.
- virtual_
machine_ strid The ID of the Virtual Machine which this Network Interface is connected to.
- applied
Dns List<String>Servers 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.
- internal
Domain StringName Suffix 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 ofinternal_domain_name_suffix
.- mac
Address String The Media Access Control (MAC) Address of the Network Interface.
- private
Ip StringAddress The Static IP Address which should be used.
- private
Ip List<String>Addresses The private IP addresses of the network interface.
- virtual
Machine StringId 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,
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,
enable_accelerated_networking: Optional[bool] = None,
enable_ip_forwarding: Optional[bool] = None,
internal_dns_name_label: Optional[str] = None,
internal_domain_name_suffix: Optional[str] = None,
ip_configurations: Optional[Sequence[NetworkInterfaceIpConfigurationArgs]] = 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)
Resource lookup is not supported in YAML
- 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.
- 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.
- Applied
Dns List<string>Servers 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 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- Auxiliary
Sku string Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- Dns
Servers 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.
- Edge
Zone 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.
- Enable
Accelerated boolNetworking 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.
- Enable
Ip boolForwarding Should IP Forwarding be enabled? Defaults to
false
.- Internal
Dns stringName Label The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
- Internal
Domain stringName Suffix 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 ofinternal_domain_name_suffix
.- Ip
Configurations List<NetworkInterface Ip Configuration> 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.
- Mac
Address 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.
- Private
Ip stringAddress The Static IP Address which should be used.
- Private
Ip List<string>Addresses The private IP addresses of the network interface.
- Resource
Group stringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- Dictionary<string, string>
A mapping of tags to assign to the resource.
- Virtual
Machine stringId The ID of the Virtual Machine which this Network Interface is connected to.
- Applied
Dns []stringServers 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 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- Auxiliary
Sku string Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- Dns
Servers []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.
- Edge
Zone 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.
- Enable
Accelerated boolNetworking 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.
- Enable
Ip boolForwarding Should IP Forwarding be enabled? Defaults to
false
.- Internal
Dns stringName Label The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
- Internal
Domain stringName Suffix 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 ofinternal_domain_name_suffix
.- Ip
Configurations []NetworkInterface Ip Configuration Args 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.
- Mac
Address 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.
- Private
Ip stringAddress The Static IP Address which should be used.
- Private
Ip []stringAddresses The private IP addresses of the network interface.
- Resource
Group stringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- map[string]string
A mapping of tags to assign to the resource.
- Virtual
Machine stringId The ID of the Virtual Machine which this Network Interface is connected to.
- applied
Dns List<String>Servers 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 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- auxiliary
Sku String Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- dns
Servers 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.
- edge
Zone 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.
- enable
Accelerated BooleanNetworking 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.
- enable
Ip BooleanForwarding Should IP Forwarding be enabled? Defaults to
false
.- internal
Dns StringName Label The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
- internal
Domain StringName Suffix 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 ofinternal_domain_name_suffix
.- ip
Configurations List<NetworkInterface Ip Configuration> 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.
- mac
Address 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.
- private
Ip StringAddress The Static IP Address which should be used.
- private
Ip List<String>Addresses The private IP addresses of the network interface.
- resource
Group StringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- Map<String,String>
A mapping of tags to assign to the resource.
- virtual
Machine StringId The ID of the Virtual Machine which this Network Interface is connected to.
- applied
Dns string[]Servers 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 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- auxiliary
Sku string Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- dns
Servers 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.
- edge
Zone 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.
- enable
Accelerated booleanNetworking 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.
- enable
Ip booleanForwarding Should IP Forwarding be enabled? Defaults to
false
.- internal
Dns stringName Label The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
- internal
Domain stringName Suffix 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 ofinternal_domain_name_suffix
.- ip
Configurations NetworkInterface Ip Configuration[] 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.
- mac
Address 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.
- private
Ip stringAddress The Static IP Address which should be used.
- private
Ip string[]Addresses The private IP addresses of the network interface.
- resource
Group stringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- {[key: string]: string}
A mapping of tags to assign to the resource.
- virtual
Machine stringId The ID of the Virtual Machine which this Network Interface is connected to.
- applied_
dns_ Sequence[str]servers 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
andNone
.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
andNone
.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 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.
- enable_
accelerated_ boolnetworking 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.
- enable_
ip_ boolforwarding Should IP Forwarding be enabled? Defaults to
false
.- internal_
dns_ strname_ label The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
- internal_
domain_ strname_ suffix 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 ofinternal_domain_name_suffix
.- ip_
configurations Sequence[NetworkInterface Ip Configuration Args] 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_ straddress The Static IP Address which should be used.
- private_
ip_ Sequence[str]addresses The private IP addresses of the network interface.
- resource_
group_ strname The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- Mapping[str, str]
A mapping of tags to assign to the resource.
- virtual_
machine_ strid The ID of the Virtual Machine which this Network Interface is connected to.
- applied
Dns List<String>Servers 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 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
andNone
.Note:
auxiliary_mode
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- auxiliary
Sku String Specifies the SKU used for the network high-performance feature on Network Virtual Appliances (NVAs). Possible values are
A8
,A4
,A1
,A2
andNone
.Note:
auxiliary_sku
is in Preview and requires that the preview is enabled - more information can be found in the Azure documentation.- dns
Servers 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.
- edge
Zone 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.
- enable
Accelerated BooleanNetworking 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.
- enable
Ip BooleanForwarding Should IP Forwarding be enabled? Defaults to
false
.- internal
Dns StringName Label The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.
- internal
Domain StringName Suffix 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 ofinternal_domain_name_suffix
.- ip
Configurations List<Property Map> 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.
- mac
Address 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.
- private
Ip StringAddress The Static IP Address which should be used.
- private
Ip List<String>Addresses The private IP addresses of the network interface.
- resource
Group StringName The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.
- Map<String>
A mapping of tags to assign to the resource.
- virtual
Machine StringId The ID of the Virtual Machine which this Network Interface is connected to.
Supporting Types
NetworkInterfaceIpConfiguration, NetworkInterfaceIpConfigurationArgs
- Name string
A name used for this IP Configuration.
- Private
Ip stringAddress Allocation The allocation method used for the Private IP Address. Possible values are
Dynamic
andStatic
.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 stringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- Primary bool
Is this the Primary IP Configuration? Must be
true
for the firstip_configuration
when multiple are specified. Defaults tofalse
.- Private
Ip stringAddress The Static IP Address which should be used.
- Private
Ip stringAddress Version The IP Version to use. Possible values are
IPv4
orIPv6
. Defaults toIPv4
.- Public
Ip stringAddress Id Reference to a Public IP Address to associate with this NIC
- Subnet
Id 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 toIPv4
.
- Name string
A name used for this IP Configuration.
- Private
Ip stringAddress Allocation The allocation method used for the Private IP Address. Possible values are
Dynamic
andStatic
.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 stringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- Primary bool
Is this the Primary IP Configuration? Must be
true
for the firstip_configuration
when multiple are specified. Defaults tofalse
.- Private
Ip stringAddress The Static IP Address which should be used.
- Private
Ip stringAddress Version The IP Version to use. Possible values are
IPv4
orIPv6
. Defaults toIPv4
.- Public
Ip stringAddress Id Reference to a Public IP Address to associate with this NIC
- Subnet
Id 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 toIPv4
.
- name String
A name used for this IP Configuration.
- private
Ip StringAddress Allocation The allocation method used for the Private IP Address. Possible values are
Dynamic
andStatic
.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 StringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- primary Boolean
Is this the Primary IP Configuration? Must be
true
for the firstip_configuration
when multiple are specified. Defaults tofalse
.- private
Ip StringAddress The Static IP Address which should be used.
- private
Ip StringAddress Version The IP Version to use. Possible values are
IPv4
orIPv6
. Defaults toIPv4
.- public
Ip StringAddress Id Reference to a Public IP Address to associate with this NIC
- subnet
Id 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 toIPv4
.
- name string
A name used for this IP Configuration.
- private
Ip stringAddress Allocation The allocation method used for the Private IP Address. Possible values are
Dynamic
andStatic
.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 stringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- primary boolean
Is this the Primary IP Configuration? Must be
true
for the firstip_configuration
when multiple are specified. Defaults tofalse
.- private
Ip stringAddress The Static IP Address which should be used.
- private
Ip stringAddress Version The IP Version to use. Possible values are
IPv4
orIPv6
. Defaults toIPv4
.- public
Ip stringAddress Id Reference to a Public IP Address to associate with this NIC
- subnet
Id 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 toIPv4
.
- name str
A name used for this IP Configuration.
- private_
ip_ straddress_ allocation The allocation method used for the Private IP Address. Possible values are
Dynamic
andStatic
.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_ strbalancer_ frontend_ ip_ configuration_ id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- primary bool
Is this the Primary IP Configuration? Must be
true
for the firstip_configuration
when multiple are specified. Defaults tofalse
.- private_
ip_ straddress The Static IP Address which should be used.
- private_
ip_ straddress_ version The IP Version to use. Possible values are
IPv4
orIPv6
. Defaults toIPv4
.- public_
ip_ straddress_ id 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 toIPv4
.
- name String
A name used for this IP Configuration.
- private
Ip StringAddress Allocation The allocation method used for the Private IP Address. Possible values are
Dynamic
andStatic
.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 StringBalancer Frontend Ip Configuration Id The Frontend IP Configuration ID of a Gateway SKU Load Balancer.
- primary Boolean
Is this the Primary IP Configuration? Must be
true
for the firstip_configuration
when multiple are specified. Defaults tofalse
.- private
Ip StringAddress The Static IP Address which should be used.
- private
Ip StringAddress Version The IP Version to use. Possible values are
IPv4
orIPv6
. Defaults toIPv4
.- public
Ip StringAddress Id Reference to a Public IP Address to associate with this NIC
- subnet
Id 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 toIPv4
.
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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.