azure_monitor_activity_log

Use the azure_monitor_activity_log_alerts InSpec audit resource to test the properties and configuration of multiple Azure Monitor Activity Log Alerts.

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_activity_log_alerts resource block returns all activity log alerts within a resource group (if provided) or an entire subscription.

describe azure_monitor_activity_log_alerts do
  it { should exist }
end

describe azure_monitor_activity_log_alerts(resource_group: 'RESOURCE_GROUP') do
  it { should exist }
end

Parameters

resource_group (optional): The name of the resource group.

Properties

ids: A list of the unique resource IDs.
Field: id
location: A list of locations for all the resources being interrogated.
Field: location
names: A list of names of all the resources being interrogated.
Field: name
tags: A list of tag:value pairs defined on the resources being interrogated.
Field: tags
operations: A list of operations for all the resources being interrogated.
Field: operations
resource_group: Azure resource group where the targeted resource resides.
Field: resource_group

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Examples

Test that a subscription has the named activity log alert:

describe azure_monitor_activity_log_alerts do
  its('names') { should include('ExampleLogAlert') }
end

Loop through all resources with resource_id:

azure_monitor_activity_log_alerts.ids.each do |id|
  describe azure_monitor_activity_log_alert(resource_id: id) do
    it { should be_enabled }
  end
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.

# If we expect 'EXAMPLEGROUP' resource group to have activity log alerts.

describe azure_monitor_activity_log_alerts(resource_group: 'EXAMPLEGROUP') do
  it { should exist }
end

not_exists

# If we expect 'EMPTYEXAMPLEGROUP' resource group not to have activity log alerts.

describe azure_monitor_activity_log_alerts(resource_group: 'EMPTYEXAMPLEGROUP') do
  it { should_not exist }
end

Azure permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.

azure_monitor_activity_log_alerts resource