azure_management_groups.md

title	platform
About the azure_management_groups Resource	azure

azure_management_groups

Use the azure_management_groups InSpec audit resource to test properties and configuration of multiple Azure management 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_management_groups resource block returns management groups for the authenticated user.

describe azure_management_groups do
  #...
end

Parameters

• This resource does not require any parameters.

Properties

Property	Description	Filter Criteria*
ids	A list of the unique resource ids.	id
names	A list of names of all the resources being interrogated.	name
types	A list of types of all the resources being interrogated.	type
properties	A list of properties for all the resources being interrogated.	properties

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

Examples

Test that a Named Management Group Exist

describe azure_management_groups do
  its('names') { should include('abcd-1234') }
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.

# If we expect at least one management group to exist
describe azure_management_groups do
  it { should exist }
end

# If we expect zero matches
describe azure_management_groups do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.