azure_monitor_log_profiles resource

Use the azure_monitor_log_profiles InSpec audit resource to test the properties and configuration of multiple Azure Log profiles.

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

An azure_monitor_log_profiles resource block returns all Azure Log profiles within an entire subscription.

describe azure_monitor_log_profiles do
  it { should exist }
end

Parameters

This resource does not require any parameters.

Properties

ids

A list of the unique resource IDs.

Field: id

names

A list of names of all the resources being interrogated.

Field: name

properties

A list of properties for all the resources being interrogated.

Field: properties

Examples

Check if a specific Log profile is present:

describe azure_monitor_log_profiles do
  its('names')  { should include 'LOG_PROFILE' }
end

Filter the results by the ’name’ property if it includes a certain string:

describe azure_monitor_log_profiles.where{ name.include?('production') } do
  it { should exist }
end

Filter the results to include only those Log profiles that retention policy is enabled:

describe azure_monitor_log_profiles.where{ properties.dig(:retentionPolicy, :enabled) == true } do
  it { should exist }
  its('count') { should be 4 }
end

Matchers

This resource has the following special matchers.

exists

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

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