1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. sentinel
  5. AutomationRule
azure logo
Azure Classic v5.38.0, Mar 21 23

azure.sentinel.AutomationRule

Manages a Sentinel Automation Rule.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "west europe",
    });

    var exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("exampleAnalyticsWorkspace", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = "PerGB2018",
    });

    var sentinel = new Azure.OperationalInsights.AnalyticsSolution("sentinel", new()
    {
        SolutionName = "SecurityInsights",
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        WorkspaceResourceId = exampleAnalyticsWorkspace.Id,
        WorkspaceName = exampleAnalyticsWorkspace.Name,
        Plan = new Azure.OperationalInsights.Inputs.AnalyticsSolutionPlanArgs
        {
            Publisher = "Microsoft",
            Product = "OMSGallery/SecurityInsights",
        },
    });

    var exampleAutomationRule = new Azure.Sentinel.AutomationRule("exampleAutomationRule", new()
    {
        LogAnalyticsWorkspaceId = sentinel.WorkspaceResourceId,
        DisplayName = "automation_rule1",
        Order = 1,
        ActionIncidents = new[]
        {
            new Azure.Sentinel.Inputs.AutomationRuleActionIncidentArgs
            {
                Order = 1,
                Status = "Active",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/operationalinsights"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/sentinel"
	"github.com/pulumi/pulumi/sdk/v3/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
		}
		sentinel, err := operationalinsights.NewAnalyticsSolution(ctx, "sentinel", &operationalinsights.AnalyticsSolutionArgs{
			SolutionName:        pulumi.String("SecurityInsights"),
			Location:            exampleResourceGroup.Location,
			ResourceGroupName:   exampleResourceGroup.Name,
			WorkspaceResourceId: exampleAnalyticsWorkspace.ID(),
			WorkspaceName:       exampleAnalyticsWorkspace.Name,
			Plan: &operationalinsights.AnalyticsSolutionPlanArgs{
				Publisher: pulumi.String("Microsoft"),
				Product:   pulumi.String("OMSGallery/SecurityInsights"),
			},
		})
		if err != nil {
			return err
		}
		_, err = sentinel.NewAutomationRule(ctx, "exampleAutomationRule", &sentinel.AutomationRuleArgs{
			LogAnalyticsWorkspaceId: sentinel.WorkspaceResourceId,
			DisplayName:             pulumi.String("automation_rule1"),
			Order:                   pulumi.Int(1),
			ActionIncidents: sentinel.AutomationRuleActionIncidentArray{
				&sentinel.AutomationRuleActionIncidentArgs{
					Order:  pulumi.Int(1),
					Status: pulumi.String("Active"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspace;
import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
import com.pulumi.azure.operationalinsights.AnalyticsSolution;
import com.pulumi.azure.operationalinsights.AnalyticsSolutionArgs;
import com.pulumi.azure.operationalinsights.inputs.AnalyticsSolutionPlanArgs;
import com.pulumi.azure.sentinel.AutomationRule;
import com.pulumi.azure.sentinel.AutomationRuleArgs;
import com.pulumi.azure.sentinel.inputs.AutomationRuleActionIncidentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("west europe")
            .build());

        var exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku("PerGB2018")
            .build());

        var sentinel = new AnalyticsSolution("sentinel", AnalyticsSolutionArgs.builder()        
            .solutionName("SecurityInsights")
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .workspaceResourceId(exampleAnalyticsWorkspace.id())
            .workspaceName(exampleAnalyticsWorkspace.name())
            .plan(AnalyticsSolutionPlanArgs.builder()
                .publisher("Microsoft")
                .product("OMSGallery/SecurityInsights")
                .build())
            .build());

        var exampleAutomationRule = new AutomationRule("exampleAutomationRule", AutomationRuleArgs.builder()        
            .logAnalyticsWorkspaceId(sentinel.workspaceResourceId())
            .displayName("automation_rule1")
            .order(1)
            .actionIncidents(AutomationRuleActionIncidentArgs.builder()
                .order(1)
                .status("Active")
                .build())
            .build());

    }
}

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")
sentinel = azure.operationalinsights.AnalyticsSolution("sentinel",
    solution_name="SecurityInsights",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    workspace_resource_id=example_analytics_workspace.id,
    workspace_name=example_analytics_workspace.name,
    plan=azure.operationalinsights.AnalyticsSolutionPlanArgs(
        publisher="Microsoft",
        product="OMSGallery/SecurityInsights",
    ))
example_automation_rule = azure.sentinel.AutomationRule("exampleAutomationRule",
    log_analytics_workspace_id=sentinel.workspace_resource_id,
    display_name="automation_rule1",
    order=1,
    action_incidents=[azure.sentinel.AutomationRuleActionIncidentArgs(
        order=1,
        status="Active",
    )])

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 sentinel = new azure.operationalinsights.AnalyticsSolution("sentinel", {
    solutionName: "SecurityInsights",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    workspaceResourceId: exampleAnalyticsWorkspace.id,
    workspaceName: exampleAnalyticsWorkspace.name,
    plan: {
        publisher: "Microsoft",
        product: "OMSGallery/SecurityInsights",
    },
});
const exampleAutomationRule = new azure.sentinel.AutomationRule("exampleAutomationRule", {
    logAnalyticsWorkspaceId: sentinel.workspaceResourceId,
    displayName: "automation_rule1",
    order: 1,
    actionIncidents: [{
        order: 1,
        status: "Active",
    }],
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: west europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: PerGB2018
  sentinel:
    type: azure:operationalinsights:AnalyticsSolution
    properties:
      solutionName: SecurityInsights
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      workspaceResourceId: ${exampleAnalyticsWorkspace.id}
      workspaceName: ${exampleAnalyticsWorkspace.name}
      plan:
        publisher: Microsoft
        product: OMSGallery/SecurityInsights
  exampleAutomationRule:
    type: azure:sentinel:AutomationRule
    properties:
      logAnalyticsWorkspaceId: ${sentinel.workspaceResourceId}
      displayName: automation_rule1
      order: 1
      actionIncidents:
        - order: 1
          status: Active

Create AutomationRule Resource

new AutomationRule(name: string, args: AutomationRuleArgs, opts?: CustomResourceOptions);
@overload
def AutomationRule(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   action_incidents: Optional[Sequence[AutomationRuleActionIncidentArgs]] = None,
                   action_playbooks: Optional[Sequence[AutomationRuleActionPlaybookArgs]] = None,
                   condition_json: Optional[str] = None,
                   conditions: Optional[Sequence[AutomationRuleConditionArgs]] = None,
                   display_name: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   expiration: Optional[str] = None,
                   log_analytics_workspace_id: Optional[str] = None,
                   name: Optional[str] = None,
                   order: Optional[int] = None,
                   triggers_on: Optional[str] = None,
                   triggers_when: Optional[str] = None)
@overload
def AutomationRule(resource_name: str,
                   args: AutomationRuleArgs,
                   opts: Optional[ResourceOptions] = None)
func NewAutomationRule(ctx *Context, name string, args AutomationRuleArgs, opts ...ResourceOption) (*AutomationRule, error)
public AutomationRule(string name, AutomationRuleArgs args, CustomResourceOptions? opts = null)
public AutomationRule(String name, AutomationRuleArgs args)
public AutomationRule(String name, AutomationRuleArgs args, CustomResourceOptions options)

type: azure:sentinel:AutomationRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AutomationRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AutomationRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AutomationRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AutomationRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AutomationRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AutomationRule Resource Properties

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

Inputs

The AutomationRule resource accepts the following input properties:

DisplayName string

The display name which should be used for this Sentinel Automation Rule.

LogAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

Order int

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

ActionIncidents List<AutomationRuleActionIncidentArgs>

One or more action_incident blocks as defined below.

ActionPlaybooks List<AutomationRuleActionPlaybookArgs>

One or more action_playbook blocks as defined below.

ConditionJson string

A JSON array of one or more condition JSON objects as is defined here.

Conditions List<AutomationRuleConditionArgs>

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

Enabled bool

Whether this Sentinel Automation Rule is enabled? Defaults to true.

Expiration string

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

Name string

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

TriggersOn string

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

TriggersWhen string

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

DisplayName string

The display name which should be used for this Sentinel Automation Rule.

LogAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

Order int

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

ActionIncidents []AutomationRuleActionIncidentArgs

One or more action_incident blocks as defined below.

ActionPlaybooks []AutomationRuleActionPlaybookArgs

One or more action_playbook blocks as defined below.

ConditionJson string

A JSON array of one or more condition JSON objects as is defined here.

Conditions []AutomationRuleConditionArgs

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

Enabled bool

Whether this Sentinel Automation Rule is enabled? Defaults to true.

Expiration string

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

Name string

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

TriggersOn string

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

TriggersWhen string

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

displayName String

The display name which should be used for this Sentinel Automation Rule.

logAnalyticsWorkspaceId String

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

order Integer

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

actionIncidents List<AutomationRuleActionIncidentArgs>

One or more action_incident blocks as defined below.

actionPlaybooks List<AutomationRuleActionPlaybookArgs>

One or more action_playbook blocks as defined below.

conditionJson String

A JSON array of one or more condition JSON objects as is defined here.

conditions List<AutomationRuleConditionArgs>

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

enabled Boolean

Whether this Sentinel Automation Rule is enabled? Defaults to true.

expiration String

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

name String

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

triggersOn String

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

triggersWhen String

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

displayName string

The display name which should be used for this Sentinel Automation Rule.

logAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

order number

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

actionIncidents AutomationRuleActionIncidentArgs[]

One or more action_incident blocks as defined below.

actionPlaybooks AutomationRuleActionPlaybookArgs[]

One or more action_playbook blocks as defined below.

conditionJson string

A JSON array of one or more condition JSON objects as is defined here.

conditions AutomationRuleConditionArgs[]

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

enabled boolean

Whether this Sentinel Automation Rule is enabled? Defaults to true.

expiration string

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

name string

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

triggersOn string

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

triggersWhen string

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

display_name str

The display name which should be used for this Sentinel Automation Rule.

log_analytics_workspace_id str

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

order int

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

action_incidents Sequence[AutomationRuleActionIncidentArgs]

One or more action_incident blocks as defined below.

action_playbooks Sequence[AutomationRuleActionPlaybookArgs]

One or more action_playbook blocks as defined below.

condition_json str

A JSON array of one or more condition JSON objects as is defined here.

conditions Sequence[AutomationRuleConditionArgs]

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

enabled bool

Whether this Sentinel Automation Rule is enabled? Defaults to true.

expiration str

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

name str

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

triggers_on str

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

triggers_when str

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

displayName String

The display name which should be used for this Sentinel Automation Rule.

logAnalyticsWorkspaceId String

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

order Number

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

actionIncidents List<Property Map>

One or more action_incident blocks as defined below.

actionPlaybooks List<Property Map>

One or more action_playbook blocks as defined below.

conditionJson String

A JSON array of one or more condition JSON objects as is defined here.

conditions List<Property Map>

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

enabled Boolean

Whether this Sentinel Automation Rule is enabled? Defaults to true.

expiration String

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

name String

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

triggersOn String

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

triggersWhen String

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

Outputs

All input properties are implicitly available as output properties. Additionally, the AutomationRule 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 string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing AutomationRule Resource

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

public static get(name: string, id: Input<ID>, state?: AutomationRuleState, opts?: CustomResourceOptions): AutomationRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_incidents: Optional[Sequence[AutomationRuleActionIncidentArgs]] = None,
        action_playbooks: Optional[Sequence[AutomationRuleActionPlaybookArgs]] = None,
        condition_json: Optional[str] = None,
        conditions: Optional[Sequence[AutomationRuleConditionArgs]] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        expiration: Optional[str] = None,
        log_analytics_workspace_id: Optional[str] = None,
        name: Optional[str] = None,
        order: Optional[int] = None,
        triggers_on: Optional[str] = None,
        triggers_when: Optional[str] = None) -> AutomationRule
func GetAutomationRule(ctx *Context, name string, id IDInput, state *AutomationRuleState, opts ...ResourceOption) (*AutomationRule, error)
public static AutomationRule Get(string name, Input<string> id, AutomationRuleState? state, CustomResourceOptions? opts = null)
public static AutomationRule get(String name, Output<String> id, AutomationRuleState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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:
ActionIncidents List<AutomationRuleActionIncidentArgs>

One or more action_incident blocks as defined below.

ActionPlaybooks List<AutomationRuleActionPlaybookArgs>

One or more action_playbook blocks as defined below.

ConditionJson string

A JSON array of one or more condition JSON objects as is defined here.

Conditions List<AutomationRuleConditionArgs>

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

DisplayName string

The display name which should be used for this Sentinel Automation Rule.

Enabled bool

Whether this Sentinel Automation Rule is enabled? Defaults to true.

Expiration string

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

LogAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

Name string

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

Order int

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

TriggersOn string

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

TriggersWhen string

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

ActionIncidents []AutomationRuleActionIncidentArgs

One or more action_incident blocks as defined below.

ActionPlaybooks []AutomationRuleActionPlaybookArgs

One or more action_playbook blocks as defined below.

ConditionJson string

A JSON array of one or more condition JSON objects as is defined here.

Conditions []AutomationRuleConditionArgs

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

DisplayName string

The display name which should be used for this Sentinel Automation Rule.

Enabled bool

Whether this Sentinel Automation Rule is enabled? Defaults to true.

Expiration string

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

LogAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

Name string

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

Order int

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

TriggersOn string

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

TriggersWhen string

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

actionIncidents List<AutomationRuleActionIncidentArgs>

One or more action_incident blocks as defined below.

actionPlaybooks List<AutomationRuleActionPlaybookArgs>

One or more action_playbook blocks as defined below.

conditionJson String

A JSON array of one or more condition JSON objects as is defined here.

conditions List<AutomationRuleConditionArgs>

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

displayName String

The display name which should be used for this Sentinel Automation Rule.

enabled Boolean

Whether this Sentinel Automation Rule is enabled? Defaults to true.

expiration String

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

logAnalyticsWorkspaceId String

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

name String

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

order Integer

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

triggersOn String

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

triggersWhen String

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

actionIncidents AutomationRuleActionIncidentArgs[]

One or more action_incident blocks as defined below.

actionPlaybooks AutomationRuleActionPlaybookArgs[]

One or more action_playbook blocks as defined below.

conditionJson string

A JSON array of one or more condition JSON objects as is defined here.

conditions AutomationRuleConditionArgs[]

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

displayName string

The display name which should be used for this Sentinel Automation Rule.

enabled boolean

Whether this Sentinel Automation Rule is enabled? Defaults to true.

expiration string

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

logAnalyticsWorkspaceId string

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

name string

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

order number

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

triggersOn string

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

triggersWhen string

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

action_incidents Sequence[AutomationRuleActionIncidentArgs]

One or more action_incident blocks as defined below.

action_playbooks Sequence[AutomationRuleActionPlaybookArgs]

One or more action_playbook blocks as defined below.

condition_json str

A JSON array of one or more condition JSON objects as is defined here.

conditions Sequence[AutomationRuleConditionArgs]

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

display_name str

The display name which should be used for this Sentinel Automation Rule.

enabled bool

Whether this Sentinel Automation Rule is enabled? Defaults to true.

expiration str

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

log_analytics_workspace_id str

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

name str

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

order int

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

triggers_on str

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

triggers_when str

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

actionIncidents List<Property Map>

One or more action_incident blocks as defined below.

actionPlaybooks List<Property Map>

One or more action_playbook blocks as defined below.

conditionJson String

A JSON array of one or more condition JSON objects as is defined here.

conditions List<Property Map>

One or more condition blocks as defined below.

Deprecated:

This is deprecated in favor of condition_json

displayName String

The display name which should be used for this Sentinel Automation Rule.

enabled Boolean

Whether this Sentinel Automation Rule is enabled? Defaults to true.

expiration String

The time in RFC3339 format of kind UTC that determines when this Automation Rule should expire and be disabled.

logAnalyticsWorkspaceId String

The ID of the Log Analytics Workspace where this Sentinel applies to. Changing this forces a new Sentinel Automation Rule to be created.

name String

The UUID which should be used for this Sentinel Automation Rule. Changing this forces a new Sentinel Automation Rule to be created.

order Number

The order of this Sentinel Automation Rule. Possible values varies between 1 and 1000.

triggersOn String

Specifies what triggers this automation rule. Possible values are Alerts and Incidents. Defaults to Incidents.

triggersWhen String

Specifies when will this automation rule be triggered. Possible values are Created and Updated. Defaults to Created.

Supporting Types

AutomationRuleActionIncident

Order int

The execution order of this action.

Classification string

The classification of the incident, when closing it. Possible values are: BenignPositive_SuspiciousButExpected, FalsePositive_InaccurateData, FalsePositive_IncorrectAlertLogic, TruePositive_SuspiciousActivity and Undetermined.

ClassificationComment string

The comment why the incident is to be closed.

Labels List<string>

Specifies a list of labels to add to the incident.

OwnerId string

The object ID of the entity this incident is assigned to.

Severity string

The severity to add to the incident. Possible values are High, Informational, Low and Medium.

Status string

The status to set to the incident. Possible values are: Active, Closed, New.

Order int

The execution order of this action.

Classification string

The classification of the incident, when closing it. Possible values are: BenignPositive_SuspiciousButExpected, FalsePositive_InaccurateData, FalsePositive_IncorrectAlertLogic, TruePositive_SuspiciousActivity and Undetermined.

ClassificationComment string

The comment why the incident is to be closed.

Labels []string

Specifies a list of labels to add to the incident.

OwnerId string

The object ID of the entity this incident is assigned to.

Severity string

The severity to add to the incident. Possible values are High, Informational, Low and Medium.

Status string

The status to set to the incident. Possible values are: Active, Closed, New.

order Integer

The execution order of this action.

classification String

The classification of the incident, when closing it. Possible values are: BenignPositive_SuspiciousButExpected, FalsePositive_InaccurateData, FalsePositive_IncorrectAlertLogic, TruePositive_SuspiciousActivity and Undetermined.

classificationComment String

The comment why the incident is to be closed.

labels List<String>

Specifies a list of labels to add to the incident.

ownerId String

The object ID of the entity this incident is assigned to.

severity String

The severity to add to the incident. Possible values are High, Informational, Low and Medium.

status String

The status to set to the incident. Possible values are: Active, Closed, New.

order number

The execution order of this action.

classification string

The classification of the incident, when closing it. Possible values are: BenignPositive_SuspiciousButExpected, FalsePositive_InaccurateData, FalsePositive_IncorrectAlertLogic, TruePositive_SuspiciousActivity and Undetermined.

classificationComment string

The comment why the incident is to be closed.

labels string[]

Specifies a list of labels to add to the incident.

ownerId string

The object ID of the entity this incident is assigned to.

severity string

The severity to add to the incident. Possible values are High, Informational, Low and Medium.

status string

The status to set to the incident. Possible values are: Active, Closed, New.

order int

The execution order of this action.

classification str

The classification of the incident, when closing it. Possible values are: BenignPositive_SuspiciousButExpected, FalsePositive_InaccurateData, FalsePositive_IncorrectAlertLogic, TruePositive_SuspiciousActivity and Undetermined.

classification_comment str

The comment why the incident is to be closed.

labels Sequence[str]

Specifies a list of labels to add to the incident.

owner_id str

The object ID of the entity this incident is assigned to.

severity str

The severity to add to the incident. Possible values are High, Informational, Low and Medium.

status str

The status to set to the incident. Possible values are: Active, Closed, New.

order Number

The execution order of this action.

classification String

The classification of the incident, when closing it. Possible values are: BenignPositive_SuspiciousButExpected, FalsePositive_InaccurateData, FalsePositive_IncorrectAlertLogic, TruePositive_SuspiciousActivity and Undetermined.

classificationComment String

The comment why the incident is to be closed.

labels List<String>

Specifies a list of labels to add to the incident.

ownerId String

The object ID of the entity this incident is assigned to.

severity String

The severity to add to the incident. Possible values are High, Informational, Low and Medium.

status String

The status to set to the incident. Possible values are: Active, Closed, New.

AutomationRuleActionPlaybook

LogicAppId string

The ID of the Logic App that defines the playbook's logic.

Order int

The execution order of this action.

TenantId string

The ID of the Tenant that owns the playbook.

LogicAppId string

The ID of the Logic App that defines the playbook's logic.

Order int

The execution order of this action.

TenantId string

The ID of the Tenant that owns the playbook.

logicAppId String

The ID of the Logic App that defines the playbook's logic.

order Integer

The execution order of this action.

tenantId String

The ID of the Tenant that owns the playbook.

logicAppId string

The ID of the Logic App that defines the playbook's logic.

order number

The execution order of this action.

tenantId string

The ID of the Tenant that owns the playbook.

logic_app_id str

The ID of the Logic App that defines the playbook's logic.

order int

The execution order of this action.

tenant_id str

The ID of the Tenant that owns the playbook.

logicAppId String

The ID of the Logic App that defines the playbook's logic.

order Number

The execution order of this action.

tenantId String

The ID of the Tenant that owns the playbook.

AutomationRuleCondition

Operator string

The operator to use for evaluate the condition. Possible values include: Equals, NotEquals, Contains, NotContains, StartsWith, NotStartsWith, EndsWith, NotEndsWith.

Property string

The property to use for evaluate the condition. Possible values include: AccountAadTenantId, AccountAadUserId, AccountNTDomain, AccountName, AccountObjectGuid, AccountPUID, AccountSid, AccountUPNSuffix, AzureResourceResourceId, AzureResourceSubscriptionId, CloudApplicationAppId, CloudApplicationAppName, DNSDomainName, FileDirectory, FileHashValue, FileName, HostAzureID, HostNTDomain, HostName, HostNetBiosName, HostOSVersion, IPAddress, IncidentDescription, IncidentProviderName, IncidentRelatedAnalyticRuleIds, IncidentSeverity, IncidentStatus, IncidentTactics, IncidentTitle, IoTDeviceId, IoTDeviceModel, IoTDeviceName, IoTDeviceOperatingSystem, IoTDeviceType, IoTDeviceVendor, MailMessageDeliveryAction, MailMessageDeliveryLocation, MailMessageP1Sender, MailMessageP2Sender, MailMessageRecipient, MailMessageSenderIP, MailMessageSubject, MailboxDisplayName, MailboxPrimaryAddress, MailboxUPN, MalwareCategory, MalwareName, ProcessCommandLine, ProcessId, RegistryKey, RegistryValueData, Url.

Values List<string>

Specifies a list of values to use for evaluate the condition.

Operator string

The operator to use for evaluate the condition. Possible values include: Equals, NotEquals, Contains, NotContains, StartsWith, NotStartsWith, EndsWith, NotEndsWith.

Property string

The property to use for evaluate the condition. Possible values include: AccountAadTenantId, AccountAadUserId, AccountNTDomain, AccountName, AccountObjectGuid, AccountPUID, AccountSid, AccountUPNSuffix, AzureResourceResourceId, AzureResourceSubscriptionId, CloudApplicationAppId, CloudApplicationAppName, DNSDomainName, FileDirectory, FileHashValue, FileName, HostAzureID, HostNTDomain, HostName, HostNetBiosName, HostOSVersion, IPAddress, IncidentDescription, IncidentProviderName, IncidentRelatedAnalyticRuleIds, IncidentSeverity, IncidentStatus, IncidentTactics, IncidentTitle, IoTDeviceId, IoTDeviceModel, IoTDeviceName, IoTDeviceOperatingSystem, IoTDeviceType, IoTDeviceVendor, MailMessageDeliveryAction, MailMessageDeliveryLocation, MailMessageP1Sender, MailMessageP2Sender, MailMessageRecipient, MailMessageSenderIP, MailMessageSubject, MailboxDisplayName, MailboxPrimaryAddress, MailboxUPN, MalwareCategory, MalwareName, ProcessCommandLine, ProcessId, RegistryKey, RegistryValueData, Url.

Values []string

Specifies a list of values to use for evaluate the condition.

operator String

The operator to use for evaluate the condition. Possible values include: Equals, NotEquals, Contains, NotContains, StartsWith, NotStartsWith, EndsWith, NotEndsWith.

property String

The property to use for evaluate the condition. Possible values include: AccountAadTenantId, AccountAadUserId, AccountNTDomain, AccountName, AccountObjectGuid, AccountPUID, AccountSid, AccountUPNSuffix, AzureResourceResourceId, AzureResourceSubscriptionId, CloudApplicationAppId, CloudApplicationAppName, DNSDomainName, FileDirectory, FileHashValue, FileName, HostAzureID, HostNTDomain, HostName, HostNetBiosName, HostOSVersion, IPAddress, IncidentDescription, IncidentProviderName, IncidentRelatedAnalyticRuleIds, IncidentSeverity, IncidentStatus, IncidentTactics, IncidentTitle, IoTDeviceId, IoTDeviceModel, IoTDeviceName, IoTDeviceOperatingSystem, IoTDeviceType, IoTDeviceVendor, MailMessageDeliveryAction, MailMessageDeliveryLocation, MailMessageP1Sender, MailMessageP2Sender, MailMessageRecipient, MailMessageSenderIP, MailMessageSubject, MailboxDisplayName, MailboxPrimaryAddress, MailboxUPN, MalwareCategory, MalwareName, ProcessCommandLine, ProcessId, RegistryKey, RegistryValueData, Url.

values List<String>

Specifies a list of values to use for evaluate the condition.

operator string

The operator to use for evaluate the condition. Possible values include: Equals, NotEquals, Contains, NotContains, StartsWith, NotStartsWith, EndsWith, NotEndsWith.

property string

The property to use for evaluate the condition. Possible values include: AccountAadTenantId, AccountAadUserId, AccountNTDomain, AccountName, AccountObjectGuid, AccountPUID, AccountSid, AccountUPNSuffix, AzureResourceResourceId, AzureResourceSubscriptionId, CloudApplicationAppId, CloudApplicationAppName, DNSDomainName, FileDirectory, FileHashValue, FileName, HostAzureID, HostNTDomain, HostName, HostNetBiosName, HostOSVersion, IPAddress, IncidentDescription, IncidentProviderName, IncidentRelatedAnalyticRuleIds, IncidentSeverity, IncidentStatus, IncidentTactics, IncidentTitle, IoTDeviceId, IoTDeviceModel, IoTDeviceName, IoTDeviceOperatingSystem, IoTDeviceType, IoTDeviceVendor, MailMessageDeliveryAction, MailMessageDeliveryLocation, MailMessageP1Sender, MailMessageP2Sender, MailMessageRecipient, MailMessageSenderIP, MailMessageSubject, MailboxDisplayName, MailboxPrimaryAddress, MailboxUPN, MalwareCategory, MalwareName, ProcessCommandLine, ProcessId, RegistryKey, RegistryValueData, Url.

values string[]

Specifies a list of values to use for evaluate the condition.

operator str

The operator to use for evaluate the condition. Possible values include: Equals, NotEquals, Contains, NotContains, StartsWith, NotStartsWith, EndsWith, NotEndsWith.

property str

The property to use for evaluate the condition. Possible values include: AccountAadTenantId, AccountAadUserId, AccountNTDomain, AccountName, AccountObjectGuid, AccountPUID, AccountSid, AccountUPNSuffix, AzureResourceResourceId, AzureResourceSubscriptionId, CloudApplicationAppId, CloudApplicationAppName, DNSDomainName, FileDirectory, FileHashValue, FileName, HostAzureID, HostNTDomain, HostName, HostNetBiosName, HostOSVersion, IPAddress, IncidentDescription, IncidentProviderName, IncidentRelatedAnalyticRuleIds, IncidentSeverity, IncidentStatus, IncidentTactics, IncidentTitle, IoTDeviceId, IoTDeviceModel, IoTDeviceName, IoTDeviceOperatingSystem, IoTDeviceType, IoTDeviceVendor, MailMessageDeliveryAction, MailMessageDeliveryLocation, MailMessageP1Sender, MailMessageP2Sender, MailMessageRecipient, MailMessageSenderIP, MailMessageSubject, MailboxDisplayName, MailboxPrimaryAddress, MailboxUPN, MalwareCategory, MalwareName, ProcessCommandLine, ProcessId, RegistryKey, RegistryValueData, Url.

values Sequence[str]

Specifies a list of values to use for evaluate the condition.

operator String

The operator to use for evaluate the condition. Possible values include: Equals, NotEquals, Contains, NotContains, StartsWith, NotStartsWith, EndsWith, NotEndsWith.

property String

The property to use for evaluate the condition. Possible values include: AccountAadTenantId, AccountAadUserId, AccountNTDomain, AccountName, AccountObjectGuid, AccountPUID, AccountSid, AccountUPNSuffix, AzureResourceResourceId, AzureResourceSubscriptionId, CloudApplicationAppId, CloudApplicationAppName, DNSDomainName, FileDirectory, FileHashValue, FileName, HostAzureID, HostNTDomain, HostName, HostNetBiosName, HostOSVersion, IPAddress, IncidentDescription, IncidentProviderName, IncidentRelatedAnalyticRuleIds, IncidentSeverity, IncidentStatus, IncidentTactics, IncidentTitle, IoTDeviceId, IoTDeviceModel, IoTDeviceName, IoTDeviceOperatingSystem, IoTDeviceType, IoTDeviceVendor, MailMessageDeliveryAction, MailMessageDeliveryLocation, MailMessageP1Sender, MailMessageP2Sender, MailMessageRecipient, MailMessageSenderIP, MailMessageSubject, MailboxDisplayName, MailboxPrimaryAddress, MailboxUPN, MalwareCategory, MalwareName, ProcessCommandLine, ProcessId, RegistryKey, RegistryValueData, Url.

values List<String>

Specifies a list of values to use for evaluate the condition.

Import

Sentinel Automation Rules can be imported using the resource id, e.g.

 $ pulumi import azure:sentinel/automationRule:AutomationRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.OperationalInsights/workspaces/workspace1/providers/Microsoft.SecurityInsights/automationRules/rule1

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.