azure_resource_groups resource

Use the azure_resource_groups InSpec audit resource to test the properties and configuration of multiple Azure resource groups.

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

An azure_resource_groups resource block returns all resource groups within a subscription.

describe azure_resource_groups do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

ids

A list of the unique resource group IDs.

Field: id

names

A list of names of all the resource groups.

Field: name

tags

A list of tag:value pairs defined on the resource groups.

Field: tags

locations

A list of locations of all the resource groups.

Field: location

Examples

Check if a specific resource group is present:

describe azure_resource_groups do
  its('names')  { should include 'my-resource-group' }
end

Filters the results to include only those resource groups that have the specified name:

describe azure_resource_groups.where{ name.include?('my-resource-group') } do
  it { should exist }
end

Filters the results to include only the resource groups that have specified tag:

describe azure_resource_groups.where{ tags.has_key?('owner') && tags['owner'] == "InSpec" } do
  it { should exist }
  its('count') { should be 15 }
end

Matchers

This resource has the following special matchers.

exists

The control passes if the filter returns at least one result. Use should_not if you expect zero matches.

describe azure_resource_groups do
  it { should exist }
end

Azure permissions

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