azure_resource_group.md

title	platform
About the azure_resource_group Resource	azure

azure_resource_group

Use the azure_resource_group InSpec audit resource to test 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. 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_resource_group(name: 'my_resource_group') do
  it { should exist }
end

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

Parameters

Name	Description
name	Name of the resource group. resourceGroupName
resource_id	The unique resource ID. /{subscriptionId}/resourcegroups/{resourceGroupName}

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

• resource_id
• name

Properties

Property	Description
properties.provisioningState	The provisioning state. Succeeded

For properties applicable to all resources, such as type, name, id, location, 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 a Resource Group Location

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

Test a Resource Group Provisioning State

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

Test a Resource Group Tags

describe azure_resource_group(name: 'my_resource_group') do
  its('tags') { should include(:owner) }
  its('tags') { should include(owner: 'InSpec') }
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 group to always exist
describe azure_resource_group(name: 'my_resource_group') do
  it { should exist }
end
# If we expect a resource group to never exist
describe azure_resource_group(name: 'my_resource_group') 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.