azure_virtual_network_gateway_connection resource

Use the azure_virtual_network_gateway_connection InSpec audit resource to test the properties related to an Azure Virtual Network Gateway connection.

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_network_gateway_connection(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do
  it  { should exist }
end

Parameters

name

Name of the Azure Virtual Network Gateway connection to test.

resource_group

Azure resource group name where the targeted resource resides.

The parameter set should be provided for a valid query is resource_group and name.

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 network gateway resource.

properties.connectionType

Gateway connection type.

properties.useLocalAzureIpAddresses

Use private local Azure IP for the connection.

properties.ipsecPolicies

The IPSec Policies to be considered by this connection.

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 that the Virtual Network Gateway connection protocol is IKEv1:

describe azure_virtual_network_gateway_connection(resource_group: 'RESOURCE_GROUP', name: 'VIRTUAL_NETWORK_NAME') do
  its('connectionProtocol') { should eq 'IKEv1' }
end

Matchers

exists

# If a Virtual Network Gateway connection is found, it will exist.

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

not_exists

# If Virtual Network Gateway connection is not found, it will not exist.

describe azure_virtual_network_gateway_connection(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.