network_interfaces

Creates, updates, deletes, gets or lists a network_interfaces resource.

Overview

Name	network_interfaces
Type	Resource
Id	azure.network.network_interfaces

Fields

The following fields are returned by SELECT queries:

get_virtual_machine_scale_set_ip_configuration

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
applicationGatewayBackendAddressPools	array	The reference to ApplicationGatewayBackendAddressPool resource.
applicationSecurityGroups	array	Application security groups in which the IP configuration is included.
etag	string	A unique read-only string that changes whenever the resource is updated.
gatewayLoadBalancer	object	Reference to another subresource.
loadBalancerBackendAddressPools	array	The reference to LoadBalancerBackendAddressPool resource.
loadBalancerInboundNatRules	array	A list of references of LoadBalancerInboundNatRules.
primary	boolean	Whether this is a primary customer address on the network interface.
privateIPAddress	string	Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format /.
privateIPAddressPrefixLength	integer	The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address.
privateIPAddressVersion	string	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
privateIPAllocationMethod	string	The private IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic)
privateLinkConnectionProperties	object	PrivateLinkConnection properties for the network interface.
provisioningState	string	The provisioning state of the network interface IP configuration. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddress	object	Public IP address bound to the IP configuration.
subnet	object	Subnet in a virtual network resource.
type	string	Resource type.
virtualNetworkTaps	array	The reference to Virtual Network Taps.

list_virtual_machine_scale_set_ip_configurations

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
applicationGatewayBackendAddressPools	array	The reference to ApplicationGatewayBackendAddressPool resource.
applicationSecurityGroups	array	Application security groups in which the IP configuration is included.
etag	string	A unique read-only string that changes whenever the resource is updated.
gatewayLoadBalancer	object	Reference to another subresource.
loadBalancerBackendAddressPools	array	The reference to LoadBalancerBackendAddressPool resource.
loadBalancerInboundNatRules	array	A list of references of LoadBalancerInboundNatRules.
primary	boolean	Whether this is a primary customer address on the network interface.
privateIPAddress	string	Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format /.
privateIPAddressPrefixLength	integer	The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address.
privateIPAddressVersion	string	Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. Known values are: "IPv4" and "IPv6". (IPv4, IPv6)
privateIPAllocationMethod	string	The private IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic)
privateLinkConnectionProperties	object	PrivateLinkConnection properties for the network interface.
provisioningState	string	The provisioning state of the network interface IP configuration. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddress	object	Public IP address bound to the IP configuration.
subnet	object	Subnet in a virtual network resource.
type	string	Resource type.
virtualNetworkTaps	array	The reference to Virtual Network Taps.

get_cloud_service_network_interface

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
auxiliaryMode	string	Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections". (None, MaxConnections, Floating, AcceleratedConnections)
auxiliarySku	string	Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8". (None, A1, A2, A4, A8)
defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
dnsSettings	object	The DNS settings in network interface.
dscpConfiguration	object	Reference to another subresource.
enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
hostedWorkloads	array	A list of references to linked BareMetal resources.
ipConfigurations	array	A list of IPConfigurations of the network interface.
location	string	Resource location.
macAddress	string	The MAC address of the network interface.
migrationPhase	string	Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed)
networkSecurityGroup	object	The reference to the NetworkSecurityGroup resource.
nicType	string	Type of Network Interface resource. Known values are: "Standard" and "Elastic". (Standard, Elastic)
primary	boolean	Whether this is a primary network interface on a virtual machine.
privateEndpoint	object	A reference to the private endpoint to which the network interface is linked.
privateLinkService	object	Privatelinkservice of the network interface resource.
provisioningState	string	The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network interface resource.
tags	object	Resource tags.
tapConfigurations	array	A list of TapConfigurations of the network interface.
type	string	Resource type.
virtualMachine	object	Reference to another subresource.
vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources.

list_cloud_service_role_instance_network_interfaces

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
auxiliaryMode	string	Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections". (None, MaxConnections, Floating, AcceleratedConnections)
auxiliarySku	string	Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8". (None, A1, A2, A4, A8)
defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
dnsSettings	object	The DNS settings in network interface.
dscpConfiguration	object	Reference to another subresource.
enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
hostedWorkloads	array	A list of references to linked BareMetal resources.
ipConfigurations	array	A list of IPConfigurations of the network interface.
location	string	Resource location.
macAddress	string	The MAC address of the network interface.
migrationPhase	string	Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed)
networkSecurityGroup	object	The reference to the NetworkSecurityGroup resource.
nicType	string	Type of Network Interface resource. Known values are: "Standard" and "Elastic". (Standard, Elastic)
primary	boolean	Whether this is a primary network interface on a virtual machine.
privateEndpoint	object	A reference to the private endpoint to which the network interface is linked.
privateLinkService	object	Privatelinkservice of the network interface resource.
provisioningState	string	The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network interface resource.
tags	object	Resource tags.
tapConfigurations	array	A list of TapConfigurations of the network interface.
type	string	Resource type.
virtualMachine	object	Reference to another subresource.
vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources.

