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.
The api_version
can be defined as a resource parameter.
If not provided, this resource uses the latest version.
For more information, refer to the azure_generic_resource
document.
Unless defined, this resource uses the azure_cloud
global endpoint and default values for the HTTP client.
For more information, refer to the resource pack README.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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, refer to Azure documentation for other properties available. Any attribute in the response may be accessed 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
For a full list of available matchers, see our Universal Matchers page.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.