azure_network_interface

auxiliary_mode

Type: STRING
Provider name: properties.auxiliaryMode
Description: Auxiliary mode of Network Interface resource.

dns_settings

Type: STRUCT
Provider name: properties.dnsSettings
Description: The DNS settings in network interface.

• applied_dns_servers
  Type: UNORDERED_LIST_STRING
  Provider name: appliedDnsServers
  Description: If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.
  
• dns_servers
  Type: UNORDERED_LIST_STRING
  Provider name: dnsServers
  Description: List of DNS servers IP addresses. Use ‘AzureProvidedDNS’ to switch to azure provided DNS resolution. ‘AzureProvidedDNS’ value cannot be combined with other IPs, it must be the only value in dnsServers collection.
  
• internal_dns_name_label
  Type: STRING
  Provider name: internalDnsNameLabel
  Description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.
  
• internal_domain_name_suffix
  Type: STRING
  Provider name: internalDomainNameSuffix
  Description: Even if internalDnsNameLabel 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 internalDomainNameSuffix.
  
• internal_fqdn
  Type: STRING
  Provider name: internalFqdn
  Description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
  

dscp_configuration

Type: STRUCT
Provider name: properties.dscpConfiguration
Description: A reference to the dscp configuration to which the network interface is linked.

• id
  Type: STRING
  Provider name: id
  Description: Resource ID.
  

enable_accelerated_networking

Type: BOOLEAN
Provider name: properties.enableAcceleratedNetworking
Description: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.

enable_ip_forwarding

Type: BOOLEAN
Provider name: properties.enableIPForwarding
Description: Indicates whether IP forwarding is enabled on this network interface.

etag

Type: STRING
Provider name: etag
Description: A unique read-only string that changes whenever the resource is updated.

extended_location

Type: STRUCT
Provider name: extendedLocation
Description: The extended location of the network interface.

• name
  Type: STRING
  Provider name: name
  Description: The name of the extended location.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of the extended location.
  

hosted_workloads

Type: UNORDERED_LIST_STRING
Provider name: properties.hostedWorkloads
Description: A list of references to linked BareMetal resources.

id

Type: STRING
Provider name: id
Description: Resource ID.

ip_configurations

Type: UNORDERED_LIST_STRUCT
Provider name: properties.ipConfigurations
Description: A list of IPConfigurations of the network interface.

• application_security_groups
  Type: UNORDERED_LIST_STRUCT
  Provider name: properties.applicationSecurityGroups
  Description: Application security groups in which the IP configuration is included.
  
  • etag
    Type: STRING
    Provider name: etag
    Description: A unique read-only string that changes whenever the resource is updated.
    
  • id
    Type: STRING
    Provider name: id
    Description: Resource ID.
    
  • location
    Type: STRING
    Provider name: location
    Description: Resource location.
    
  • name
    Type: STRING
    Provider name: name
    Description: Resource name.
    
  • provisioning_state
    Type: STRING
    Provider name: properties.provisioningState
    Description: The provisioning state of the application security group resource.
    
  • resource_guid
    Type: STRING
    Provider name: properties.resourceGuid
    Description: The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
    
  • type
    Type: STRING
    Provider name: type
    Description: Resource type.
    
• etag
  Type: STRING
  Provider name: etag
  Description: A unique read-only string that changes whenever the resource is updated.
  
• gateway_load_balancer
  Type: STRUCT
  Provider name: properties.gatewayLoadBalancer
  Description: The reference to gateway load balancer frontend IP.
  
  • id
    Type: STRING
    Provider name: id
    Description: Resource ID.
    
• id
  Type: STRING
  Provider name: id
  Description: Resource ID.
  
• name
  Type: STRING
  Provider name: name
  Description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
  
• primary
  Type: BOOLEAN
  Provider name: properties.primary
  Description: Whether this is a primary customer address on the network interface.
  
• private_ip_address
  Type: STRING
  Provider name: properties.privateIPAddress
  Description: Private IP address of the IP configuration.
  
• private_ip_address_version
  Type: STRING
  Provider name: properties.privateIPAddressVersion
  Description: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.
  
• private_ip_allocation_method
  Type: STRING
  Provider name: properties.privateIPAllocationMethod
  Description: The private IP address allocation method.
  
• private_link_connection_properties
  Type: STRUCT
  Provider name: properties.privateLinkConnectionProperties
  Description: PrivateLinkConnection properties for the network interface.
  
  • fqdns
    Type: UNORDERED_LIST_STRING
    Provider name: fqdns
    Description: List of FQDNs for current private link connection.
    
  • group_id
    Type: STRING
    Provider name: groupId
    Description: The group ID for current private link connection.
    
  • required_member_name
    Type: STRING
    Provider name: requiredMemberName
    Description: The required member name for current private link connection.
    
• provisioning_state
  Type: STRING
  Provider name: properties.provisioningState
  Description: The provisioning state of the network interface IP configuration.
  
• subnet
  Type: STRUCT
  Provider name: properties.subnet
  Description: Subnet bound to the IP configuration.
  
  • id
    Type: STRING
    Provider name: id
    Description: Resource ID.
    
• type
  Type: STRING
  Provider name: type
  Description: Resource type.
  

location

Type: STRING
Provider name: location
Description: Resource location.

mac_address

Type: STRING
Provider name: properties.macAddress
Description: The MAC address of the network interface.

migration_phase

Type: STRING
Provider name: properties.migrationPhase
Description: Migration phase of Network Interface resource.

name

Type: STRING
Provider name: name
Description: Resource name.

nic_type

Type: STRING
Provider name: properties.nicType
Description: Type of Network Interface resource.

primary

Type: BOOLEAN
Provider name: properties.primary
Description: Whether this is a primary network interface on a virtual machine.

provisioning_state

Type: STRING
Provider name: properties.provisioningState
Description: The provisioning state of the network interface resource.

resource_group

Type: STRING

resource_guid

Type: STRING
Provider name: properties.resourceGuid
Description: The resource GUID property of the network interface resource.

subscription_id

Type: STRING

subscription_name

Type: STRING

tags

Type: UNORDERED_LIST_STRING

tap_configurations

Type: UNORDERED_LIST_STRUCT
Provider name: properties.tapConfigurations
Description: A list of TapConfigurations of the network interface.

• etag
  Type: STRING
  Provider name: etag
  Description: A unique read-only string that changes whenever the resource is updated.
  
• id
  Type: STRING
  Provider name: id
  Description: Resource ID.
  
• name
  Type: STRING
  Provider name: name
  Description: The name of the resource that is unique within a resource group. This name can be used to access the resource.
  
• provisioning_state
  Type: STRING
  Provider name: properties.provisioningState
  Description: The provisioning state of the network interface tap configuration resource.
  
• type
  Type: STRING
  Provider name: type
  Description: Sub Resource type.
  

type

Type: STRING
Provider name: type
Description: Resource type.

virtual_machine

Type: STRUCT
Provider name: properties.virtualMachine
Description: The reference to a virtual machine.

• id
  Type: STRING
  Provider name: id
  Description: Resource ID.
  

vnet_encryption_supported

Type: BOOLEAN
Provider name: properties.vnetEncryptionSupported
Description: Whether the virtual machine this nic is attached to supports encryption.

workload_type

Type: STRING
Provider name: properties.workloadType
Description: WorkloadType of the NetworkInterface for BareMetal resources