azure_virtual_network_peering resource

Use the azure_virtual_network_peering InSpec audit resource to test the properties related to 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. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

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

describe azure_virtual_network_peering(resource_group: 'RESOURCE_GROUP',vnet: 'VIRTUAL-NETWORK-NAME' name: 'VIRTUAL-NETWORK-PEERING-NAME') do
  it { should exist }
end

describe azure_virtual_network_peering(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnName}/virtualNetworkPeerings/{virtualNetworkPeeringName}') do
  it { should exist }
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

vnet

Name of the Azure virtual network where the virtual network peering is created.

name

Name of the Azure virtual network peering to test.

resource_id

The unique resource ID.

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

• resource_id
• resource_group, vnet and name

Properties

peering_state

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

Also, see the Azure documentation for other available properties. Any property in the response may be accessed with the key names separated by dots (.).

Examples

Ensure that the Virtual Network Peering state is connected:

describe azure_virtual_network_peering(resource_group: 'RESOURCE_GROUP',vnet: 'VIRTUAL-NETWORK-NAME' name: 'VIRTUAL-NETWORK-PEERING-NAME') do
    its('peering_state') { should eq 'Connected' }
end

Matchers

This resource has the following special matchers.

exists

# If a Virtual Network Peering is found, it will exist.

describe azure_virtual_network_peering(resource_group: 'RESOURCE_GROUP',vnet: 'VIRTUAL-NETWORK-NAME' name: 'VIRTUAL-NETWORK-PEERING-NAME') do
  it { should exist }
end

not_exists

# Virtual Network Peerings that are not found, will not exist.

describe azure_virtual_network_peering(resource_group: 'RESOURCE_GROUP',vnet: 'VIRTUAL-NETWORK-NAME' name: 'VIRTUAL-NETWORK-PEERING-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.