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

Installation

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

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

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:

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, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. 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

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

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