Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 4.35 KB

azure_virtual_wan.md

File metadata and controls

95 lines (67 loc) · 4.35 KB
Raw
title platform
About the azure_virtual_wan Resource
azure

azure_virtual_wan

Use the azure_virtual_wan InSpec audit resource to test the properties related to a 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 define the api_version as a resource parameter. If not provided, the latest version is used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint and default values for the HTTP client is used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example, inspec.yml file and how to set up your Azure credentials, refer to 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 Description
name Name of the Azure Virtual WAN to test.
resource_group The resource group name of the VirtualWan.

Properties

Property Description
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, 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

# 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 a contributor role on the subscription you wish to test.