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. 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.

Install

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

For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.

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, refer to Azure documentation for other properties available. Any attribute in the response may be accessed 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

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

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.