azure_virtual_wans Resource

[edit on GitHub]

Use the azure_virtual_wans InSpec audit resource to test the properties related to all Azure Virtual WANs in a 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_wans resource block returns all Azure Virtual WANs in a subscription.

describe azure_virtual_wans do
  #...
end

Parameters

This resource does not require any parameters.

Properties

ids

A list of the unique resource ids.

Field: id

names

A list of names for all the Resources.

Field: name

etags

A list of etag for all the Resources.

Field: etag

types

A list of types for all the resources.

Field: type

locations

A list of locations for all the resources.

Field: location

properties

A list of Properties all the resources.

Field: properties

Examples

Test that the Virtual WAN type is Standard.

describe azure_virtual_wans.where{ properties.select{|prop| prop.type == 'Standard' } } 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 WANs are present

describe azure_virtual_wans do
  it { should_not exist }
end

# Should exist if the filter returns at least one virtual WAN

describe azure_virtual_wans do
  it { should exist }
end

Azure Permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.