azure_role_definition resource

Use the azure_role_definition InSpec audit resource to test the properties and configuration of an Azure role definition.

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

name or the resource_id are required parameters.

describe azure_role_definition(name: 'abcd-1234') do
  it { should exist }
end

describe azure_role_definition(resource_id: '/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}') do
  it { should exist }
end

Parameters

name

Name of the role definition.

resource_id

The unique resource ID.

Either one of the parameter sets can be provided for a valid query:

• resource_id
• name

Properties

role_name

The role name.

role_type

The role type. BuiltInRole.

assignable_scopes

Role definition assignable scopes.

permissions_allowed

A list of allowed actions within role definition permissions.

permissions_not_allowed

A list of denied actions within role definition permissions.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.). For example, properties.<attribute>.

Examples

Test allowed permissions on a role definition:

describe azure_role_definition(name: 'policy-reader-only')
  it { should exist }
  its('permissions_allowed') { should include 'Microsoft.Authorization/policyassignments/read'}
  its('permissions_allowed') { should_not include 'Microsoft.Authorization/policyassignments/write'}
  its('permissions_allowed') { should_not include '*'}
end

Matchers

This resource has the following special matchers.

exists

# If we expect a resource to always exist.

describe azure_role_definition(name: 'abcd-1234') do
  it { should exist }
end

not_exists

# If we expect a resource to never exist.

describe azure_role_definition(name: 'abcd-1234') 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.