azure_virtual_wan resource

Use the azure_virtual_wan InSpec audit resource to test the properties related to an Azure Virtual WAN in a given resource group.

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

name and resource_group are required parameters.

describe azure_virtual_wan(resource_group: 'RESOURCE_GROUP', name: 'DEFAULT_WAN') do
  it { should exist }
  its('properties.provisioningState') { should eq 'Succeeded' }
end

describe azure_virtual_wan(resource_group: 'RESOURCE_GROUP', name: 'DEFAULT_WAN') do
  it  { should exist }
end

Parameters

name

Name of the Azure Virtual WAN to test.

resource_group

The resource group name of the VirtualWan.

Properties

id

Resource ID.

name

Resource name.

type

Resource type.

etag

A unique read-only string that changes whenever the resource is updated.

location

Resource location.

properties.provisioningState

The provisioning state of the Virtual WAN resource.

properties.disableVpnEncryption

VPN encryption to be disabled or not.

properties.allowBranchToBranchTraffic

True if branch-to-branch traffic is allowed.

properties.office365LocalBreakoutCategory

The office local breakout category.

properties.type

The type of the Virtual WAN.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.).

Examples

Test that a Virtual WAN’s encryption is not disabled:

describe azure_virtual_wan(resource_group: 'RESOURCE_GROUP', name: 'DEFAULT_WAN') do
  its('properties.disableVpnEncryption') { should_not be_falsey }
end

Matchers

exists

# If a Virtual WAN is found, it will exist.

describe azure_virtual_wan(resource_group: 'RESOURCE_GROUP', name: 'DEFAULT_WAN') do
  it { should exist }
end

not_exists

# If no Virtual WAN's are found, it will not exist.

describe azure_virtual_wan(resource_group: 'RESOURCE_GROUP', name: 'DEFAULT_WAN') 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.