Skip to main content

azure_sentinel_alert_rule_template Resource

[edit on GitHub]

Use the azure_sentinel_alert_rule_template InSpec audit resource to test the properties of an Azure Sentinel alert rule template.

See the Azure alert rule templates documentation for additional information.

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

resource_group, alert_rule_template_id, and workspace_name are required parameters.

describe azure_sentinel_alert_rule_template(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', alert_rule_template_id: 'ALERT_RULE_TEMPLATE_ID') do
  #...
end

Parameters

resource_group
Azure resource group where the targeted resource resides.
workspace_name
Name for the workspace_name where you want to create your sentinel alert rule template.
alert_rule_template_id
The sentinel alert rule template name.

All the parameter sets needs be provided for a valid query:

  • resource_group
  • workspace_name
  • alert_rule_template_id

Properties

name
Name of the Azure resource to test.
id
The sentinel alert rule template type.
properties
The properties of the resource.
type
Azure resource type.
kind
The alert rule kind.
properties.severity
The severity for alerts created by this alert rule.
properties.status
The alert rule template status.
properties.triggerThreshold
The threshold triggers this alert rule.
properties.displayName
The display name for alert rule template.
properties.triggerOperator
The operation against the threshold that triggers alert rule.
properties.queryPeriod
The period (in ISO 8601 duration format) that this alert rule looks at.
properties.queryFrequency
The frequency (in ISO 8601 duration format) for this alert rule to run.

Examples

Test if properties match 

describe azure_sentinel_alert_rule_template(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', alert_rule_template_id: 'ALERT_RULE_TEMPLATE_ID') do
 its('name') { should eq 'RESOURCE_NAME' }
 its('type') { should eq 'Microsoft.SecurityInsights/AlertRuleTemplates' }
 its('kind') { should eq 'ALERT_RULE_KIND' }
 its('properties.triggerThreshold') { should eq INTEGER }
 its('properties.status') { should eq 'STATUS' }
 its('properties.displayName') { should eq 'ALERT_RULE_DISPLAY_NAME' }
 its('properties.triggerOperator') { should eq 'OPERATOR' }
 its('properties.queryPeriod') { should eq 'PERIOD' }
 its('properties.queryFrequency') { should eq 'FREQUENCY' }
 its('properties.severity') { should eq 'ALERT_SEVERITY' }
end

Test that a sentinel alert rule template exists 

describe azure_sentinel_alert_rule_template(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', alert_rule_template_id: 'ALERT_RULE_TEMPLATE_ID') do
  it { should exist }
end

Test that a sentinel alert rule template does not exist 

describe azure_sentinel_alert_rule_template(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME', alert_rule_template_id: 'ALERT_RULE_TEMPLATE_ID') 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