Class NetworkInterface

Manages a Network Interface.

Inheritance

System.Object

Resource

CustomResource

NetworkInterface

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Network

Assembly: Pulumi.Azure.dll

Syntax

public class NetworkInterface : CustomResource

Constructors

NetworkInterface(String, NetworkInterfaceArgs, CustomResourceOptions)

Create a NetworkInterface resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
NetworkInterfaceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AppliedDnsServers

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.

Declaration

public Output<ImmutableArray<string>> AppliedDnsServers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

DnsServers

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

Declaration

public Output<ImmutableArray<string>> DnsServers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

EnableAcceleratedNetworking

Should Accelerated Networking be enabled? Defaults to false.

Declaration

public Output<bool?> EnableAcceleratedNetworking { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EnableIpForwarding

Should IP Forwarding be enabled? Defaults to false.

Declaration

public Output<bool?> EnableIpForwarding { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

InternalDnsNameLabel

The (relative) DNS Name used for internal communications between Virtual Machines in the same Virtual Network.

Declaration

public Output<string> InternalDnsNameLabel { get; }

Property Value

Type	Description
Output<System.String>

InternalDomainNameSuffix

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.

Declaration

public Output<string> InternalDomainNameSuffix { get; }

Property Value

Type	Description
Output<System.String>

IpConfigurations

One or more ip_configuration blocks as defined below.

Declaration

public Output<ImmutableArray<NetworkInterfaceIpConfiguration>> IpConfigurations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<NetworkInterfaceIpConfiguration>>

Location

The location where the Network Interface should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

MacAddress

The Media Access Control (MAC) Address of the Network Interface.

Declaration

public Output<string> MacAddress { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the Network Interface. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PrivateIpAddress

The Static IP Address which should be used.

Declaration

public Output<string> PrivateIpAddress { get; }

Property Value

Type	Description
Output<System.String>

PrivateIpAddresses

The private IP addresses of the network interface.

Declaration

public Output<ImmutableArray<string>> PrivateIpAddresses { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ResourceGroupName

The name of the Resource Group in which to create the Network Interface. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

VirtualMachineId

The ID of the Virtual Machine which this Network Interface is connected to.

Declaration

public Output<string> VirtualMachineId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, NetworkInterfaceState, CustomResourceOptions)

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

Declaration

public static NetworkInterface Get(string name, Input<string> id, NetworkInterfaceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
NetworkInterfaceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
NetworkInterface