Share via

NetworkInterface interface

Package:
@azure/arm-network

A network interface in a resource group.

Extends
Resource

Properties

auxiliaryMode

Auxiliary mode of Network Interface resource.
auxiliarySku

Auxiliary sku of Network Interface resource.
defaultOutboundConnectivityEnabled

Whether default outbound connectivity for nic was configured or not. NOTE: This property will not be serialized. It can only be populated by the server.
disableTcpStateTracking

Indicates whether to disable tcp state tracking.
dnsSettings

The DNS settings in network interface.
dscpConfiguration

A reference to the dscp configuration to which the network interface is linked. NOTE: This property will not be serialized. It can only be populated by the server.
enableAcceleratedNetworking

If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding

Indicates whether IP forwarding is enabled on this network interface.
etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation

The extended location of the network interface.
hostedWorkloads

A list of references to linked BareMetal resources. NOTE: This property will not be serialized. It can only be populated by the server.
ipConfigurations

A list of IPConfigurations of the network interface.
macAddress

The MAC address of the network interface. NOTE: This property will not be serialized. It can only be populated by the server.
migrationPhase

Migration phase of Network Interface resource.
networkSecurityGroup

The reference to the NetworkSecurityGroup resource.
nicType

Type of Network Interface resource.
primary

Whether this is a primary network interface on a virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpoint

A reference to the private endpoint to which the network interface is linked. NOTE: This property will not be serialized. It can only be populated by the server.
privateLinkService

Privatelinkservice of the network interface resource.
provisioningState

The provisioning state of the network interface resource. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGuid

The resource GUID property of the network interface resource. NOTE: This property will not be serialized. It can only be populated by the server.
tapConfigurations

A list of TapConfigurations of the network interface. NOTE: This property will not be serialized. It can only be populated by the server.
virtualMachine

The reference to a virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
vnetEncryptionSupported

Whether the virtual machine this nic is attached to supports encryption. NOTE: This property will not be serialized. It can only be populated by the server.
workloadType

WorkloadType of the NetworkInterface for BareMetal resources

Inherited Properties

id

Resource ID.
location

Resource location.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

auxiliaryMode

Auxiliary mode of Network Interface resource.

auxiliaryMode?: string

Property Value

string

auxiliarySku

Auxiliary sku of Network Interface resource.

auxiliarySku?: string

Property Value

string

defaultOutboundConnectivityEnabled

Whether default outbound connectivity for nic was configured or not. NOTE: This property will not be serialized. It can only be populated by the server.

defaultOutboundConnectivityEnabled?: boolean

Property Value

boolean

disableTcpStateTracking

Indicates whether to disable tcp state tracking.

disableTcpStateTracking?: boolean

Property Value

boolean

dnsSettings

The DNS settings in network interface.

dnsSettings?: NetworkInterfaceDnsSettings

Property Value

NetworkInterfaceDnsSettings

dscpConfiguration

A reference to the dscp configuration to which the network interface is linked. NOTE: This property will not be serialized. It can only be populated by the server.

dscpConfiguration?: SubResource

Property Value

SubResource

enableAcceleratedNetworking

If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.

enableAcceleratedNetworking?: boolean

Property Value

boolean

enableIPForwarding

Indicates whether IP forwarding is enabled on this network interface.

enableIPForwarding?: boolean

Property Value

boolean

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

extendedLocation

The extended location of the network interface.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

hostedWorkloads

A list of references to linked BareMetal resources. NOTE: This property will not be serialized. It can only be populated by the server.

hostedWorkloads?: string[]

Property Value

string[]

ipConfigurations

A list of IPConfigurations of the network interface.

ipConfigurations?: NetworkInterfaceIPConfiguration[]

Property Value

NetworkInterfaceIPConfiguration[]

macAddress

The MAC address of the network interface. NOTE: This property will not be serialized. It can only be populated by the server.

macAddress?: string

Property Value

string

migrationPhase

Migration phase of Network Interface resource.

migrationPhase?: string

Property Value

string

networkSecurityGroup

The reference to the NetworkSecurityGroup resource.

networkSecurityGroup?: NetworkSecurityGroup

Property Value

NetworkSecurityGroup

nicType

Type of Network Interface resource.

nicType?: string

Property Value

string

primary

Whether this is a primary network interface on a virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

primary?: boolean

Property Value

boolean

privateEndpoint

A reference to the private endpoint to which the network interface is linked. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpoint?: PrivateEndpoint

Property Value

PrivateEndpoint

privateLinkService

Privatelinkservice of the network interface resource.

privateLinkService?: PrivateLinkService

Property Value

PrivateLinkService

provisioningState

The provisioning state of the network interface resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceGuid

The resource GUID property of the network interface resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGuid?: string

Property Value

string

tapConfigurations

A list of TapConfigurations of the network interface. NOTE: This property will not be serialized. It can only be populated by the server.

tapConfigurations?: NetworkInterfaceTapConfiguration[]

Property Value

NetworkInterfaceTapConfiguration[]

virtualMachine

The reference to a virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

virtualMachine?: SubResource

Property Value

SubResource

vnetEncryptionSupported

Whether the virtual machine this nic is attached to supports encryption. NOTE: This property will not be serialized. It can only be populated by the server.

vnetEncryptionSupported?: boolean

Property Value

boolean

workloadType

WorkloadType of the NetworkInterface for BareMetal resources

workloadType?: string

Property Value

string

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type