azure_express_route_providers Resource

[edit on GitHub]

Use the azure_express_route_providers InSpec audit resource to test properties related to azure_express_route for a resource group or the entire subscription.

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

An azure_express_route_providers resource block returns all Azure azure_express_route, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_express_route_providers do
  #...
end

or

describe azure_express_route_providers(resource_group: 'my-rg') do
  #...
end

Parameters

resource_group (optional)

The name of the resource group.

Properties

names

A list of the unique resource ids.

Field: name

types

A list of all the azure_express_route.

Field: type

ids

A list of id for all the azure_express_route.

Field: id

tags

A list of all the express_route names.

Field: tag

provisioning_states

A list of status of request.

Field: provisioning_state

peering_locations_list

A list of peering locations pairs defined on the resources.

Field: locations

bandwidths_offered_list

A list of bandwidths offered pairs defined on the resources.

Field: bandwidths

Examples

Test If Any azure_express_route Exist in the Resource Group.

describe azure_express_route_providers(resource_group: 'MyResourceGroup') do
  it { should exist }
end
describe azure_express_route_providers do
  it { should exist }
end

Test that There are express_route that Includes a Certain String in their Names (Server Side Filtering via Generic Resource - Recommended) .

describe azure_generic_resources(resource_group: 'MyResourceGroup') 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.

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

describe azure_express_route_providers(resource_group: 'MyResourceGroup') do
  its('provisioning_states') { should include('Succeeded') }
  its('peering_locations_list') { should include(["Melbourne", "Sydney"]) }
  its('bandwidths_offered_list') { should include('bandwidths_offered') }
end

Azure Permissions

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