azure_virtual_network_gateway_connections Resource

[edit on GitHub]

Use the azure_virtual_network_gateway_connections InSpec audit resource to test the properties related to all Azure Virtual Network Gateway connections within a project.

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

An azure_virtual_network_gateway_connections resource block returns all Azure Virtual Network Gateway connections within a project.

describe azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP') do
  #...
end

Parameters

resource_group

Azure resource group name where the targeted resource resides.

The parameter set should be provided for a valid query:

• resource_group

Properties

ids

A list of resource IDs.

Field: id

names

A list of resource names.

Field: name

types

A list of types.

Field: type

eTags

A list of eTags.

Field: eTag

locations

A list of all locations.

Field: location

properties

A list of Properties for all the virtual network gateway connections.

Field: properties

provisioningStates

A list of provisioning states.

Field: provisioningState

connectionTypes

A list of gateway connection types.

Field: connectionType

connectionProtocols

A list of connection protocols used for this connection.

Field: connectionProtocol

useLocalAzureIpAddresses

A list of private local Azure IPs for the connection.

Field: datacenterManagementServerName

ipsecPolicies

A list of all The IPSec Policies to be considered by this connection.

Field: ipsecPolicies

* For information on how to use filter criteria on plural resources refer to FilterTable usage. Also, refer to Azure documentation for other properties available.

Examples

Loop through Virtual Network Gateway connection by their names.

azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP').names.each do |name|
  describe azure_virtual_network_gateway_connection(resource_group: 'RESOURCE_GROUP', name: name) do
    it { should exist }
  end
end

Test that there are Virtual Network Gateway connection with IPsec type .

describe azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP').where(connectionType: 'VPN_CONNECTION_TYPE') do
  it { should exist }
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

# Should not exist if no Virtual Network Gateway Connection are present in the project and in the resource group

describe azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP') do
  it { should_not exist }
end

# Should exist if the filter returns at least one Virtual Network Gateway Connection in the project and in the resource group

describe azure_virtual_network_gateway_connections(resource_group: 'RESOURCE_GROUP') do
  it { should exist }
end

Azure Permissions

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