azure_role_definitions Resource
Use the azure_role_definitions
InSpec audit resource to test the properties and configuration of multiple Azure role definitions.
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
An azure_role_definitions
resource block returns all role definitions within a subscription.
describe azure_role_definitions do
it { should exist }
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
role_names
- A list of role names of all the role definitions being interrogated.
Field:
role_name
types
- A list of role type of all the role definitions being interrogated.
Field:
type
properties
- A list of properties for all the resources being interrogated.
Field:
properties
Note
Examples
Check a specific role definition is present
describe azure_role_definitions do
its('names') { should include 'my-role' }
end
Filter the results to include only those role definitions that have the specified name
describe azure_role_definitions.where{ name.include?('my-role') } do
it { should exist }
end
Filter the results to include only the built-in role definitions
describe azure_role_definitions.where{ type == "BuiltInRole" } do
it { should exist }
its('count') { should be 15 }
end
Filter the results to include only the role definitions that contain ‘Kubernetes’ in the role name
describe azure_role_definitions.where{ role_name.include?('Kubernetes') } do
it { should exist }
its('count') { should be 15 }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.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.
describe azure_role_definitions do
it { should exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.