NetworkInterface Class

A network interface in a resource group.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.network.models._models_py3.Resource

NetworkInterface

Constructor

NetworkInterface(*, id: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, network_security_group: _models.NetworkSecurityGroup | None = None, ip_configurations: List[_models.NetworkInterfaceIPConfiguration] | None = None, dns_settings: _models.NetworkInterfaceDnsSettings | None = None, enable_accelerated_networking: bool | None = None, disable_tcp_state_tracking: bool | None = None, enable_ip_forwarding: bool | None = None, workload_type: str | None = None, nic_type: str | _models.NetworkInterfaceNicType | None = None, private_link_service: _models.PrivateLinkService | None = None, migration_phase: str | _models.NetworkInterfaceMigrationPhase | None = None, auxiliary_mode: str | _models.NetworkInterfaceAuxiliaryMode | None = None, auxiliary_sku: str | _models.NetworkInterfaceAuxiliarySku | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Resource ID.
location	str Resource location.
tags	dict[str, str] Resource tags.
extended_location	ExtendedLocation The extended location of the network interface.
network_security_group	NetworkSecurityGroup The reference to the NetworkSecurityGroup resource.
ip_configurations	list[NetworkInterfaceIPConfiguration] A list of IPConfigurations of the network interface.
dns_settings	NetworkInterfaceDnsSettings The DNS settings in network interface.
enable_accelerated_networking	bool If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
disable_tcp_state_tracking	bool Indicates whether to disable tcp state tracking.
enable_ip_forwarding	bool Indicates whether IP forwarding is enabled on this network interface.
workload_type	str WorkloadType of the NetworkInterface for BareMetal resources.
nic_type	str or NetworkInterfaceNicType Type of Network Interface resource. Known values are: "Standard" and "Elastic".
private_link_service	PrivateLinkService Privatelinkservice of the network interface resource.
migration_phase	str or NetworkInterfaceMigrationPhase Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed".
auxiliary_mode	str or NetworkInterfaceAuxiliaryMode Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections".
auxiliary_sku	str or NetworkInterfaceAuxiliarySku Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8".

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
location	str Resource location.
tags	dict[str, str] Resource tags.
extended_location	ExtendedLocation The extended location of the network interface.
etag	str A unique read-only string that changes whenever the resource is updated.
virtual_machine	SubResource The reference to a virtual machine.
network_security_group	NetworkSecurityGroup The reference to the NetworkSecurityGroup resource.
private_endpoint	PrivateEndpoint A reference to the private endpoint to which the network interface is linked.
ip_configurations	list[NetworkInterfaceIPConfiguration] A list of IPConfigurations of the network interface.
tap_configurations	list[NetworkInterfaceTapConfiguration] A list of TapConfigurations of the network interface.
dns_settings	NetworkInterfaceDnsSettings The DNS settings in network interface.
mac_address	str The MAC address of the network interface.
primary	bool Whether this is a primary network interface on a virtual machine.
vnet_encryption_supported	bool Whether the virtual machine this nic is attached to supports encryption.
default_outbound_connectivity_enabled	bool Whether default outbound connectivity for nic was configured or not.
enable_accelerated_networking	bool If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
disable_tcp_state_tracking	bool Indicates whether to disable tcp state tracking.
enable_ip_forwarding	bool Indicates whether IP forwarding is enabled on this network interface.
hosted_workloads	list[str] A list of references to linked BareMetal resources.
dscp_configuration	SubResource A reference to the dscp configuration to which the network interface is linked.
resource_guid	str The resource GUID property of the network interface resource.
provisioning_state	str or ProvisioningState The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
workload_type	str WorkloadType of the NetworkInterface for BareMetal resources.
nic_type	str or NetworkInterfaceNicType Type of Network Interface resource. Known values are: "Standard" and "Elastic".
private_link_service	PrivateLinkService Privatelinkservice of the network interface resource.
migration_phase	str or NetworkInterfaceMigrationPhase Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed".
auxiliary_mode	str or NetworkInterfaceAuxiliaryMode Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections".
auxiliary_sku	str or NetworkInterfaceAuxiliarySku Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8".