list_virtual_machine_scale_set_vm_network_interfaces

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
auxiliaryMode	string	Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections". (None, MaxConnections, Floating, AcceleratedConnections)
auxiliarySku	string	Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8". (None, A1, A2, A4, A8)
defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
dnsSettings	object	The DNS settings in network interface.
dscpConfiguration	object	Reference to another subresource.
enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
hostedWorkloads	array	A list of references to linked BareMetal resources.
ipConfigurations	array	A list of IPConfigurations of the network interface.
location	string	Resource location.
macAddress	string	The MAC address of the network interface.
migrationPhase	string	Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed)
networkSecurityGroup	object	The reference to the NetworkSecurityGroup resource.
nicType	string	Type of Network Interface resource. Known values are: "Standard" and "Elastic". (Standard, Elastic)
primary	boolean	Whether this is a primary network interface on a virtual machine.
privateEndpoint	object	A reference to the private endpoint to which the network interface is linked.
privateLinkService	object	Privatelinkservice of the network interface resource.
provisioningState	string	The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network interface resource.
tags	object	Resource tags.
tapConfigurations	array	A list of TapConfigurations of the network interface.
type	string	Resource type.
virtualMachine	object	Reference to another subresource.
vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources.

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
auxiliaryMode	string	Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections". (None, MaxConnections, Floating, AcceleratedConnections)
auxiliarySku	string	Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8". (None, A1, A2, A4, A8)
defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
dnsSettings	object	The DNS settings in network interface.
dscpConfiguration	object	Reference to another subresource.
enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
hostedWorkloads	array	A list of references to linked BareMetal resources.
ipConfigurations	array	A list of IPConfigurations of the network interface.
location	string	Resource location.
macAddress	string	The MAC address of the network interface.
migrationPhase	string	Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed)
networkSecurityGroup	object	The reference to the NetworkSecurityGroup resource.
nicType	string	Type of Network Interface resource. Known values are: "Standard" and "Elastic". (Standard, Elastic)
primary	boolean	Whether this is a primary network interface on a virtual machine.
privateEndpoint	object	A reference to the private endpoint to which the network interface is linked.
privateLinkService	object	Privatelinkservice of the network interface resource.
provisioningState	string	The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network interface resource.
tags	object	Resource tags.
tapConfigurations	array	A list of TapConfigurations of the network interface.
type	string	Resource type.
virtualMachine	object	Reference to another subresource.
vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources.

list_cloud_service_network_interfaces

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
auxiliaryMode	string	Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections". (None, MaxConnections, Floating, AcceleratedConnections)
auxiliarySku	string	Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8". (None, A1, A2, A4, A8)
defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
dnsSettings	object	The DNS settings in network interface.
dscpConfiguration	object	Reference to another subresource.
enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
hostedWorkloads	array	A list of references to linked BareMetal resources.
ipConfigurations	array	A list of IPConfigurations of the network interface.
location	string	Resource location.
macAddress	string	The MAC address of the network interface.
migrationPhase	string	Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed)
networkSecurityGroup	object	The reference to the NetworkSecurityGroup resource.
nicType	string	Type of Network Interface resource. Known values are: "Standard" and "Elastic". (Standard, Elastic)
primary	boolean	Whether this is a primary network interface on a virtual machine.
privateEndpoint	object	A reference to the private endpoint to which the network interface is linked.
privateLinkService	object	Privatelinkservice of the network interface resource.
provisioningState	string	The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network interface resource.
tags	object	Resource tags.
tapConfigurations	array	A list of TapConfigurations of the network interface.
type	string	Resource type.
virtualMachine	object	Reference to another subresource.
vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources.

