azure_resource_group resource

Use the azure_resource_group InSpec audit resource to test the properties and configuration of an Azure resource group.

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_resource_group(name: 'RESOURCE_GROUP') do
  it { should exist }
end

describe azure_resource_group(resource_id: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}') do
  it { should exist }
end

Parameters

name

Name of the resource group.

resource_id

The unique resource ID.

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

• resource_id
• name

Properties

properties.provisioningState

The provisioning state. Succeeded.

For properties applicable to all resources, such as type, name, id, location, 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 a resource group location:

describe azure_resource_group(name: 'RESOURCE_GROUP') do
  its('location') { should cmp 'eastus' }
end

Test a resource group provisioning state:

describe azure_resource_group(name: 'RESOURCE_GROUP') do
  its('properties.provisioningState') { should cmp 'Succeeded' }
end

Test a resource group tags:

describe azure_resource_group(name: 'RESOURCE_GROUP') do
  its('tags') { should include(:owner) }
  its('tags') { should include(owner: 'InSpec') }
end

Matchers

This resource has the following special matchers.

exists

# If we expect a resource group to always exist.

describe azure_resource_group(name: 'RESOURCE_GROUP') do
  it { should exist }
end

not_exists

# If we expect a resource group to never exist.

describe azure_resource_group(name: 'RESOURCE_GROUP') 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.