Skip to main content

azure_virtual_network_peerings Resource

Use the azure_virtual_network_peerings InSpec audit resource to test the 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.


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

For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.


resource_group and vnet are required parameters.

describe azure_virtual_network_peerings(resource_group: 'RESOURCE_GROUP', vnet: 'VIRTUAL-NETWORK-NAME') do


Azure resource group where the targeted resource resides.
The virtual network where the network PEERING you wish to test is part.


A list of the unique resource IDs.

Field: id

A list of all the resources being interrogated.

Field: name

A list of etags defined on the resources.

Field: etag


For information on using filter criteria on plural resources, see the documentation on FilterTable


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 }

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

describe azure_virtual_network_peerings(resource_group: 'RESOURCE_GROUP', vnet: 'VIRTUAL-NETWORK-NAME') do
  .where(name: 'MyVirtualNetworkPeering') do
  it { should exist }


For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.


# Should not exist if no virtual network peerings are in the virtual network.

describe azure_virtual_network_peerings(resource_group: 'RESOURCE_GROUP', vnet: 'VIRTUAL-NETWORK-NAME') do
  it { should_not exist }

Azure Permissions

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

Edit this page on GitHub

Thank you for your feedback!


Search Results