azure_virtual_network_gateways.md

title	platform
About the azure_virtual_network_gateways Resource	azure

azure_virtual_network_gateways

Use the azure_virtual_network_gateways InSpec audit resource to test properties and configuration of multiple Azure Virtual Network Gateways.

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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be 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

An azure_virtual_network_gateways resource block returns all VPN gateways, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_virtual_network_gateways do
  #...
end

or

describe azure_virtual_network_gateways(resource_group: 'my-rg') do
  #...
end

Parameters

• resource_group (Optional)

Properties

Property	Description	Filter Criteria*
ids	A list of the unique resource ids.	id
locations	A list of locations for all the resources being interrogated.	location
names	A list of names of all the resources being interrogated.	name
tags	A list of tag:value pairs defined on the resources being interrogated.	tags
properties	A list of properties for all the resources being interrogated.	properties

* For information on how to use filter criteria on plural resources refer to FilterTable usage.

Examples

Test that an Example Resource Group has the Named VPN gateway

describe azure_virtual_network_gateways(resource_group: 'ExampleGroup') do
  its('names') { should include('ExampleName') }
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

The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.

# If we expect 'ExampleGroup' Resource Group to have VPN Gateways
describe azure_virtual_network_gateways(resource_group: 'ExampleGroup') do
  it { should exist }
end

# If we expect 'EmptyExampleGroup' Resource Group to not have VPN Gateways
describe azure_virtual_network_gateways(resource_group: 'EmptyExampleGroup') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.