azure_resource_group Resource

[edit on GitHub]

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, 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.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

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: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}') do
  it { should exist }
end

Parameters

name

Name of the resource group. resourceGroupName.

resource_id

The unique resource ID. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}.

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, 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 set up with at least a contributor role on the subscription you wish to test.