azure_monitor_log_profiles.md

title	platform
About the azure_monitor_log_profiles Resource	azure

azure_monitor_log_profiles

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

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

Property	Description	Filter Criteria*
ids	A list of the unique resource ids.	id
names	A list of names of all the resources being interrogated.	name
properties	A list of properties for all the resources being interrogated.	properties

* For information on how to use filter criteria on plural resources refer to FilterTable usage.

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 setup with a contributor role on the subscription you wish to test.