Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 4.12 KB

azure_virtual_network_gateway.md

File metadata and controls

90 lines (61 loc) · 4.12 KB
Raw
title platform
About the azure_virtual_network_gateway Resource
azure

azure_virtual_network_gateway

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. The api_version is defined as a resource parameter. If not provided, the latest version is used. For more information, refer to azure_generic_resource.

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

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 that the targeted resource resides in.

name (REQUIRED)

The unique name of the targeted resource.

Properties

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

Also, refer to 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

# If we expect 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 a minimum of reader role on the subscription you wish to test.