azure_network_interfaces Resource
Use the azure_network_interfaces
InSpec audit resource to test the properties and configuration of Azure Network interfaces.
Azure REST API Version, Endpoint, and HTTP Client Parameters
This resource interacts with API versions supported by the resource provider.
The api_version
can be defined as a resource parameter.
If not provided, this resource uses the latest version.
For more information, refer to the azure_generic_resource
document.
Unless defined, this resource uses the azure_cloud
global endpoint and default values for the HTTP client.
For more information, refer to the resource pack README.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
Syntax
An azure_network_interfaces
resource block returns all Azure Network interfaces within a resource group (if provided) or an entire subscription.
describe azure_network_interfaces do
#...
end
Or
describe azure_network_interfaces(resource_group: 'RESOURCE_GROUP') do
#...
end
Parameters
resource_group
(optional)The name of the resource group.
Properties
ids
- A list of the unique resource IDs.
Field:
id
locations
- A list of locations for all the resources being interrogated.
Field:
location
names
- A list of names of all the resources being interrogated.
Field:
name
tags
- A list of
tag:value
pairs defined on the resources being interrogated. Field:
tags
types
- A list of the types of resources being interrogated.
Field:
type
properties
- A list of properties for all the resources being interrogated.
Field:
properties
Note
Examples
Check network interfaces are present
describe azure_network_interfaces do
it { should exist }
its('names') { should include 'my-network-interface' }
end
Filter the results to include only those with names that match the specified string value
describe azure_network_interfaces.where{ name.include?('my-network') } do
its('count') { should > 3 }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
The control passes if the filter returns at least one result. Use should_not
if you expect zero matches.
# If we expect 'EXAMPLEGROUP' resource group to have network interfaces.
describe azure_network_interfaces(resource_group: 'EXAMPLEGROUP') do
it { should exist }
end
not_exists
# If we expect 'EMPTYEXAMPLEGROUP' resource group to not have network interfaces.
describe azure_network_interfaces(resource_group: 'EMPTYEXAMPLEGROUP') 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.