Skip to main content

azure_virtual_network_peering Resource

Use the azure_virtual_network_peering InSpec audit resource to test properties related to a peering for 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.

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.


This resource requires either the resource_id parameter or the resource_group, vnet and name parameters.

describe azure_virtual_network_peering(resource_group: 'MyResourceGroup',vnet: 'virtual-network-name' name: 'virtual-network-peering-name') do
  it { should exist }
describe azure_virtual_network_peering(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/virtualNetworkPeerings/{virtualNetworkPeeringName}') do
  it { should exist }


Azure resource group that the targeted resource resides in. MyResourceGroup.
Name of the Azure virtual network that the virtual network peering is created in. MyVNetName.
Name of the Azure virtual network peering to test. MyVirtualNetworkPeeringName.
The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/virtualNetworkPeerings/{virtualNetworkPeeringName}.

Either one of the parameter sets can be provided for a valid query:

  • resource_id
  • resource_group, vnet and name


The peering state for the virtual network peering. its('peering_state') { should eq "Connected" }.

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 property in the response may be accessed with the key names separated by dots (.).


Ensure that the Virtual Network Peering State is Connected .

describe azure_virtual_network_peering(resource_group: 'MyResourceGroup',vnet: 'virtual-network-name' name: 'virtual-network-peering-name') do
    its('peering_state') { should eq 'Connected' }


This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.


# If a Virtual Network Peering is found it will exist

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

# Virtual Network Peerings that aren't found will not exist
describe azure_virtual_network_peering(resource_group: 'MyResourceGroup', vnet: 'MyVnetName', name: 'DoesNotExist') 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