azure_virtual_network_peerings Resource

[edit on GitHub]

Use the azure_virtual_network_peerings InSpec audit resource to test properties related to virtual network peerings of a virtual network.

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

resource_group and vnet are required parameters.

describe azure_virtual_network_peerings(resource_group: 'MyResourceGroup', vnet: 'virtual-network-name') do
  #...
end

Parameters

resource_group

Azure resource group that the targeted resource resides in. MyResourceGroup.

vnet

The virtual network that the network peering that you wish to test is a part of.

Properties

ids

A list of the unique resource ids.

Field: id

names

A list of all the resources being interrogated.

Field: name

etags

A list of etags defined on the resources.

Field: etag

Examples

Exists if Any Virtual Network Peerings Exist for a Given Virtual Network in the Resource Group.

describe azure_virtual_network_peerings(resource_group: 'MyResourceGroup', vnet: 'virtual-network-name') do
  it { should exist }
end

Filters the Results to Only Those that Match the Given Name.

describe azure_virtual_network_peerings(resource_group: 'MyResourceGroup', vnet: 'virtual-network-name') do
  .where(name: 'MyVirtualNetworkPeering') 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 peerings are in the virtual network

describe azure_virtual_network_peerings(resource_group: 'MyResourceGroup', vnet: 'virtual-network-name') do
  it { should_not exist }
end

Azure Permissions

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