azure_virtual_networks resource

Use the azure_virtual_networks InSpec audit resource to test the properties related to virtual networks within your subscription.

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_virtual_networks resource block returns all Azure virtual networks within a resource group (if provided) or an entire subscription.

describe azure_virtual_networks do
  #...
end

Or

describe azure_virtual_networks(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 virtual networks.

Field: location

names

A list of all the virtual network names.

Field: name

tags

A list of tag:value pairs defined on the resources.

Field: tags

etags

A list of etags defined on the resources.

Field: etag

Examples

Exists if any virtual networks exist in the resource group:

describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP') do
  it { should exist }
end

Filters the results to only those that match the given name (Client Side):

Insist that MyVnetName exists:

describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP').where(name: 'VNET_NAME') do
  it { should exist }
end

Insist that you have at least one virtual network that starts with 'prefix':

describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP').where { name.include?('project_A') } do
  it { should exist }
end

Filters the networks at Azure API to only those that match the given name via a generic resource (Recommended):

Fuzzy string matching:

describe azure_generic_resources(resource_group: 'RESOURCE_GROUP', resource_provider: 'Microsoft.Network/virtualNetworks', substring_of_name: 'project_A') do
  it { should exist }
end

Exact name matching:

describe azure_generic_resources(resource_group: 'RESOURCE_GROUP', resource_provider: 'Microsoft.Network/virtualNetworks', name: 'MyVnetName') do
  it { should exist }
end

Matchers

This resource has the following special matchers.

exists

# Should not exist if no virtual networks are in the resource group.

describe azure_virtual_networks(resource_group: 'RESOURCE_GROUP') 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.