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. 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

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, refer to Azure documentation for other properties available. 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

For a full list of available matchers, see our Universal Matchers page.

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.