azure_subnet resource

Use the azure_subnet InSpec audit resource to test the properties related to a subnet for a given virtual network.

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

resource_group, vnet, and name, or the resource_id are required parameters.

describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do
  it { should exist }
end

describe azure_subnet(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/subnets/{subnetName}') do
  it { should exist }
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

vnet

Name of the Azure virtual network where the subnet is created.

name

Name of the Azure subnet to test.

resource_id

The unique resource ID.

Provide one of the following parameter sets for a valid query:

• resource_id
• resource_group, vnet, and name

Properties

address_prefix

The address prefix for the subnet.

nsg

The network security group attached to the subnet.

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. Any property in the response may be accessed with the key names separated by dots (.).

Examples

Ensure that the subnets address prefix is configured as expected:

describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do
    its('address_prefix') { should eq '192.168.0.0/24' }
end

Ensure that the subnet is attached to the right network security group:

describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do
    its('nsg') { should eq 'NetworkSecurityGroupName'}
end

Matchers

This resource has the following special matchers.

exists

# If a subnet is found, it will exist.

describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_NAME') do
  it { should exist }
end

not_exists

# subnets that aren't found, will not exist.

describe azure_subnet(resource_group: 'RESOURCE_GROUP', vnet: 'VNET_NAME', name: 'SUBNET_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.