Skip to main content

azure_monitor_activity_log_alert Resource

[edit on GitHub]

Use the azure_monitor_activity_log_alert InSpec audit resource to test properties of an Azure Monitor Activity Log Alert.

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_activity_log_alert resource block identifies an Azure Monitor Activity Log Alert by name and resource_group or the resource_id.

describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do
  it { should exist }
end

describe azure_monitor_activity_log_alert(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/activityLogAlerts/{activityLogAlertName}') do
  it { should exist }
end

Parameters

resource_group
Azure resource group that the targeted resource resides in. MyResourceGroup.
name
Name of the Activity Log Alert to test. AlertName.
resource_id
The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/activityLogAlerts/{activityLogAlertName}.

Either one of the parameter sets can be provided for a valid query:

  • resource_id
  • resource_group and name

Properties

operations
The list of operations. ['Microsoft.Authorization/policyAssignments/write'].
conditions
The list of activity log alert conditions that will cause this alert to activate.
scopes
A list of resource id prefixes. The alert will only apply to activityLogs with resource ids that fall under one of these prefixes.
enabled?
Indicates whether this activity log alert is enabled. true or false.

For properties applicable to all resources, such as type, name, id, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.), eg. properties.<attribute>.

Examples

Test an Activity Log Alert Has the Correct Operation.

describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do
  its('operations') { should include 'Microsoft.Authorization/policyAssignments/write' }
end

Test the Scope of an Activity Log Alert.

describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do
  its('scopes') { should include 'subscriptions/{SUBSCRIPTION_ID}' }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

enabled

Test if a resource is enabled. If an activity log alert is not enabled, then none of its actions will be activated.

describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do
  it { should be_enabled }
end

exists

# If we expect a resource to always exist

describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') do
  it { should exist }
end

# If we expect a resource to never exist

describe azure_monitor_activity_log_alert(resource_group: 'example', name: 'AlertName') 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.

Was this page helpful?

×









Search Results