azure_policy_definitions Resource

[edit on GitHub]

Use the azure_policy_definitions InSpec audit resource to test properties and configuration of multiple Azure policy 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.

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

An azure_policy_definitions resource block returns all policy definitions, either built-in (if built_in_only: true), or within a subscription.

describe azure_policy_definitions do
  it { should exist }
end

or

describe azure_policy_definitions(built_in_only: true) do
  it { should exist }
end

Parameters

built_in_only (optional)

Indicates whether the interrogated policy definitions are built-in only. Defaults to false if not supplied.

Properties

ids

A list of the unique resource ids.

Field: id

names

A list of names of all the resources being interrogated.

Field: name

policy_types

A list of policy types of all the resources.

Field: policy_type

modes

A list of modes of all the resources.

Field: mode

metadata_versions

A list of metadata versions of the resources.

Field: metadata_version

metadata_categories

A list of metadata categories of the resources.

Field: metadata_category

parameters

A list of parameters of the resources.

Field: parameters

policy_rules

A list of policy rules of the resources.

Field: policy_rule

properties

A list of properties for all the resources being interrogated.

Field: properties

Examples

Check a Specific Policy Definition is Present.

describe azure_policy_definitions do
  its('names')  { should include 'my-policy' }
end

Filters the Results to Include Only Those Policy Definitions which Include the Given Name.

describe azure_policy_definitions.where{ name.include?('my-policy') } do
  it { should exist }
end

Filters the Results to Include Only The Custom Policy Definitions.

describe azure_policy_definitions.where(policy_type: "Custom") do
  it { should exist }
  its('count') { should be 15 }
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

The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.

describe azure_policy_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.