azure_monitor_log_profiles Resource

[edit on GitHub]

Use the azure_monitor_log_profiles InSpec audit resource to test 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. 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_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 'my_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 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_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.