list_virtual_machine_scale_set_network_interfaces

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
auxiliaryMode	string	Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections". (None, MaxConnections, Floating, AcceleratedConnections)
auxiliarySku	string	Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8". (None, A1, A2, A4, A8)
defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
dnsSettings	object	The DNS settings in network interface.
dscpConfiguration	object	Reference to another subresource.
enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
hostedWorkloads	array	A list of references to linked BareMetal resources.
ipConfigurations	array	A list of IPConfigurations of the network interface.
location	string	Resource location.
macAddress	string	The MAC address of the network interface.
migrationPhase	string	Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed)
networkSecurityGroup	object	The reference to the NetworkSecurityGroup resource.
nicType	string	Type of Network Interface resource. Known values are: "Standard" and "Elastic". (Standard, Elastic)
primary	boolean	Whether this is a primary network interface on a virtual machine.
privateEndpoint	object	A reference to the private endpoint to which the network interface is linked.
privateLinkService	object	Privatelinkservice of the network interface resource.
provisioningState	string	The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network interface resource.
tags	object	Resource tags.
tapConfigurations	array	A list of TapConfigurations of the network interface.
type	string	Resource type.
virtualMachine	object	Reference to another subresource.
vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
auxiliaryMode	string	Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections". (None, MaxConnections, Floating, AcceleratedConnections)
auxiliarySku	string	Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8". (None, A1, A2, A4, A8)
defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
dnsSettings	object	The DNS settings in network interface.
dscpConfiguration	object	Reference to another subresource.
enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
hostedWorkloads	array	A list of references to linked BareMetal resources.
ipConfigurations	array	A list of IPConfigurations of the network interface.
location	string	Resource location.
macAddress	string	The MAC address of the network interface.
migrationPhase	string	Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed)
networkSecurityGroup	object	The reference to the NetworkSecurityGroup resource.
nicType	string	Type of Network Interface resource. Known values are: "Standard" and "Elastic". (Standard, Elastic)
primary	boolean	Whether this is a primary network interface on a virtual machine.
privateEndpoint	object	A reference to the private endpoint to which the network interface is linked.
privateLinkService	object	Privatelinkservice of the network interface resource.
provisioningState	string	The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network interface resource.
tags	object	Resource tags.
tapConfigurations	array	A list of TapConfigurations of the network interface.
type	string	Resource type.
virtualMachine	object	Reference to another subresource.
vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
auxiliaryMode	string	Auxiliary mode of Network Interface resource. Known values are: "None", "MaxConnections", "Floating", and "AcceleratedConnections". (None, MaxConnections, Floating, AcceleratedConnections)
auxiliarySku	string	Auxiliary sku of Network Interface resource. Known values are: "None", "A1", "A2", "A4", and "A8". (None, A1, A2, A4, A8)
defaultOutboundConnectivityEnabled	boolean	Whether default outbound connectivity for nic was configured or not.
disableTcpStateTracking	boolean	Indicates whether to disable tcp state tracking.
dnsSettings	object	The DNS settings in network interface.
dscpConfiguration	object	Reference to another subresource.
enableAcceleratedNetworking	boolean	If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking.
enableIPForwarding	boolean	Indicates whether IP forwarding is enabled on this network interface.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the network interface.
hostedWorkloads	array	A list of references to linked BareMetal resources.
ipConfigurations	array	A list of IPConfigurations of the network interface.
location	string	Resource location.
macAddress	string	The MAC address of the network interface.
migrationPhase	string	Migration phase of Network Interface resource. Known values are: "None", "Prepare", "Commit", "Abort", and "Committed". (None, Prepare, Commit, Abort, Committed)
networkSecurityGroup	object	The reference to the NetworkSecurityGroup resource.
nicType	string	Type of Network Interface resource. Known values are: "Standard" and "Elastic". (Standard, Elastic)
primary	boolean	Whether this is a primary network interface on a virtual machine.
privateEndpoint	object	A reference to the private endpoint to which the network interface is linked.
privateLinkService	object	Privatelinkservice of the network interface resource.
provisioningState	string	The provisioning state of the network interface resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network interface resource.
tags	object	Resource tags.
tapConfigurations	array	A list of TapConfigurations of the network interface.
type	string	Resource type.
virtualMachine	object	Reference to another subresource.
vnetEncryptionSupported	boolean	Whether the virtual machine this nic is attached to supports encryption.
workloadType	string	WorkloadType of the NetworkInterface for BareMetal resources.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_virtual_machine_scale_set_ip_configuration	select	resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, ip_configuration_name, subscription_id	$expand	Get the specified network interface ip configuration in a virtual machine scale set.
list_virtual_machine_scale_set_ip_configurations	select	resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, subscription_id	$expand	Get the specified network interface ip configuration in a virtual machine scale set.
get_cloud_service_network_interface	select	resource_group_name, cloud_service_name, role_instance_name, network_interface_name, subscription_id	$expand	Get the specified network interface in a cloud service.
list_cloud_service_role_instance_network_interfaces	select	resource_group_name, cloud_service_name, role_instance_name, subscription_id		Gets information about all network interfaces in a role instance in a cloud service.
list_virtual_machine_scale_set_vm_network_interfaces	select	resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, subscription_id		Gets information about all network interfaces in a virtual machine in a virtual machine scale set.
get	select	resource_group_name, network_interface_name, subscription_id	$expand	Gets information about the specified network interface.
list_cloud_service_network_interfaces	select	resource_group_name, cloud_service_name, subscription_id		Gets all network interfaces in a cloud service.
list_virtual_machine_scale_set_network_interfaces	select	resource_group_name, virtual_machine_scale_set_name, subscription_id		Gets all network interfaces in a virtual machine scale set.
list	select	resource_group_name, subscription_id		Gets all network interfaces in a resource group.
list_all	select	subscription_id		Gets all network interfaces in a subscription.
create_or_update	insert	resource_group_name, network_interface_name, subscription_id		Creates or updates a network interface.
update_tags	update	resource_group_name, network_interface_name, subscription_id		Updates a network interface tags.
create_or_update	replace	resource_group_name, network_interface_name, subscription_id		Creates or updates a network interface.
delete	delete	resource_group_name, network_interface_name, subscription_id		Deletes the specified network interface.
list_effective_network_security_groups	exec	resource_group_name, network_interface_name, subscription_id		Gets all network security groups applied to a network interface.
get_virtual_machine_scale_set_network_interface	exec	resource_group_name, virtual_machine_scale_set_name, virtualmachine_index, network_interface_name, subscription_id	$expand	Get the specified network interface in a virtual machine scale set.
get_effective_route_table	exec	resource_group_name, network_interface_name, subscription_id		Gets all route tables applied to a network interface.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cloud_service_name	string	The name of the cloud service. Required.
ip_configuration_name	string	Required.
network_interface_name	string	The name of the network interface. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_instance_name	string	The name of role instance. Required.
subscription_id	string
virtual_machine_scale_set_name	string	Required.
virtualmachine_index	string	Required.
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get_virtual_machine_scale_set_ip_configuration

Get the specified network interface ip configuration in a virtual machine scale set.

