azure_role_definition.md

title	platform
About the azure_role_definition Resource	azure

azure_role_definition

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

name or the resource_id must be given as a parameter.

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	Description
name	Name of the role definition. roleDefinitionName
resource_id	The unique resource ID. /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}

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

• resource_id
• name

Properties

Property	Description
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, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.), eg. 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 InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

# If we expect a resource to always exist
describe azure_role_definition(name: 'abcd-1234') do
  it { should exist }
end
# 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 setup with a contributor role on the subscription you wish to test.