azure_virtual_networks Resource

[edit on GitHub]

Use the azure_virtual_networks InSpec audit resource to test 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. 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.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

Syntax

An azure_virtual_networks resource block returns all Azure virtual networks, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_virtual_networks do
  #...
end

or

describe azure_virtual_networks(resource_group: 'my-rg') 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: 'MyResourceGroup') 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: 'MyResourceGroup').where(name: 'MyVnetName') do
  it { should exist }
end

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

describe azure_virtual_networks(resource_group: 'MyResourceGroup').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 Generic Resource (Recommended).

**Fuzzy string matching.**

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

**Exact name matching.**

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

Matchers

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

exists

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

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