SELECT
id,
name,
applicationGatewayBackendAddressPools,
applicationSecurityGroups,
etag,
gatewayLoadBalancer,
loadBalancerBackendAddressPools,
loadBalancerInboundNatRules,
primary,
privateIPAddress,
privateIPAddressPrefixLength,
privateIPAddressVersion,
privateIPAllocationMethod,
privateLinkConnectionProperties,
provisioningState,
publicIPAddress,
subnet,
type,
virtualNetworkTaps
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_scale_set_name = '{{ virtual_machine_scale_set_name }}' -- required
AND virtualmachine_index = '{{ virtualmachine_index }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND ip_configuration_name = '{{ ip_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_virtual_machine_scale_set_ip_configurations

Get the specified network interface ip configuration in a virtual machine scale set.

SELECT
id,
name,
applicationGatewayBackendAddressPools,
applicationSecurityGroups,
etag,
gatewayLoadBalancer,
loadBalancerBackendAddressPools,
loadBalancerInboundNatRules,
primary,
privateIPAddress,
privateIPAddressPrefixLength,
privateIPAddressVersion,
privateIPAllocationMethod,
privateLinkConnectionProperties,
provisioningState,
publicIPAddress,
subnet,
type,
virtualNetworkTaps
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_scale_set_name = '{{ virtual_machine_scale_set_name }}' -- required
AND virtualmachine_index = '{{ virtualmachine_index }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

get_cloud_service_network_interface

Get the specified network interface in a cloud service.

SELECT
id,
name,
auxiliaryMode,
auxiliarySku,
defaultOutboundConnectivityEnabled,
disableTcpStateTracking,
dnsSettings,
dscpConfiguration,
enableAcceleratedNetworking,
enableIPForwarding,
etag,
extendedLocation,
hostedWorkloads,
ipConfigurations,
location,
macAddress,
migrationPhase,
networkSecurityGroup,
nicType,
primary,
privateEndpoint,
privateLinkService,
provisioningState,
resourceGuid,
tags,
tapConfigurations,
type,
virtualMachine,
vnetEncryptionSupported,
workloadType
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_service_name = '{{ cloud_service_name }}' -- required
AND role_instance_name = '{{ role_instance_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_cloud_service_role_instance_network_interfaces

Gets information about all network interfaces in a role instance in a cloud service.

SELECT
id,
name,
auxiliaryMode,
auxiliarySku,
defaultOutboundConnectivityEnabled,
disableTcpStateTracking,
dnsSettings,
dscpConfiguration,
enableAcceleratedNetworking,
enableIPForwarding,
etag,
extendedLocation,
hostedWorkloads,
ipConfigurations,
location,
macAddress,
migrationPhase,
networkSecurityGroup,
nicType,
primary,
privateEndpoint,
privateLinkService,
provisioningState,
resourceGuid,
tags,
tapConfigurations,
type,
virtualMachine,
vnetEncryptionSupported,
workloadType
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_service_name = '{{ cloud_service_name }}' -- required
AND role_instance_name = '{{ role_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_virtual_machine_scale_set_vm_network_interfaces

Gets information about all network interfaces in a virtual machine in a virtual machine scale set.

SELECT
id,
name,
auxiliaryMode,
auxiliarySku,
defaultOutboundConnectivityEnabled,
disableTcpStateTracking,
dnsSettings,
dscpConfiguration,
enableAcceleratedNetworking,
enableIPForwarding,
etag,
extendedLocation,
hostedWorkloads,
ipConfigurations,
location,
macAddress,
migrationPhase,
networkSecurityGroup,
nicType,
primary,
privateEndpoint,
privateLinkService,
provisioningState,
resourceGuid,
tags,
tapConfigurations,
type,
virtualMachine,
vnetEncryptionSupported,
workloadType
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_scale_set_name = '{{ virtual_machine_scale_set_name }}' -- required
AND virtualmachine_index = '{{ virtualmachine_index }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets information about the specified network interface.

SELECT
id,
name,
auxiliaryMode,
auxiliarySku,
defaultOutboundConnectivityEnabled,
disableTcpStateTracking,
dnsSettings,
dscpConfiguration,
enableAcceleratedNetworking,
enableIPForwarding,
etag,
extendedLocation,
hostedWorkloads,
ipConfigurations,
location,
macAddress,
migrationPhase,
networkSecurityGroup,
nicType,
primary,
privateEndpoint,
privateLinkService,
provisioningState,
resourceGuid,
tags,
tapConfigurations,
type,
virtualMachine,
vnetEncryptionSupported,
workloadType
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_cloud_service_network_interfaces

Gets all network interfaces in a cloud service.

SELECT
id,
name,
auxiliaryMode,
auxiliarySku,
defaultOutboundConnectivityEnabled,
disableTcpStateTracking,
dnsSettings,
dscpConfiguration,
enableAcceleratedNetworking,
enableIPForwarding,
etag,
extendedLocation,
hostedWorkloads,
ipConfigurations,
location,
macAddress,
migrationPhase,
networkSecurityGroup,
nicType,
primary,
privateEndpoint,
privateLinkService,
provisioningState,
resourceGuid,
tags,
tapConfigurations,
type,
virtualMachine,
vnetEncryptionSupported,
workloadType
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_service_name = '{{ cloud_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_virtual_machine_scale_set_network_interfaces

Gets all network interfaces in a virtual machine scale set.

SELECT
id,
name,
auxiliaryMode,
auxiliarySku,
defaultOutboundConnectivityEnabled,
disableTcpStateTracking,
dnsSettings,
dscpConfiguration,
enableAcceleratedNetworking,
enableIPForwarding,
etag,
extendedLocation,
hostedWorkloads,
ipConfigurations,
location,
macAddress,
migrationPhase,
networkSecurityGroup,
nicType,
primary,
privateEndpoint,
privateLinkService,
provisioningState,
resourceGuid,
tags,
tapConfigurations,
type,
virtualMachine,
vnetEncryptionSupported,
workloadType
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_scale_set_name = '{{ virtual_machine_scale_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all network interfaces in a resource group.

SELECT
id,
name,
auxiliaryMode,
auxiliarySku,
defaultOutboundConnectivityEnabled,
disableTcpStateTracking,
dnsSettings,
dscpConfiguration,
enableAcceleratedNetworking,
enableIPForwarding,
etag,
extendedLocation,
hostedWorkloads,
ipConfigurations,
location,
macAddress,
migrationPhase,
networkSecurityGroup,
nicType,
primary,
privateEndpoint,
privateLinkService,
provisioningState,
resourceGuid,
tags,
tapConfigurations,
type,
virtualMachine,
vnetEncryptionSupported,
workloadType
FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all network interfaces in a subscription.

SELECT
id,
name,
auxiliaryMode,
auxiliarySku,
defaultOutboundConnectivityEnabled,
disableTcpStateTracking,
dnsSettings,
dscpConfiguration,
enableAcceleratedNetworking,
enableIPForwarding,
etag,
extendedLocation,
hostedWorkloads,
ipConfigurations,
location,
macAddress,
migrationPhase,
networkSecurityGroup,
nicType,
primary,
privateEndpoint,
privateLinkService,
provisioningState,
resourceGuid,
tags,
tapConfigurations,
type,
virtualMachine,
vnetEncryptionSupported,
workloadType
FROM azure.network.network_interfaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network interface.

INSERT INTO azure.network.network_interfaces (
id,
location,
tags,
properties,
extendedLocation,
resource_group_name,
network_interface_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ network_interface_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_interfaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_interfaces resource.
  - name: network_interface_name
    value: "{{ network_interface_name }}"
    description: Required parameter for the network_interfaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_interfaces resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the network interface.
    value:
      virtualMachine:
        id: "{{ id }}"
      networkSecurityGroup:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          flushConnection: {{ flushConnection }}
          securityRules:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                description: "{{ description }}"
                protocol: "{{ protocol }}"
                sourcePortRange: "{{ sourcePortRange }}"
                destinationPortRange: "{{ destinationPortRange }}"
                sourceAddressPrefix: "{{ sourceAddressPrefix }}"
                sourceAddressPrefixes: "{{ sourceAddressPrefixes }}"
                sourceApplicationSecurityGroups: "{{ sourceApplicationSecurityGroups }}"
                destinationAddressPrefix: "{{ destinationAddressPrefix }}"
                destinationAddressPrefixes: "{{ destinationAddressPrefixes }}"
                destinationApplicationSecurityGroups: "{{ destinationApplicationSecurityGroups }}"
                sourcePortRanges: "{{ sourcePortRanges }}"
                destinationPortRanges: "{{ destinationPortRanges }}"
                access: "{{ access }}"
                priority: {{ priority }}
                direction: "{{ direction }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
          defaultSecurityRules:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                description: "{{ description }}"
                protocol: "{{ protocol }}"
                sourcePortRange: "{{ sourcePortRange }}"
                destinationPortRange: "{{ destinationPortRange }}"
                sourceAddressPrefix: "{{ sourceAddressPrefix }}"
                sourceAddressPrefixes: "{{ sourceAddressPrefixes }}"
                sourceApplicationSecurityGroups: "{{ sourceApplicationSecurityGroups }}"
                destinationAddressPrefix: "{{ destinationAddressPrefix }}"
                destinationAddressPrefixes: "{{ destinationAddressPrefixes }}"
                destinationApplicationSecurityGroups: "{{ destinationApplicationSecurityGroups }}"
                sourcePortRanges: "{{ sourcePortRanges }}"
                destinationPortRanges: "{{ destinationPortRanges }}"
                access: "{{ access }}"
                priority: {{ priority }}
                direction: "{{ direction }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
          networkInterfaces:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                virtualMachine: "{{ virtualMachine }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                privateEndpoint: "{{ privateEndpoint }}"
                ipConfigurations: "{{ ipConfigurations }}"
                tapConfigurations: "{{ tapConfigurations }}"
                dnsSettings: "{{ dnsSettings }}"
                macAddress: "{{ macAddress }}"
                primary: {{ primary }}
                vnetEncryptionSupported: {{ vnetEncryptionSupported }}
                defaultOutboundConnectivityEnabled: {{ defaultOutboundConnectivityEnabled }}
                enableAcceleratedNetworking: {{ enableAcceleratedNetworking }}
                disableTcpStateTracking: {{ disableTcpStateTracking }}
                enableIPForwarding: {{ enableIPForwarding }}
                hostedWorkloads: "{{ hostedWorkloads }}"
                dscpConfiguration: "{{ dscpConfiguration }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                workloadType: "{{ workloadType }}"
                nicType: "{{ nicType }}"
                privateLinkService: "{{ privateLinkService }}"
                migrationPhase: "{{ migrationPhase }}"
                auxiliaryMode: "{{ auxiliaryMode }}"
                auxiliarySku: "{{ auxiliarySku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
          subnets:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                addressPrefix: "{{ addressPrefix }}"
                addressPrefixes: "{{ addressPrefixes }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                routeTable: "{{ routeTable }}"
                natGateway: "{{ natGateway }}"
                serviceEndpoints: "{{ serviceEndpoints }}"
                serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
                privateEndpoints: "{{ privateEndpoints }}"
                ipConfigurations: "{{ ipConfigurations }}"
                ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
                ipAllocations: "{{ ipAllocations }}"
                resourceNavigationLinks: "{{ resourceNavigationLinks }}"
                serviceAssociationLinks: "{{ serviceAssociationLinks }}"
                delegations: "{{ delegations }}"
                purpose: "{{ purpose }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
                privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
                applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
                sharingScope: "{{ sharingScope }}"
                defaultOutboundAccess: {{ defaultOutboundAccess }}
                ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
                serviceGateway: "{{ serviceGateway }}"
              etag: "{{ etag }}"
          flowLogs:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                targetResourceId: "{{ targetResourceId }}"
                targetResourceGuid: "{{ targetResourceGuid }}"
                storageId: "{{ storageId }}"
                enabledFilteringCriteria: "{{ enabledFilteringCriteria }}"
                recordTypes: "{{ recordTypes }}"
                enabled: {{ enabled }}
                retentionPolicy: "{{ retentionPolicy }}"
                format: "{{ format }}"
                flowAnalyticsConfiguration: "{{ flowAnalyticsConfiguration }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
              identity:
                principalId: "{{ principalId }}"
                tenantId: "{{ tenantId }}"
                type: "{{ type }}"
                userAssignedIdentities: "{{ userAssignedIdentities }}"
          resourceGuid: "{{ resourceGuid }}"
          provisioningState: "{{ provisioningState }}"
        etag: "{{ etag }}"
      privateEndpoint:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          subnet:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            properties:
              addressPrefix: "{{ addressPrefix }}"
              addressPrefixes: "{{ addressPrefixes }}"
              networkSecurityGroup: "{{ networkSecurityGroup }}"
              routeTable: "{{ routeTable }}"
              natGateway: "{{ natGateway }}"
              serviceEndpoints: "{{ serviceEndpoints }}"
              serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
              privateEndpoints: "{{ privateEndpoints }}"
              ipConfigurations: "{{ ipConfigurations }}"
              ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
              ipAllocations: "{{ ipAllocations }}"
              resourceNavigationLinks: "{{ resourceNavigationLinks }}"
              serviceAssociationLinks: "{{ serviceAssociationLinks }}"
              delegations: "{{ delegations }}"
              purpose: "{{ purpose }}"
              provisioningState: "{{ provisioningState }}"
              privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
              privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
              applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
              sharingScope: "{{ sharingScope }}"
              defaultOutboundAccess: {{ defaultOutboundAccess }}
              ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
              serviceGateway: "{{ serviceGateway }}"
            etag: "{{ etag }}"
          networkInterfaces:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                virtualMachine: "{{ virtualMachine }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                privateEndpoint: "{{ privateEndpoint }}"
                ipConfigurations: "{{ ipConfigurations }}"
                tapConfigurations: "{{ tapConfigurations }}"
                dnsSettings: "{{ dnsSettings }}"
                macAddress: "{{ macAddress }}"
                primary: {{ primary }}
                vnetEncryptionSupported: {{ vnetEncryptionSupported }}
                defaultOutboundConnectivityEnabled: {{ defaultOutboundConnectivityEnabled }}
                enableAcceleratedNetworking: {{ enableAcceleratedNetworking }}
                disableTcpStateTracking: {{ disableTcpStateTracking }}
                enableIPForwarding: {{ enableIPForwarding }}
                hostedWorkloads: "{{ hostedWorkloads }}"
                dscpConfiguration: "{{ dscpConfiguration }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                workloadType: "{{ workloadType }}"
                nicType: "{{ nicType }}"
                privateLinkService: "{{ privateLinkService }}"
                migrationPhase: "{{ migrationPhase }}"
                auxiliaryMode: "{{ auxiliaryMode }}"
                auxiliarySku: "{{ auxiliarySku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
          provisioningState: "{{ provisioningState }}"
          ipVersionType: "{{ ipVersionType }}"
          privateLinkServiceConnections:
            - id: "{{ id }}"
              properties:
                provisioningState: "{{ provisioningState }}"
                privateLinkServiceId: "{{ privateLinkServiceId }}"
                groupIds: "{{ groupIds }}"
                requestMessage: "{{ requestMessage }}"
                privateLinkServiceConnectionState: "{{ privateLinkServiceConnectionState }}"
              name: "{{ name }}"
              type: "{{ type }}"
              etag: "{{ etag }}"
          manualPrivateLinkServiceConnections:
            - id: "{{ id }}"
              properties:
                provisioningState: "{{ provisioningState }}"
                privateLinkServiceId: "{{ privateLinkServiceId }}"
                groupIds: "{{ groupIds }}"
                requestMessage: "{{ requestMessage }}"
                privateLinkServiceConnectionState: "{{ privateLinkServiceConnectionState }}"
              name: "{{ name }}"
              type: "{{ type }}"
              etag: "{{ etag }}"
          customDnsConfigs:
            - fqdn: "{{ fqdn }}"
              ipAddresses: "{{ ipAddresses }}"
          applicationSecurityGroups:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
          ipConfigurations:
            - properties:
                groupId: "{{ groupId }}"
                memberName: "{{ memberName }}"
                privateIPAddress: "{{ privateIPAddress }}"
              name: "{{ name }}"
              type: "{{ type }}"
              etag: "{{ etag }}"
          customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
          billingSku: "{{ billingSku }}"
        extendedLocation:
          name: "{{ name }}"
          type: "{{ type }}"
        etag: "{{ etag }}"
      ipConfigurations:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            gatewayLoadBalancer:
              id: "{{ id }}"
            virtualNetworkTaps:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  networkInterfaceTapConfigurations: "{{ networkInterfaceTapConfigurations }}"
                  resourceGuid: "{{ resourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                  destinationNetworkInterfaceIPConfiguration: "{{ destinationNetworkInterfaceIPConfiguration }}"
                  destinationLoadBalancerFrontEndIPConfiguration: "{{ destinationLoadBalancerFrontEndIPConfiguration }}"
                  destinationPort: {{ destinationPort }}
                etag: "{{ etag }}"
            applicationGatewayBackendAddressPools:
              - id: "{{ id }}"
                properties:
                  backendIPConfigurations: "{{ backendIPConfigurations }}"
                  backendAddresses: "{{ backendAddresses }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            loadBalancerBackendAddressPools:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  location: "{{ location }}"
                  tunnelInterfaces: "{{ tunnelInterfaces }}"
                  loadBalancerBackendAddresses: "{{ loadBalancerBackendAddresses }}"
                  backendIPConfigurations: "{{ backendIPConfigurations }}"
                  loadBalancingRules: "{{ loadBalancingRules }}"
                  outboundRule: "{{ outboundRule }}"
                  outboundRules: "{{ outboundRules }}"
                  inboundNatRules: "{{ inboundNatRules }}"
                  provisioningState: "{{ provisioningState }}"
                  drainPeriodInSeconds: {{ drainPeriodInSeconds }}
                  virtualNetwork: "{{ virtualNetwork }}"
                  syncMode: "{{ syncMode }}"
                etag: "{{ etag }}"
            loadBalancerInboundNatRules:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  frontendIPConfiguration: "{{ frontendIPConfiguration }}"
                  backendIPConfiguration: "{{ backendIPConfiguration }}"
                  protocol: "{{ protocol }}"
                  frontendPort: {{ frontendPort }}
                  backendPort: {{ backendPort }}
                  idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
                  enableFloatingIP: {{ enableFloatingIP }}
                  enableTcpReset: {{ enableTcpReset }}
                  frontendPortRangeStart: {{ frontendPortRangeStart }}
                  frontendPortRangeEnd: {{ frontendPortRangeEnd }}
                  backendAddressPool: "{{ backendAddressPool }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            privateIPAddress: "{{ privateIPAddress }}"
            privateIPAddressPrefixLength: {{ privateIPAddressPrefixLength }}
            privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
            privateIPAddressVersion: "{{ privateIPAddressVersion }}"
            subnet:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                addressPrefix: "{{ addressPrefix }}"
                addressPrefixes: "{{ addressPrefixes }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                routeTable: "{{ routeTable }}"
                natGateway: "{{ natGateway }}"
                serviceEndpoints: "{{ serviceEndpoints }}"
                serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
                privateEndpoints: "{{ privateEndpoints }}"
                ipConfigurations: "{{ ipConfigurations }}"
                ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
                ipAllocations: "{{ ipAllocations }}"
                resourceNavigationLinks: "{{ resourceNavigationLinks }}"
                serviceAssociationLinks: "{{ serviceAssociationLinks }}"
                delegations: "{{ delegations }}"
                purpose: "{{ purpose }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
                privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
                applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
                sharingScope: "{{ sharingScope }}"
                defaultOutboundAccess: {{ defaultOutboundAccess }}
                ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
                serviceGateway: "{{ serviceGateway }}"
              etag: "{{ etag }}"
            primary: {{ primary }}
            publicIPAddress:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
                publicIPAddressVersion: "{{ publicIPAddressVersion }}"
                ipConfiguration: "{{ ipConfiguration }}"
                dnsSettings: "{{ dnsSettings }}"
                ddosSettings: "{{ ddosSettings }}"
                ipTags: "{{ ipTags }}"
                ipAddress: "{{ ipAddress }}"
                publicIPPrefix: "{{ publicIPPrefix }}"
                idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                servicePublicIPAddress: "{{ servicePublicIPAddress }}"
                natGateway: "{{ natGateway }}"
                migrationPhase: "{{ migrationPhase }}"
                linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
                deleteOption: "{{ deleteOption }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              sku:
                name: "{{ name }}"
                tier: "{{ tier }}"
              etag: "{{ etag }}"
              zones:
                - "{{ zones }}"
            applicationSecurityGroups:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  resourceGuid: "{{ resourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            provisioningState: "{{ provisioningState }}"
            privateLinkConnectionProperties:
              groupId: "{{ groupId }}"
              requiredMemberName: "{{ requiredMemberName }}"
              fqdns:
                - "{{ fqdns }}"
          etag: "{{ etag }}"
      tapConfigurations:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            virtualNetworkTap:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                networkInterfaceTapConfigurations: "{{ networkInterfaceTapConfigurations }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                destinationNetworkInterfaceIPConfiguration: "{{ destinationNetworkInterfaceIPConfiguration }}"
                destinationLoadBalancerFrontEndIPConfiguration: "{{ destinationLoadBalancerFrontEndIPConfiguration }}"
                destinationPort: {{ destinationPort }}
              etag: "{{ etag }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
      dnsSettings:
        dnsServers:
          - "{{ dnsServers }}"
        appliedDnsServers:
          - "{{ appliedDnsServers }}"
        internalDnsNameLabel: "{{ internalDnsNameLabel }}"
        internalFqdn: "{{ internalFqdn }}"
        internalDomainNameSuffix: "{{ internalDomainNameSuffix }}"
      macAddress: "{{ macAddress }}"
      primary: {{ primary }}
      vnetEncryptionSupported: {{ vnetEncryptionSupported }}
      defaultOutboundConnectivityEnabled: {{ defaultOutboundConnectivityEnabled }}
      enableAcceleratedNetworking: {{ enableAcceleratedNetworking }}
      disableTcpStateTracking: {{ disableTcpStateTracking }}
      enableIPForwarding: {{ enableIPForwarding }}
      hostedWorkloads:
        - "{{ hostedWorkloads }}"
      dscpConfiguration:
        id: "{{ id }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      workloadType: "{{ workloadType }}"
      nicType: "{{ nicType }}"
      privateLinkService:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          loadBalancerFrontendIpConfigurations:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                inboundNatRules: "{{ inboundNatRules }}"
                inboundNatPools: "{{ inboundNatPools }}"
                outboundRules: "{{ outboundRules }}"
                loadBalancingRules: "{{ loadBalancingRules }}"
                privateIPAddress: "{{ privateIPAddress }}"
                privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                privateIPAddressVersion: "{{ privateIPAddressVersion }}"
                subnet: "{{ subnet }}"
                publicIPAddress: "{{ publicIPAddress }}"
                publicIPPrefix: "{{ publicIPPrefix }}"
                gatewayLoadBalancer: "{{ gatewayLoadBalancer }}"
                provisioningState: "{{ provisioningState }}"
                ddosSettings: "{{ ddosSettings }}"
              etag: "{{ etag }}"
              zones: "{{ zones }}"
          ipConfigurations:
            - id: "{{ id }}"
              properties:
                privateIPAddress: "{{ privateIPAddress }}"
                privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                subnet: "{{ subnet }}"
                primary: {{ primary }}
                provisioningState: "{{ provisioningState }}"
                privateIPAddressVersion: "{{ privateIPAddressVersion }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          destinationIPAddress: "{{ destinationIPAddress }}"
          accessMode: "{{ accessMode }}"
          networkInterfaces:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                virtualMachine: "{{ virtualMachine }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                privateEndpoint: "{{ privateEndpoint }}"
                ipConfigurations: "{{ ipConfigurations }}"
                tapConfigurations: "{{ tapConfigurations }}"
                dnsSettings: "{{ dnsSettings }}"
                macAddress: "{{ macAddress }}"
                primary: {{ primary }}
                vnetEncryptionSupported: {{ vnetEncryptionSupported }}
                defaultOutboundConnectivityEnabled: {{ defaultOutboundConnectivityEnabled }}
                enableAcceleratedNetworking: {{ enableAcceleratedNetworking }}
                disableTcpStateTracking: {{ disableTcpStateTracking }}
                enableIPForwarding: {{ enableIPForwarding }}
                hostedWorkloads: "{{ hostedWorkloads }}"
                dscpConfiguration: "{{ dscpConfiguration }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                workloadType: "{{ workloadType }}"
                nicType: "{{ nicType }}"
                privateLinkService: "{{ privateLinkService }}"
                migrationPhase: "{{ migrationPhase }}"
                auxiliaryMode: "{{ auxiliaryMode }}"
                auxiliarySku: "{{ auxiliarySku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
          provisioningState: "{{ provisioningState }}"
          privateEndpointConnections:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                privateEndpoint: "{{ privateEndpoint }}"
                privateLinkServiceConnectionState: "{{ privateLinkServiceConnectionState }}"
                provisioningState: "{{ provisioningState }}"
                linkIdentifier: "{{ linkIdentifier }}"
                privateEndpointLocation: "{{ privateEndpointLocation }}"
              etag: "{{ etag }}"
          visibility:
            subscriptions:
              - "{{ subscriptions }}"
          autoApproval:
            subscriptions:
              - "{{ subscriptions }}"
          fqdns:
            - "{{ fqdns }}"
          alias: "{{ alias }}"
          enableProxyProtocol: {{ enableProxyProtocol }}
        extendedLocation:
          name: "{{ name }}"
          type: "{{ type }}"
        etag: "{{ etag }}"
      migrationPhase: "{{ migrationPhase }}"
      auxiliaryMode: "{{ auxiliaryMode }}"
      auxiliarySku: "{{ auxiliarySku }}"
  - name: extendedLocation
    description: |
      The extended location of the network interface.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update_tags

Updates a network interface tags.

UPDATE azure.network.network_interfaces
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a network interface.

REPLACE azure.network.network_interfaces
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified network interface.

DELETE FROM azure.network.network_interfaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_effective_network_security_groups

Gets all network security groups applied to a network interface.

EXEC azure.network.network_interfaces.list_effective_network_security_groups 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_interface_name='{{ network_interface_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_virtual_machine_scale_set_network_interface

Get the specified network interface in a virtual machine scale set.

EXEC azure.network.network_interfaces.get_virtual_machine_scale_set_network_interface 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_machine_scale_set_name='{{ virtual_machine_scale_set_name }}' --required, 
@virtualmachine_index='{{ virtualmachine_index }}' --required, 
@network_interface_name='{{ network_interface_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$expand='{{ $expand }}'
;

get_effective_route_table

Gets all route tables applied to a network interface.

EXEC azure.network.network_interfaces.get_effective_route_table 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_interface_name='{{ network_interface_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;