azure_management_groups resource

Use the azure_management_groups InSpec audit resource to test the 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. 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_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

ids

A list of the unique resource IDs.

Field: id

names

A list of names of all the resources being interrogated.

Field: name

types

A list of types of all the resources being interrogated.

Field: type

properties

A list of properties for all the resources being interrogated.

Field: properties

Examples

Test that a named Management Group exists:

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

# If we expect at least one management group to exist.

describe azure_management_groups do
  it { should exist }
end

not_exists

# If we expect zero matches.

describe azure_management_groups do
  it { should_not exist }
end

Azure permissions

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