azure_virtual_network_gateway resource

Use the azure_virtual_network_gateway InSpec audit resource to test the properties and configuration of an Azure Virtual Network Gateway.

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

resource_group and name are required parameters.

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

Parameters

resource_group (REQUIRED): The Azure resource group where the targeted resource resides.
name (REQUIRED): The unique name of the targeted resource.

Properties

name: The resource name.
id: The resource ID.
etag: A unique read-only string that changes whenever the resource is updated.
type: The resource type.
location: The resource location.
tags: The resource tags.
properties.bgpSettings: The virtual network gateway’s BGP speaker settings.
properties.provisioningState: The provisioning state of the virtual network gateway resource.
properties.vpnClientConfiguration: The reference to the VpnClientConfiguration resource, which represents the P2S VpnClient configurations.

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. Any attribute in the response is accessed with the key names separated by dots (.).

Examples

Test the VPN client protocol of a virtual network gateway:

describe azure_virtual_network_gateway(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do
  its('properties.vpnClientConfiguration.vpnClientProtocols') { should include 'OpenVPN' }
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 we expect a virtual network gateway to always exist.

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

not_exists

# If we expect a virtual network gateway to never exist.

describe azure_virtual_network_gateway(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do
  it { should_not exist }
end

Azure permissions

Your Service Principal must be set up with at least a reader role on the subscription you wish to test.