1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. sentinel
  6. AutomationRule

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Manages a Sentinel Automation 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 sentinel = new Azure.OperationalInsights.AnalyticsSolution("sentinel", new Azure.OperationalInsights.AnalyticsSolutionArgs
            {
                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 Azure.Sentinel.AutomationRuleArgs
            {
                LogAnalyticsWorkspaceId = sentinel.WorkspaceResourceId,
                DisplayName = "automation_rule1",
                Order = 1,
                ActionIncidents = 
                {
                    new Azure.Sentinel.Inputs.AutomationRuleActionIncidentArgs
                    {
                        Order = 1,
                        Status = "Active",
                    },
                },
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/operationalinsights"
    	"github.com/pulumi/pulumi-azure/sdk/v4/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
    	})
    }
    

    Example coming soon!

    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",
        }],
    });
    
    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",
        )])
    

    Example coming soon!

    Create AutomationRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AutomationRule(name: string, args: AutomationRuleArgs, opts?: CustomResourceOptions);
    @overload
    def AutomationRule(resource_name: str,
                       args: AutomationRuleArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def AutomationRule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       display_name: Optional[str] = None,
                       log_analytics_workspace_id: Optional[str] = None,
                       order: Optional[int] = None,
                       action_incidents: Optional[Sequence[AutomationRuleActionIncidentArgs]] = None,
                       action_playbooks: Optional[Sequence[AutomationRuleActionPlaybookArgs]] = None,
                       conditions: Optional[Sequence[AutomationRuleConditionArgs]] = None,
                       enabled: Optional[bool] = None,
                       expiration: Optional[str] = None,
                       name: Optional[str] = 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.
    
    

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var automationRuleResource = new Azure.Sentinel.AutomationRule("automationRuleResource", new()
    {
        DisplayName = "string",
        LogAnalyticsWorkspaceId = "string",
        Order = 0,
        ActionIncidents = new[]
        {
            new Azure.Sentinel.Inputs.AutomationRuleActionIncidentArgs
            {
                Order = 0,
                Classification = "string",
                ClassificationComment = "string",
                Labels = new[]
                {
                    "string",
                },
                OwnerId = "string",
                Severity = "string",
                Status = "string",
            },
        },
        ActionPlaybooks = new[]
        {
            new Azure.Sentinel.Inputs.AutomationRuleActionPlaybookArgs
            {
                LogicAppId = "string",
                Order = 0,
                TenantId = "string",
            },
        },
        Conditions = new[]
        {
            new Azure.Sentinel.Inputs.AutomationRuleConditionArgs
            {
                Operator = "string",
                Property = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        Enabled = false,
        Expiration = "string",
        Name = "string",
    });
    
    example, err := sentinel.NewAutomationRule(ctx, "automationRuleResource", &sentinel.AutomationRuleArgs{
    	DisplayName:             pulumi.String("string"),
    	LogAnalyticsWorkspaceId: pulumi.String("string"),
    	Order:                   pulumi.Int(0),
    	ActionIncidents: sentinel.AutomationRuleActionIncidentArray{
    		&sentinel.AutomationRuleActionIncidentArgs{
    			Order:                 pulumi.Int(0),
    			Classification:        pulumi.String("string"),
    			ClassificationComment: pulumi.String("string"),
    			Labels: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			OwnerId:  pulumi.String("string"),
    			Severity: pulumi.String("string"),
    			Status:   pulumi.String("string"),
    		},
    	},
    	ActionPlaybooks: sentinel.AutomationRuleActionPlaybookArray{
    		&sentinel.AutomationRuleActionPlaybookArgs{
    			LogicAppId: pulumi.String("string"),
    			Order:      pulumi.Int(0),
    			TenantId:   pulumi.String("string"),
    		},
    	},
    	Conditions: sentinel.AutomationRuleConditionArray{
    		&sentinel.AutomationRuleConditionArgs{
    			Operator: pulumi.String("string"),
    			Property: pulumi.String("string"),
    			Values: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Enabled:    pulumi.Bool(false),
    	Expiration: pulumi.String("string"),
    	Name:       pulumi.String("string"),
    })
    
    var automationRuleResource = new AutomationRule("automationRuleResource", AutomationRuleArgs.builder()
        .displayName("string")
        .logAnalyticsWorkspaceId("string")
        .order(0)
        .actionIncidents(AutomationRuleActionIncidentArgs.builder()
            .order(0)
            .classification("string")
            .classificationComment("string")
            .labels("string")
            .ownerId("string")
            .severity("string")
            .status("string")
            .build())
        .actionPlaybooks(AutomationRuleActionPlaybookArgs.builder()
            .logicAppId("string")
            .order(0)
            .tenantId("string")
            .build())
        .conditions(AutomationRuleConditionArgs.builder()
            .operator("string")
            .property("string")
            .values("string")
            .build())
        .enabled(false)
        .expiration("string")
        .name("string")
        .build());
    
    automation_rule_resource = azure.sentinel.AutomationRule("automationRuleResource",
        display_name="string",
        log_analytics_workspace_id="string",
        order=0,
        action_incidents=[{
            "order": 0,
            "classification": "string",
            "classification_comment": "string",
            "labels": ["string"],
            "owner_id": "string",
            "severity": "string",
            "status": "string",
        }],
        action_playbooks=[{
            "logic_app_id": "string",
            "order": 0,
            "tenant_id": "string",
        }],
        conditions=[{
            "operator": "string",
            "property": "string",
            "values": ["string"],
        }],
        enabled=False,
        expiration="string",
        name="string")
    
    const automationRuleResource = new azure.sentinel.AutomationRule("automationRuleResource", {
        displayName: "string",
        logAnalyticsWorkspaceId: "string",
        order: 0,
        actionIncidents: [{
            order: 0,
            classification: "string",
            classificationComment: "string",
            labels: ["string"],
            ownerId: "string",
            severity: "string",
            status: "string",
        }],
        actionPlaybooks: [{
            logicAppId: "string",
            order: 0,
            tenantId: "string",
        }],
        conditions: [{
            operator: "string",
            property: "string",
            values: ["string"],
        }],
        enabled: false,
        expiration: "string",
        name: "string",
    });
    
    type: azure:sentinel:AutomationRule
    properties:
        actionIncidents:
            - classification: string
              classificationComment: string
              labels:
                - string
              order: 0
              ownerId: string
              severity: string
              status: string
        actionPlaybooks:
            - logicAppId: string
              order: 0
              tenantId: string
        conditions:
            - operator: string
              property: string
              values:
                - string
        displayName: string
        enabled: false
        expiration: string
        logAnalyticsWorkspaceId: string
        name: string
        order: 0
    

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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<AutomationRuleActionIncident>
    One or more action_incident blocks as defined below.
    ActionPlaybooks List<AutomationRuleActionPlaybook>
    One or more action_playbook blocks as defined below.
    Conditions List<AutomationRuleCondition>
    One or more condition blocks as defined below.
    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.
    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.
    Conditions []AutomationRuleConditionArgs
    One or more condition blocks as defined below.
    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.
    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<AutomationRuleActionIncident>
    One or more action_incident blocks as defined below.
    actionPlaybooks List<AutomationRuleActionPlaybook>
    One or more action_playbook blocks as defined below.
    conditions List<AutomationRuleCondition>
    One or more condition blocks as defined below.
    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.
    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 AutomationRuleActionIncident[]
    One or more action_incident blocks as defined below.
    actionPlaybooks AutomationRuleActionPlaybook[]
    One or more action_playbook blocks as defined below.
    conditions AutomationRuleCondition[]
    One or more condition blocks as defined below.
    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.
    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.
    conditions Sequence[AutomationRuleConditionArgs]
    One or more condition blocks as defined below.
    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.
    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.
    conditions List<Property Map>
    One or more condition blocks as defined below.
    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.

    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,
            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) -> 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)
    resources:  _:    type: azure:sentinel:AutomationRule    get:      id: ${id}
    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<AutomationRuleActionIncident>
    One or more action_incident blocks as defined below.
    ActionPlaybooks List<AutomationRuleActionPlaybook>
    One or more action_playbook blocks as defined below.
    Conditions List<AutomationRuleCondition>
    One or more condition blocks as defined below.
    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.
    ActionIncidents []AutomationRuleActionIncidentArgs
    One or more action_incident blocks as defined below.
    ActionPlaybooks []AutomationRuleActionPlaybookArgs
    One or more action_playbook blocks as defined below.
    Conditions []AutomationRuleConditionArgs
    One or more condition blocks as defined below.
    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.
    actionIncidents List<AutomationRuleActionIncident>
    One or more action_incident blocks as defined below.
    actionPlaybooks List<AutomationRuleActionPlaybook>
    One or more action_playbook blocks as defined below.
    conditions List<AutomationRuleCondition>
    One or more condition blocks as defined below.
    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.
    actionIncidents AutomationRuleActionIncident[]
    One or more action_incident blocks as defined below.
    actionPlaybooks AutomationRuleActionPlaybook[]
    One or more action_playbook blocks as defined below.
    conditions AutomationRuleCondition[]
    One or more condition blocks as defined below.
    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.
    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.
    conditions Sequence[AutomationRuleConditionArgs]
    One or more condition blocks as defined below.
    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.
    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.
    conditions List<Property Map>
    One or more condition blocks as defined below.
    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.

    Supporting Types

    AutomationRuleActionIncident, AutomationRuleActionIncidentArgs

    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.
    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.
    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.
    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.
    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.
    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.
    status String
    The status to set to the incident. Possible values are: Active, Closed, New.

    AutomationRuleActionPlaybook, AutomationRuleActionPlaybookArgs

    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, AutomationRuleConditionArgs

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.