azure_virtual_wans resource

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. 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_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 for all the resources.
Field: properties

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

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

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

This resource has the following special matchers.

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.