exec.azurerm.network.network_interface

Azure Resource Manager (ARM) Network Interface Execution Module

New in version 1.0.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.network.network_interface.create_or_update(hub, ctx, name, ip_configurations, subnet, virtual_network, resource_group, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

Create or update a network interface within a specified resource group.

Parameters:
  • name – The name of the network interface to create.
  • ip_configurations – A list of dictionaries representing valid NetworkInterfaceIPConfiguration objects. The name key is required at minimum. At least one IP Configuration must be present.
  • subnet – The name of the subnet assigned to the network interface.
  • virtual_network – The name of the virtual network assigned to the subnet.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.network_interface.create_or_update test-iface0 [{'name': 'testipconfig1'}] testsubnet
                                                   testvnet testgroup
idem_azurerm.exec.azurerm.network.network_interface.delete(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Delete a network interface.

Parameters:
  • name – The name of the network interface to delete.
  • resource_group – The resource group name assigned to the network interface.

CLI Example:

azurerm.network.network_interface.delete test-iface0 testgroup
idem_azurerm.exec.azurerm.network.network_interface.get(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Get details about a specific network interface.

Parameters:
  • name – The name of the network interface to query.
  • resource_group – The resource group name assigned to the network interface.

CLI Example:

azurerm.network.network_interface.get test-iface0 testgroup
idem_azurerm.exec.azurerm.network.network_interface.get_effective_route_table(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Get all route tables for a specific network interface.

Parameters:
  • name – The name of the network interface to query.
  • resource_group – The resource group name assigned to the network interface.

CLI Example:

azurerm.network.network_interface.get_effective_route_table test-iface0 testgroup
idem_azurerm.exec.azurerm.network.network_interface.get_virtual_machine_scale_set_network_interface(hub, ctx, name, scale_set, vm_index, resource_group, expand=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

Get information about a specfic network interface within a scale set.

Parameters:
  • name – The name of the network interface to query.
  • scale_set – The name of the scale set containing the interface.
  • vm_index – The virtual machine index.
  • resource_group – The resource group name assigned to the scale set.
  • expand – Expands referenced resources.

CLI Example:

azurerm.network.network_interface.get_virtual_machine_scale_set_network_interface test-iface0 testset
                                                                                  testvm testgroup
idem_azurerm.exec.azurerm.network.network_interface.list_(hub, ctx, resource_group=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

List all network interfaces within a subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.network.network_interface.list
idem_azurerm.exec.azurerm.network.network_interface.list_effective_network_security_groups(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Get all network security groups applied to a specific network interface.

Parameters:
  • name – The name of the network interface to query.
  • resource_group – The resource group name assigned to the network interface.

CLI Example:

azurerm.network.network_interface.list_effective_network_security_groups test-iface0 testgroup
idem_azurerm.exec.azurerm.network.network_interface.list_virtual_machine_scale_set_vm_network_interfaces(hub, ctx, scale_set, vm_index, resource_group, **kwargs)

New in version 1.0.0.

Get information about all network interfaces in a specific virtual machine within a scale set.

Parameters:
  • scale_set – The name of the scale set to query.
  • vm_index – The virtual machine index.
  • resource_group – The resource group name assigned to the scale set.

CLI Example:

azurerm.network.network_interface.list_virtual_machine_scale_set_vm_network_interfaces testset testvm testgroup
idem_azurerm.exec.azurerm.network.network_interface.update_tags(hub, ctx, name, resource_group, tags, **kwargs)

New in version 4.0.0.

Updates a network interface tags.

Parameters:
  • name – The name of the network interface.
  • resource_group – The name of the resource group.
  • tags – The tags of the resource.

CLI Example:

azurerm.network.network_interface.update_tags test_name test_group '{"owner": "me"}'
idem_azurerm.exec.azurerm.network.network_interface.virtual_machine_scale_set_network_interfaces(hub, ctx, scale_set, resource_group, **kwargs)

New in version 1.0.0.

Get information about all network interfaces within a scale set.

Parameters:
  • scale_set – The name of the scale set to query.
  • resource_group – The resource group name assigned to the scale set.

CLI Example:

azurerm.network.network_interface.list_virtual_machine_scale_set_vm_network_interfaces testset testgroup