azure_express_route_circuits resource

Use the azure_express_route_circuits InSpec audit resource to test the properties of Azure ExpressRoute circuits for a resource group.

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, 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 is used. For more information, refer to the resource pack README.

Syntax

An azure_express_route_circuits resource block returns all Azure ExpressRoute circuits within a resource group.

describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do
  #...
end

Parameters

resource_group

The Azure resource group where the targeted resources resides.

Properties

names

A list of name the resource group in which to create the ExpressRoute circuit.

Field: name

ids

A list of the ExpressRoute circuit IDs.

Field: id

tags

A list of tag:value pairs of the ExpressRoute circuit resources.

Field: tags

provisioning_states

The provisioning states of the ExpressRoute circuit resources.

Field: provisioning_state

types

The types of all the ExpressRoute circuit resources.

Field: type

locations

The locations of the ExpressRoute circuit resources.

Field: location

service_provider_bandwidth_in_mbps

A list of the bandwidths in Mbps of the circuits when a circuit is provisioned on an ExpressRoutePort resource.

Field: service_provider_bandwidth_in_mbps

service_provider_peering_locations

A list of The name of the peering location and not the Azure resource location.

Field: service_provider_peering_location

service_provider_names

The name of the ExpressRoute Service Provider.

Field: service_provider_name

service_keys

The ServiceKeys of the ExpressRoute circuit resources.

Field: service_key

stags

The identifiers of the circuit traffic. Outer tag for QinQ encapsulation.

Field: stag

global_reach_enabled

A list of the ExpressRoute circuit that denotes global reach enable status.

Field: global_reach_enabled

gateway_manager_etags

A list of the GatewayManager Etags in the ExpressRoute circuit resources.

Field: gateway_manager_etag

allow_classic_operations

A list of indicating whether Allow Classic Operations in the ExpressRoute circuit resources is set to true or false.

Field: allow_classic_operation

circuit_provisioning_states

A list of State of express circuitHostName creation. Valid values are Enabled or Disabled.

Field: circuit_provisioning_state

sku_names

A list of the SKU names of the ExpressRoute circuits.

Field: sku_name

sku_tiers

A list of the SKU tiers of the ExpressRoute circuits. Possible values are Basic, Local, Standard, or Premium.

Field: sku_tier

sku_family

A list of the SKU families of the ExpressRoute circuits. Possible values are: UnlimitedData and MeteredData.

Field: sku_family

Also, see the Azure documentation for other available properties.

Examples

Ensure that an ExpressRoute circuit has a ‘Succeeded’ provisioning state:

describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do
  its('provisioning_states') { should include 'Succeeded' }
end

Test than an ExpressRoute circuit has a specific location:

describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do
  its('location') { should include 'EXPRESS_ROUTE_CIRCUIT_LOCATION' }
end

Matchers

This resource has the following special matchers.

exists

# Should  exist if express_route_circuits are in the resource group.

describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') do
  it { should exist }
end

not_exists

# Should not exist if no express_route_circuits are in the resource group

describe azure_express_route_circuits(resource_group: 'RESOURCE_GROUP') 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.