azure_resource_groups Resource

[edit on GitHub]

Use the azure_resource_groups InSpec audit resource to test 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. 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_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 which Include the Given 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 Certain 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 InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

The control will pass 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.