azure_sentinel_incidents_resources Resource

[edit on GitHub]

Use the azure_sentinel_incidents_resources InSpec audit resource to test the properties of Azure Sentinel incidents for a resource group or the entire subscription.

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 is used.

For more information, refer to azure_generic_resource.

Unless defined, the azure_cloud global endpoint and default values for the HTTP client are used. 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_sentinel_incidents_resources resource block returns all Azure sentinel incidents, either within a resource group (if provided) or an entire Subscription.

describe azure_sentinel_incidents_resources(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do
  #...
end

The resource_group and workspace_name are required parameters.

Parameters

resource_group

Azure resource group where the targeted resource resides.

workspace_name

Azure Workspace Name for which Azure Sentinel incidents are being retrieved.

Properties

names

A list of the unique resource names.

Field: name

ids

A list of Azure Sentinel incident IDs.

Field: id

properties

A list of properties for the resource.

Field: properties

descriptions

A list of descriptions for each resource.

Field: description

severities

The severity of the incident.

Field: severity

statuses

The status of the incident.

Field: status

owner_emails

The email of the user the incident is assigned.

Field: owner_email

owner_userPrincipalNames

The user principal name of the user the incident is assigned.

Field: owner_userPrincipalName

owner_assignedTos

The name of the user the incident is assigned.

Field: owner_assignedTo

Examples

Tests properties of incidents in a resource group

describe azure_sentinel_incidents_resource(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') do
  it { should exist }
  its('names') { should include 'RESOURCE_NAME' }
  its('types') { should include 'Microsoft.SecurityInsights/Incidents' }
  its('titles') { should include 'TITLE' }
  its('descriptions') { should include 'DESCRIPTION_TEXT' }
  its('severities') { should include 'Informational' }
  its('statuses') { should include 'New' }
  its('owner_emails') { should include 'EMAIL_ADDRESS' }
  its('owner_userPrincipalNames') { should include 'PRINCIPAL_NAME' }
  its('owner_assignedTos') { should include 'ASSIGNED_TO_NAME' }
end

Tests if any Azure Sentinel Incident exists in a resource group

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

Tests there are not any Azure Sentinel incidents in a resource group

#Should not exist if no Azure Sentinel incidents are in the resource group.**

describe azure_sentinel_incidents_resources(resource_group: 'RESOURCE_GROUP', workspace_name: 'WORKSPACE_NAME') 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.