Project: Chef InSpec (Provisioning / Security & Compliance)
File: azurerm_role_definition.md

+++ title = "azurermroledefinition resource" draft = false gh_repo = "inspec" platform = "azure" [menu] [menu.inspec] title = "azurermroledefinition" identifier = "inspec/resources/azure/azurermroledefinition.md azurermroledefinition resource" parent = "inspec/resources/azure" +++ {{< inspec/azurermdeprecated resource="azurerole_definition" >}} Use the `azurermroledefinition` InSpec audit resource to test properties of an Azure Role Definition. This resource interacts with version `2015-07-01` of the Management API. For more information see the . At the moment, there doesn't appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version. This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the following to your `inspec.yml` in your top-level profile: depends: name: inspec-azure git: https://github.com/inspec/inspec-azure.git You'll also need to setup your Azure credentials; see the resource pack . This resource first became available in 1.3.7 of the inspec-azure resource pack. The `name` of the Role must be given as a parameter. For built-in roles, such as `Owner` or `Contributor`, this role name takes the form of a UUID. For `CustomRole`'s which you have added to your subscription yourself, the Name field will be what you choose on creation of the Role. describe azurermroledefinition(name: 'some-custom-role-name') do ... end Ensure a given role has a specific permission describe azurermroledefinition(name: 'policy-reader-only') it { should exist } its('permissions_allowed') { should include 'Microsoft.Authorization/policyassignments/read'} its('permissionsallowed') { shouldnot include 'Microsoft.Authorization/policyassignments/write'} its('permissionsallowed') { shouldnot include '*'} end `id` `name` `role_name` `type` `role_type` `assignable_scopes` `permissions_allowed` `permissionsnotallowed` The object ID of the Role The name of the Role. For a built-in role this will be an Azure generated UUID. For a CustomRole this will be the name you specified on creation. The human readable name of the Role. The type of the object, e.g. `Microsoft.Authorization/roleDefinitions` `BuiltInRole` or `CustomRole` Role Assignable scopes. Provider permissions granted with this role. Provider permissions blocked with this role. There are additional attributes that may be accessed that we have not documented. Please take a look at the . Any attribute in the response may be accessed with the key names separated by dots (`.`). Given the example response in their documentation: The API may not always return keys that do not have any associated data. There may be cases where the deeply nested property may not have the desired attribute along your call chain. If you find yourself writing tests against properties that may be nil, fork this resource pack and add an accessor to the resource. Within that accessor you'll be able to guard against nil keys. Pull requests are always welcome. {{< readfile file="content/inspec/reusable/md/inspecmatcherslink.md" >}} This resource has the following special matchers. describe azurermroledefinition(name: 'some-role') do it { should exist } end Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be setup with a `contributor` role on the subscription you wish to test.