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.
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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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
Note
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
For a full list of available matchers, see our Universal Matchers page.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.