Skip to main content

azure_network_interface resource

Use the azure_network_interface InSpec audit resource to test the properties and configuration of the Azure Network interface.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

An azure_network_interface resource block identifies an AKS Cluster by name and resource_group, or the resource_id.

describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORKINTERFACENAME') do
  it { should exist }
end

describe azure_network_interface(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}') do
  it { should exist }
end

Parameters

resource_group
Azure resource group where the targeted resource resides.
name
Name of the AKS cluster to test.
resource_id
The unique resource ID.

Either one of the parameter sets can be provided for a valid query:

  • resource_id
  • resource_group and name

Properties

primary?
Indicates whether this is a primary network interface on a virtual machine.
ip_configurations
A list of IPConfigurations of the network interface.
private_ip
The private IP address of the interrogated network interface’s primary IP configuration.
private_ip_address_list
A list of all the private IP addresses of the interrogated network interface.
has_private_address_ip?
Indicates whether the interrogated network interface has a private IP address.
public_ip
The public IP address ID of the interrogated network interface’s primary IP configuration. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}.
public_ip_id_list
A list of all the public IP address IDs of the interrogated network interface.
has_public_address_ip?
Indicates whether the interrogated network interface has a public IP address.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties.

You can access any attribute in the response with the key names separated by dots (.). For example, properties.<attribute>.

Examples

Test if IP forwarding is enabled:

describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do
  its('properties.enableIPForwarding') { should be_true }
end

Test if the primary IP configuration is set to correct private IP address:

describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do
  its('private_ip') { should cmp '172.16.2.6' }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

be_primary

Tests if a network interface is the primary network interface on a virtual machine.

describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do
  it {should be_primary}
end

have_public_address_ip

Test if a network interface has a public IP address.

describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do
  it { should have_public_address_ip}
end

have_private_address_ip

Test if a network interface has a private IP address.

describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do
  it { should have_private_address_ip}
end

exists

# If we expect 'NETWORK_INTERFACE_NAME' to always exist.

describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do
  it { should exist }
end

not_exists

# If we expect 'NETWORK_INTERFACE_NAME' to never exist.

describe azure_network_interface(resource_group: 'RESOURCE_GROUP', name: 'NETWORK_INTERFACE_NAME') do
  it { should_not exist }
end

Azure permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.

Thank you for your feedback!

×