azure_resource_groups.md

title	platform
About the azure_resource_groups Resource	azure

azure_resource_groups

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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to 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

• None required.

Properties

Property	Description	Filter Criteria*
ids	A list of the unique resource group ids.	id
names	A list of names of all the resource groups.	name
tags	A list of tag:value pairs defined on the resource groups.	tags
locations	A list of locations of all the resource groups.	location

* For information on how to use filter criteria on plural resources refer to FilterTable usage.

Examples

Check 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 setup with a contributor role on the subscription you wish to test.