AlertRuleMsSecurityIncident

Manages a Sentinel MS Security Incident Alert Rule.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", new Azure.OperationalInsights.AnalyticsWorkspaceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = "pergb2018",
        });
        var exampleAlertRuleMsSecurityIncident = new Azure.Sentinel.AlertRuleMsSecurityIncident("exampleAlertRuleMsSecurityIncident", new Azure.Sentinel.AlertRuleMsSecurityIncidentArgs
        {
            LogAnalyticsWorkspaceId = exampleAnalyticsWorkspace.Id,
            ProductFilter = "Microsoft Cloud App Security",
            DisplayName = "example rule",
            SeverityFilters = 
            {
                "High",
            },
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/operationalinsights"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/sentinel"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West Europe"),
        })
        if err != nil {
            return err
        }
        exampleAnalyticsWorkspace, err := operationalinsights.NewAnalyticsWorkspace(ctx, "exampleAnalyticsWorkspace", &operationalinsights.AnalyticsWorkspaceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            Sku:               pulumi.String("pergb2018"),
        })
        if err != nil {
            return err
        }
        _, err = sentinel.NewAlertRuleMsSecurityIncident(ctx, "exampleAlertRuleMsSecurityIncident", &sentinel.AlertRuleMsSecurityIncidentArgs{
            LogAnalyticsWorkspaceId: exampleAnalyticsWorkspace.ID(),
            ProductFilter:           pulumi.String("Microsoft Cloud App Security"),
            DisplayName:             pulumi.String("example rule"),
            SeverityFilters: pulumi.StringArray{
                pulumi.String("High"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="pergb2018")
example_alert_rule_ms_security_incident = azure.sentinel.AlertRuleMsSecurityIncident("exampleAlertRuleMsSecurityIncident",
    log_analytics_workspace_id=example_analytics_workspace.id,
    product_filter="Microsoft Cloud App Security",
    display_name="example rule",
    severity_filters=["High"])
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: "pergb2018",
});
const exampleAlertRuleMsSecurityIncident = new azure.sentinel.AlertRuleMsSecurityIncident("exampleAlertRuleMsSecurityIncident", {
    logAnalyticsWorkspaceId: exampleAnalyticsWorkspace.id,
    productFilter: "Microsoft Cloud App Security",
    displayName: "example rule",
    severityFilters: ["High"],
});

Create a AlertRuleMsSecurityIncident Resource

def AlertRuleMsSecurityIncident(resource_name, opts=None, description=None, display_name=None, enabled=None, log_analytics_workspace_id=None, name=None, product_filter=None, severity_filters=None, text_whitelists=None, __props__=None);
name string
The unique name of the resource.
args AlertRuleMsSecurityIncidentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AlertRuleMsSecurityIncidentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AlertRuleMsSecurityIncidentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

AlertRuleMsSecurityIncident Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The AlertRuleMsSecurityIncident resource accepts the following input properties:

DisplayName string

The friendly name of this Sentinel MS Security Incident Alert Rule.

LogAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace this Sentinel MS Security Incident Alert Rule belongs to. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

ProductFilter string

The Microsoft Security Service from where the alert will be generated. Possible values are Azure Active Directory Identity Protection, Azure Advanced Threat Protection, Azure Security Center, Azure Security Center for IoT and Microsoft Cloud App Security.

SeverityFilters List<string>

Only create incidents from alerts when alert severity level is contained in this list. Possible values are High, Medium, Low and Informational.

Description string

The description of this Sentinel MS Security Incident Alert Rule.

Enabled bool

Should this Sentinel MS Security Incident Alert Rule be enabled? Defaults to true.

Name string

The name which should be used for this Sentinel MS Security Incident Alert Rule. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

TextWhitelists List<string>

Only create incidents from alerts when alert name contain text in this list. No filter will happen if this field is absent.

DisplayName string

The friendly name of this Sentinel MS Security Incident Alert Rule.

LogAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace this Sentinel MS Security Incident Alert Rule belongs to. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

ProductFilter string

The Microsoft Security Service from where the alert will be generated. Possible values are Azure Active Directory Identity Protection, Azure Advanced Threat Protection, Azure Security Center, Azure Security Center for IoT and Microsoft Cloud App Security.

SeverityFilters []string

Only create incidents from alerts when alert severity level is contained in this list. Possible values are High, Medium, Low and Informational.

Description string

The description of this Sentinel MS Security Incident Alert Rule.

Enabled bool

Should this Sentinel MS Security Incident Alert Rule be enabled? Defaults to true.

Name string

The name which should be used for this Sentinel MS Security Incident Alert Rule. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

TextWhitelists []string

Only create incidents from alerts when alert name contain text in this list. No filter will happen if this field is absent.

displayName string

The friendly name of this Sentinel MS Security Incident Alert Rule.

logAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace this Sentinel MS Security Incident Alert Rule belongs to. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

productFilter string

The Microsoft Security Service from where the alert will be generated. Possible values are Azure Active Directory Identity Protection, Azure Advanced Threat Protection, Azure Security Center, Azure Security Center for IoT and Microsoft Cloud App Security.

severityFilters string[]

Only create incidents from alerts when alert severity level is contained in this list. Possible values are High, Medium, Low and Informational.

description string

The description of this Sentinel MS Security Incident Alert Rule.

enabled boolean

Should this Sentinel MS Security Incident Alert Rule be enabled? Defaults to true.

name string

The name which should be used for this Sentinel MS Security Incident Alert Rule. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

textWhitelists string[]

Only create incidents from alerts when alert name contain text in this list. No filter will happen if this field is absent.

display_name str

The friendly name of this Sentinel MS Security Incident Alert Rule.

log_analytics_workspace_id str

The ID of the Log Analytics Workspace this Sentinel MS Security Incident Alert Rule belongs to. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

product_filter str

The Microsoft Security Service from where the alert will be generated. Possible values are Azure Active Directory Identity Protection, Azure Advanced Threat Protection, Azure Security Center, Azure Security Center for IoT and Microsoft Cloud App Security.

severity_filters List[str]

Only create incidents from alerts when alert severity level is contained in this list. Possible values are High, Medium, Low and Informational.

description str

The description of this Sentinel MS Security Incident Alert Rule.

enabled bool

Should this Sentinel MS Security Incident Alert Rule be enabled? Defaults to true.

name str

The name which should be used for this Sentinel MS Security Incident Alert Rule. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

text_whitelists List[str]

Only create incidents from alerts when alert name contain text in this list. No filter will happen if this field is absent.

Outputs

All input properties are implicitly available as output properties. Additionally, the AlertRuleMsSecurityIncident resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing AlertRuleMsSecurityIncident Resource

Get an existing AlertRuleMsSecurityIncident resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

static get(resource_name, id, opts=None, description=None, display_name=None, enabled=None, log_analytics_workspace_id=None, name=None, product_filter=None, severity_filters=None, text_whitelists=None, __props__=None);
func GetAlertRuleMsSecurityIncident(ctx *Context, name string, id IDInput, state *AlertRuleMsSecurityIncidentState, opts ...ResourceOption) (*AlertRuleMsSecurityIncident, error)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string

The description of this Sentinel MS Security Incident Alert Rule.

DisplayName string

The friendly name of this Sentinel MS Security Incident Alert Rule.

Enabled bool

Should this Sentinel MS Security Incident Alert Rule be enabled? Defaults to true.

LogAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace this Sentinel MS Security Incident Alert Rule belongs to. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

Name string

The name which should be used for this Sentinel MS Security Incident Alert Rule. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

ProductFilter string

The Microsoft Security Service from where the alert will be generated. Possible values are Azure Active Directory Identity Protection, Azure Advanced Threat Protection, Azure Security Center, Azure Security Center for IoT and Microsoft Cloud App Security.

SeverityFilters List<string>

Only create incidents from alerts when alert severity level is contained in this list. Possible values are High, Medium, Low and Informational.

TextWhitelists List<string>

Only create incidents from alerts when alert name contain text in this list. No filter will happen if this field is absent.

Description string

The description of this Sentinel MS Security Incident Alert Rule.

DisplayName string

The friendly name of this Sentinel MS Security Incident Alert Rule.

Enabled bool

Should this Sentinel MS Security Incident Alert Rule be enabled? Defaults to true.

LogAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace this Sentinel MS Security Incident Alert Rule belongs to. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

Name string

The name which should be used for this Sentinel MS Security Incident Alert Rule. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

ProductFilter string

The Microsoft Security Service from where the alert will be generated. Possible values are Azure Active Directory Identity Protection, Azure Advanced Threat Protection, Azure Security Center, Azure Security Center for IoT and Microsoft Cloud App Security.

SeverityFilters []string

Only create incidents from alerts when alert severity level is contained in this list. Possible values are High, Medium, Low and Informational.

TextWhitelists []string

Only create incidents from alerts when alert name contain text in this list. No filter will happen if this field is absent.

description string

The description of this Sentinel MS Security Incident Alert Rule.

displayName string

The friendly name of this Sentinel MS Security Incident Alert Rule.

enabled boolean

Should this Sentinel MS Security Incident Alert Rule be enabled? Defaults to true.

logAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace this Sentinel MS Security Incident Alert Rule belongs to. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

name string

The name which should be used for this Sentinel MS Security Incident Alert Rule. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

productFilter string

The Microsoft Security Service from where the alert will be generated. Possible values are Azure Active Directory Identity Protection, Azure Advanced Threat Protection, Azure Security Center, Azure Security Center for IoT and Microsoft Cloud App Security.

severityFilters string[]

Only create incidents from alerts when alert severity level is contained in this list. Possible values are High, Medium, Low and Informational.

textWhitelists string[]

Only create incidents from alerts when alert name contain text in this list. No filter will happen if this field is absent.

description str

The description of this Sentinel MS Security Incident Alert Rule.

display_name str

The friendly name of this Sentinel MS Security Incident Alert Rule.

enabled bool

Should this Sentinel MS Security Incident Alert Rule be enabled? Defaults to true.

log_analytics_workspace_id str

The ID of the Log Analytics Workspace this Sentinel MS Security Incident Alert Rule belongs to. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

name str

The name which should be used for this Sentinel MS Security Incident Alert Rule. Changing this forces a new Sentinel MS Security Incident Alert Rule to be created.

product_filter str

The Microsoft Security Service from where the alert will be generated. Possible values are Azure Active Directory Identity Protection, Azure Advanced Threat Protection, Azure Security Center, Azure Security Center for IoT and Microsoft Cloud App Security.

severity_filters List[str]

Only create incidents from alerts when alert severity level is contained in this list. Possible values are High, Medium, Low and Informational.

text_whitelists List[str]

Only create incidents from alerts when alert name contain text in this list. No filter will happen if this field is absent.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.