Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.15.0 published on Wednesday, Aug 17, 2022 by Pulumi

AlertRuleScheduled

Manages a Sentinel Scheduled Alert 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 exampleAnalyticsSolution = new Azure.OperationalInsights.AnalyticsSolution("exampleAnalyticsSolution", 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 exampleAlertRuleScheduled = new Azure.Sentinel.AlertRuleScheduled("exampleAlertRuleScheduled", new()
    {
        LogAnalyticsWorkspaceId = exampleAnalyticsSolution.WorkspaceResourceId,
        DisplayName = "example",
        Severity = "High",
        Query = @"AzureActivity |
  where OperationName == ""Create or Update Virtual Machine"" or OperationName ==""Create Deployment"" |
  where ActivityStatus == ""Succeeded"" |
  make-series dcount(ResourceId) default=0 on EventSubmissionTimestamp in range(ago(7d), now(), 1d) by Caller
",
    });

});
package main

import (
	"fmt"

	"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
		}
		exampleAnalyticsSolution, err := operationalinsights.NewAnalyticsSolution(ctx, "exampleAnalyticsSolution", &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.NewAlertRuleScheduled(ctx, "exampleAlertRuleScheduled", &sentinel.AlertRuleScheduledArgs{
			LogAnalyticsWorkspaceId: exampleAnalyticsSolution.WorkspaceResourceId,
			DisplayName:             pulumi.String("example"),
			Severity:                pulumi.String("High"),
			Query:                   pulumi.String(fmt.Sprintf("AzureActivity |\n  where OperationName == \"Create or Update Virtual Machine\" or OperationName ==\"Create Deployment\" |\n  where ActivityStatus == \"Succeeded\" |\n  make-series dcount(ResourceId) default=0 on EventSubmissionTimestamp in range(ago(7d), now(), 1d) by Caller\n")),
		})
		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.AlertRuleScheduled;
import com.pulumi.azure.sentinel.AlertRuleScheduledArgs;
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 exampleAnalyticsSolution = new AnalyticsSolution("exampleAnalyticsSolution", 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 exampleAlertRuleScheduled = new AlertRuleScheduled("exampleAlertRuleScheduled", AlertRuleScheduledArgs.builder()        
            .logAnalyticsWorkspaceId(exampleAnalyticsSolution.workspaceResourceId())
            .displayName("example")
            .severity("High")
            .query("""
AzureActivity |
  where OperationName == "Create or Update Virtual Machine" or OperationName =="Create Deployment" |
  where ActivityStatus == "Succeeded" |
  make-series dcount(ResourceId) default=0 on EventSubmissionTimestamp in range(ago(7d), now(), 1d) by Caller
            """)
            .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")
example_analytics_solution = azure.operationalinsights.AnalyticsSolution("exampleAnalyticsSolution",
    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_alert_rule_scheduled = azure.sentinel.AlertRuleScheduled("exampleAlertRuleScheduled",
    log_analytics_workspace_id=example_analytics_solution.workspace_resource_id,
    display_name="example",
    severity="High",
    query="""AzureActivity |
  where OperationName == "Create or Update Virtual Machine" or OperationName =="Create Deployment" |
  where ActivityStatus == "Succeeded" |
  make-series dcount(ResourceId) default=0 on EventSubmissionTimestamp in range(ago(7d), now(), 1d) by Caller
""")
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 exampleAnalyticsSolution = new azure.operationalinsights.AnalyticsSolution("exampleAnalyticsSolution", {
    solutionName: "SecurityInsights",
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    workspaceResourceId: exampleAnalyticsWorkspace.id,
    workspaceName: exampleAnalyticsWorkspace.name,
    plan: {
        publisher: "Microsoft",
        product: "OMSGallery/SecurityInsights",
    },
});
const exampleAlertRuleScheduled = new azure.sentinel.AlertRuleScheduled("exampleAlertRuleScheduled", {
    logAnalyticsWorkspaceId: exampleAnalyticsSolution.workspaceResourceId,
    displayName: "example",
    severity: "High",
    query: `AzureActivity |
  where OperationName == "Create or Update Virtual Machine" or OperationName =="Create Deployment" |
  where ActivityStatus == "Succeeded" |
  make-series dcount(ResourceId) default=0 on EventSubmissionTimestamp in range(ago(7d), now(), 1d) by Caller
`,
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAnalyticsWorkspace:
    type: azure:operationalinsights:AnalyticsWorkspace
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku: PerGB2018
  exampleAnalyticsSolution:
    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
  exampleAlertRuleScheduled:
    type: azure:sentinel:AlertRuleScheduled
    properties:
      logAnalyticsWorkspaceId: ${exampleAnalyticsSolution.workspaceResourceId}
      displayName: example
      severity: High
      query: |
        AzureActivity |
          where OperationName == "Create or Update Virtual Machine" or OperationName =="Create Deployment" |
          where ActivityStatus == "Succeeded" |
          make-series dcount(ResourceId) default=0 on EventSubmissionTimestamp in range(ago(7d), now(), 1d) by Caller        

Create a AlertRuleScheduled Resource

new AlertRuleScheduled(name: string, args: AlertRuleScheduledArgs, opts?: CustomResourceOptions);
@overload
def AlertRuleScheduled(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       alert_details_overrides: Optional[Sequence[AlertRuleScheduledAlertDetailsOverrideArgs]] = None,
                       alert_rule_template_guid: Optional[str] = None,
                       alert_rule_template_version: Optional[str] = None,
                       custom_details: Optional[Mapping[str, str]] = None,
                       description: Optional[str] = None,
                       display_name: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       entity_mappings: Optional[Sequence[AlertRuleScheduledEntityMappingArgs]] = None,
                       event_grouping: Optional[AlertRuleScheduledEventGroupingArgs] = None,
                       incident_configuration: Optional[AlertRuleScheduledIncidentConfigurationArgs] = None,
                       log_analytics_workspace_id: Optional[str] = None,
                       name: Optional[str] = None,
                       query: Optional[str] = None,
                       query_frequency: Optional[str] = None,
                       query_period: Optional[str] = None,
                       severity: Optional[str] = None,
                       suppression_duration: Optional[str] = None,
                       suppression_enabled: Optional[bool] = None,
                       tactics: Optional[Sequence[str]] = None,
                       trigger_operator: Optional[str] = None,
                       trigger_threshold: Optional[int] = None)
@overload
def AlertRuleScheduled(resource_name: str,
                       args: AlertRuleScheduledArgs,
                       opts: Optional[ResourceOptions] = None)
func NewAlertRuleScheduled(ctx *Context, name string, args AlertRuleScheduledArgs, opts ...ResourceOption) (*AlertRuleScheduled, error)
public AlertRuleScheduled(string name, AlertRuleScheduledArgs args, CustomResourceOptions? opts = null)
public AlertRuleScheduled(String name, AlertRuleScheduledArgs args)
public AlertRuleScheduled(String name, AlertRuleScheduledArgs args, CustomResourceOptions options)
type: azure:sentinel:AlertRuleScheduled
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AlertRuleScheduledArgs
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 AlertRuleScheduledArgs
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 AlertRuleScheduledArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AlertRuleScheduledArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AlertRuleScheduledArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AlertRuleScheduled 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 AlertRuleScheduled resource accepts the following input properties:

DisplayName string

The friendly name of this Sentinel Scheduled Alert Rule.

LogAnalyticsWorkspaceId string

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

Query string

The query of this Sentinel Scheduled Alert Rule.

Severity string

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

AlertDetailsOverrides List<AlertRuleScheduledAlertDetailsOverrideArgs>

An alert_details_override block as defined below.

AlertRuleTemplateGuid string

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

AlertRuleTemplateVersion string

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

CustomDetails Dictionary<string, string>

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

Description string

The description of this Sentinel Scheduled Alert Rule.

Enabled bool

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

EntityMappings List<AlertRuleScheduledEntityMappingArgs>

A list of entity_mapping blocks as defined below.

EventGrouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

IncidentConfiguration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

Name string

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

QueryFrequency string

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

QueryPeriod string

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

SuppressionDuration string

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

SuppressionEnabled bool

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

Tactics List<string>

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

TriggerOperator string

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

TriggerThreshold int

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

DisplayName string

The friendly name of this Sentinel Scheduled Alert Rule.

LogAnalyticsWorkspaceId string

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

Query string

The query of this Sentinel Scheduled Alert Rule.

Severity string

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

AlertDetailsOverrides []AlertRuleScheduledAlertDetailsOverrideArgs

An alert_details_override block as defined below.

AlertRuleTemplateGuid string

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

AlertRuleTemplateVersion string

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

CustomDetails map[string]string

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

Description string

The description of this Sentinel Scheduled Alert Rule.

Enabled bool

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

EntityMappings []AlertRuleScheduledEntityMappingArgs

A list of entity_mapping blocks as defined below.

EventGrouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

IncidentConfiguration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

Name string

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

QueryFrequency string

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

QueryPeriod string

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

SuppressionDuration string

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

SuppressionEnabled bool

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

Tactics []string

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

TriggerOperator string

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

TriggerThreshold int

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

displayName String

The friendly name of this Sentinel Scheduled Alert Rule.

logAnalyticsWorkspaceId String

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

query String

The query of this Sentinel Scheduled Alert Rule.

severity String

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

alertDetailsOverrides List<AlertRuleScheduledAlertDetailsOverrideArgs>

An alert_details_override block as defined below.

alertRuleTemplateGuid String

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

alertRuleTemplateVersion String

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

customDetails Map<String,String>

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

description String

The description of this Sentinel Scheduled Alert Rule.

enabled Boolean

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

entityMappings List<AlertRuleScheduledEntityMappingArgs>

A list of entity_mapping blocks as defined below.

eventGrouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

incidentConfiguration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

name String

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

queryFrequency String

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

queryPeriod String

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

suppressionDuration String

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

suppressionEnabled Boolean

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

tactics List<String>

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

triggerOperator String

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

triggerThreshold Integer

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

displayName string

The friendly name of this Sentinel Scheduled Alert Rule.

logAnalyticsWorkspaceId string

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

query string

The query of this Sentinel Scheduled Alert Rule.

severity string

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

alertDetailsOverrides AlertRuleScheduledAlertDetailsOverrideArgs[]

An alert_details_override block as defined below.

alertRuleTemplateGuid string

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

alertRuleTemplateVersion string

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

customDetails {[key: string]: string}

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

description string

The description of this Sentinel Scheduled Alert Rule.

enabled boolean

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

entityMappings AlertRuleScheduledEntityMappingArgs[]

A list of entity_mapping blocks as defined below.

eventGrouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

incidentConfiguration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

name string

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

queryFrequency string

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

queryPeriod string

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

suppressionDuration string

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

suppressionEnabled boolean

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

tactics string[]

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

triggerOperator string

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

triggerThreshold number

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

display_name str

The friendly name of this Sentinel Scheduled Alert Rule.

log_analytics_workspace_id str

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

query str

The query of this Sentinel Scheduled Alert Rule.

severity str

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

alert_details_overrides Sequence[AlertRuleScheduledAlertDetailsOverrideArgs]

An alert_details_override block as defined below.

alert_rule_template_guid str

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

alert_rule_template_version str

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

custom_details Mapping[str, str]

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

description str

The description of this Sentinel Scheduled Alert Rule.

enabled bool

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

entity_mappings Sequence[AlertRuleScheduledEntityMappingArgs]

A list of entity_mapping blocks as defined below.

event_grouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

incident_configuration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

name str

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

query_frequency str

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

query_period str

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

suppression_duration str

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

suppression_enabled bool

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

tactics Sequence[str]

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

trigger_operator str

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

trigger_threshold int

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

displayName String

The friendly name of this Sentinel Scheduled Alert Rule.

logAnalyticsWorkspaceId String

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

query String

The query of this Sentinel Scheduled Alert Rule.

severity String

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

alertDetailsOverrides List<Property Map>

An alert_details_override block as defined below.

alertRuleTemplateGuid String

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

alertRuleTemplateVersion String

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

customDetails Map<String>

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

description String

The description of this Sentinel Scheduled Alert Rule.

enabled Boolean

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

entityMappings List<Property Map>

A list of entity_mapping blocks as defined below.

eventGrouping Property Map

A event_grouping block as defined below.

incidentConfiguration Property Map

A incident_configuration block as defined below.

name String

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

queryFrequency String

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

queryPeriod String

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

suppressionDuration String

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

suppressionEnabled Boolean

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

tactics List<String>

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

triggerOperator String

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

triggerThreshold Number

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the AlertRuleScheduled 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 an Existing AlertRuleScheduled Resource

Get an existing AlertRuleScheduled 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?: AlertRuleScheduledState, opts?: CustomResourceOptions): AlertRuleScheduled
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alert_details_overrides: Optional[Sequence[AlertRuleScheduledAlertDetailsOverrideArgs]] = None,
        alert_rule_template_guid: Optional[str] = None,
        alert_rule_template_version: Optional[str] = None,
        custom_details: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        entity_mappings: Optional[Sequence[AlertRuleScheduledEntityMappingArgs]] = None,
        event_grouping: Optional[AlertRuleScheduledEventGroupingArgs] = None,
        incident_configuration: Optional[AlertRuleScheduledIncidentConfigurationArgs] = None,
        log_analytics_workspace_id: Optional[str] = None,
        name: Optional[str] = None,
        query: Optional[str] = None,
        query_frequency: Optional[str] = None,
        query_period: Optional[str] = None,
        severity: Optional[str] = None,
        suppression_duration: Optional[str] = None,
        suppression_enabled: Optional[bool] = None,
        tactics: Optional[Sequence[str]] = None,
        trigger_operator: Optional[str] = None,
        trigger_threshold: Optional[int] = None) -> AlertRuleScheduled
func GetAlertRuleScheduled(ctx *Context, name string, id IDInput, state *AlertRuleScheduledState, opts ...ResourceOption) (*AlertRuleScheduled, error)
public static AlertRuleScheduled Get(string name, Input<string> id, AlertRuleScheduledState? state, CustomResourceOptions? opts = null)
public static AlertRuleScheduled get(String name, Output<String> id, AlertRuleScheduledState 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:
AlertDetailsOverrides List<AlertRuleScheduledAlertDetailsOverrideArgs>

An alert_details_override block as defined below.

AlertRuleTemplateGuid string

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

AlertRuleTemplateVersion string

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

CustomDetails Dictionary<string, string>

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

Description string

The description of this Sentinel Scheduled Alert Rule.

DisplayName string

The friendly name of this Sentinel Scheduled Alert Rule.

Enabled bool

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

EntityMappings List<AlertRuleScheduledEntityMappingArgs>

A list of entity_mapping blocks as defined below.

EventGrouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

IncidentConfiguration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

LogAnalyticsWorkspaceId string

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

Name string

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

Query string

The query of this Sentinel Scheduled Alert Rule.

QueryFrequency string

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

QueryPeriod string

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

Severity string

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

SuppressionDuration string

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

SuppressionEnabled bool

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

Tactics List<string>

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

TriggerOperator string

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

TriggerThreshold int

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

AlertDetailsOverrides []AlertRuleScheduledAlertDetailsOverrideArgs

An alert_details_override block as defined below.

AlertRuleTemplateGuid string

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

AlertRuleTemplateVersion string

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

CustomDetails map[string]string

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

Description string

The description of this Sentinel Scheduled Alert Rule.

DisplayName string

The friendly name of this Sentinel Scheduled Alert Rule.

Enabled bool

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

EntityMappings []AlertRuleScheduledEntityMappingArgs

A list of entity_mapping blocks as defined below.

EventGrouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

IncidentConfiguration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

LogAnalyticsWorkspaceId string

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

Name string

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

Query string

The query of this Sentinel Scheduled Alert Rule.

QueryFrequency string

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

QueryPeriod string

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

Severity string

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

SuppressionDuration string

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

SuppressionEnabled bool

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

Tactics []string

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

TriggerOperator string

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

TriggerThreshold int

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

alertDetailsOverrides List<AlertRuleScheduledAlertDetailsOverrideArgs>

An alert_details_override block as defined below.

alertRuleTemplateGuid String

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

alertRuleTemplateVersion String

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

customDetails Map<String,String>

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

description String

The description of this Sentinel Scheduled Alert Rule.

displayName String

The friendly name of this Sentinel Scheduled Alert Rule.

enabled Boolean

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

entityMappings List<AlertRuleScheduledEntityMappingArgs>

A list of entity_mapping blocks as defined below.

eventGrouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

incidentConfiguration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

logAnalyticsWorkspaceId String

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

name String

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

query String

The query of this Sentinel Scheduled Alert Rule.

queryFrequency String

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

queryPeriod String

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

severity String

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

suppressionDuration String

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

suppressionEnabled Boolean

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

tactics List<String>

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

triggerOperator String

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

triggerThreshold Integer

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

alertDetailsOverrides AlertRuleScheduledAlertDetailsOverrideArgs[]

An alert_details_override block as defined below.

alertRuleTemplateGuid string

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

alertRuleTemplateVersion string

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

customDetails {[key: string]: string}

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

description string

The description of this Sentinel Scheduled Alert Rule.

displayName string

The friendly name of this Sentinel Scheduled Alert Rule.

enabled boolean

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

entityMappings AlertRuleScheduledEntityMappingArgs[]

A list of entity_mapping blocks as defined below.

eventGrouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

incidentConfiguration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

logAnalyticsWorkspaceId string

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

name string

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

query string

The query of this Sentinel Scheduled Alert Rule.

queryFrequency string

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

queryPeriod string

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

severity string

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

suppressionDuration string

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

suppressionEnabled boolean

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

tactics string[]

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

triggerOperator string

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

triggerThreshold number

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

alert_details_overrides Sequence[AlertRuleScheduledAlertDetailsOverrideArgs]

An alert_details_override block as defined below.

alert_rule_template_guid str

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

alert_rule_template_version str

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

custom_details Mapping[str, str]

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

description str

The description of this Sentinel Scheduled Alert Rule.

display_name str

The friendly name of this Sentinel Scheduled Alert Rule.

enabled bool

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

entity_mappings Sequence[AlertRuleScheduledEntityMappingArgs]

A list of entity_mapping blocks as defined below.

event_grouping AlertRuleScheduledEventGroupingArgs

A event_grouping block as defined below.

incident_configuration AlertRuleScheduledIncidentConfigurationArgs

A incident_configuration block as defined below.

log_analytics_workspace_id str

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

name str

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

query str

The query of this Sentinel Scheduled Alert Rule.

query_frequency str

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

query_period str

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

severity str

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

suppression_duration str

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

suppression_enabled bool

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

tactics Sequence[str]

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

trigger_operator str

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

trigger_threshold int

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

alertDetailsOverrides List<Property Map>

An alert_details_override block as defined below.

alertRuleTemplateGuid String

The GUID of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

alertRuleTemplateVersion String

The version of the alert rule template which is used for this Sentinel Scheduled Alert Rule. Changing this forces a new Sentinel Scheduled Alert Rule to be created.

customDetails Map<String>

A map of string key-value pairs of columns to be attached to this Sentinel Scheduled Alert Rule. The key will appear as the field name in alerts and the value is the event parameter you wish to surface in the alerts.

description String

The description of this Sentinel Scheduled Alert Rule.

displayName String

The friendly name of this Sentinel Scheduled Alert Rule.

enabled Boolean

Should the Sentinel Scheduled Alert Rule be enabled? Defaults to true.

entityMappings List<Property Map>

A list of entity_mapping blocks as defined below.

eventGrouping Property Map

A event_grouping block as defined below.

incidentConfiguration Property Map

A incident_configuration block as defined below.

logAnalyticsWorkspaceId String

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

name String

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

query String

The query of this Sentinel Scheduled Alert Rule.

queryFrequency String

The ISO 8601 timespan duration between two consecutive queries. Defaults to PT5H.

queryPeriod String

The ISO 8601 timespan duration, which determine the time period of the data covered by the query. For example, it can query the past 10 minutes of data, or the past 6 hours of data. Defaults to PT5H.

severity String

The alert severity of this Sentinel Scheduled Alert Rule. Possible values are High, Medium, Low and Informational.

suppressionDuration String

If suppression_enabled is true, this is ISO 8601 timespan duration, which specifies the amount of time the query should stop running after alert is generated. Defaults to PT5H.

suppressionEnabled Boolean

Should the Sentinel Scheduled Alert Rulea stop running query after alert is generated? Defaults to false.

tactics List<String>

A list of categories of attacks by which to classify the rule. Possible values are Collection, CommandAndControl, CredentialAccess, DefenseEvasion, Discovery, Execution, Exfiltration, Impact, InitialAccess, LateralMovement, Persistence and PrivilegeEscalation.

triggerOperator String

The alert trigger operator, combined with trigger_threshold, setting alert threshold of this Sentinel Scheduled Alert Rule. Possible values are Equal, GreaterThan, LessThan, NotEqual.

triggerThreshold Number

The baseline number of query results generated, combined with trigger_operator, setting alert threshold of this Sentinel Scheduled Alert Rule.

Supporting Types

AlertRuleScheduledAlertDetailsOverride

DescriptionFormat string

The format containing columns name(s) to override the description of this Sentinel Alert Rule.

DisplayNameFormat string

The format containing columns name(s) to override the name of this Sentinel Alert Rule.

SeverityColumnName string

The column name to take the alert severity from.

TacticsColumnName string

The column name to take the alert tactics from.

DescriptionFormat string

The format containing columns name(s) to override the description of this Sentinel Alert Rule.

DisplayNameFormat string

The format containing columns name(s) to override the name of this Sentinel Alert Rule.

SeverityColumnName string

The column name to take the alert severity from.

TacticsColumnName string

The column name to take the alert tactics from.

descriptionFormat String

The format containing columns name(s) to override the description of this Sentinel Alert Rule.

displayNameFormat String

The format containing columns name(s) to override the name of this Sentinel Alert Rule.

severityColumnName String

The column name to take the alert severity from.

tacticsColumnName String

The column name to take the alert tactics from.

descriptionFormat string

The format containing columns name(s) to override the description of this Sentinel Alert Rule.

displayNameFormat string

The format containing columns name(s) to override the name of this Sentinel Alert Rule.

severityColumnName string

The column name to take the alert severity from.

tacticsColumnName string

The column name to take the alert tactics from.

description_format str

The format containing columns name(s) to override the description of this Sentinel Alert Rule.

display_name_format str

The format containing columns name(s) to override the name of this Sentinel Alert Rule.

severity_column_name str

The column name to take the alert severity from.

tactics_column_name str

The column name to take the alert tactics from.

descriptionFormat String

The format containing columns name(s) to override the description of this Sentinel Alert Rule.

displayNameFormat String

The format containing columns name(s) to override the name of this Sentinel Alert Rule.

severityColumnName String

The column name to take the alert severity from.

tacticsColumnName String

The column name to take the alert tactics from.

AlertRuleScheduledEntityMapping

EntityType string

The type of the entity. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

FieldMappings List<AlertRuleScheduledEntityMappingFieldMapping>

A list of field_mapping blocks as defined below.

EntityType string

The type of the entity. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

FieldMappings []AlertRuleScheduledEntityMappingFieldMapping

A list of field_mapping blocks as defined below.

entityType String

The type of the entity. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

fieldMappings List<AlertRuleScheduledEntityMappingFieldMapping>

A list of field_mapping blocks as defined below.

entityType string

The type of the entity. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

fieldMappings AlertRuleScheduledEntityMappingFieldMapping[]

A list of field_mapping blocks as defined below.

entity_type str

The type of the entity. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

field_mappings Sequence[AlertRuleScheduledEntityMappingFieldMapping]

A list of field_mapping blocks as defined below.

entityType String

The type of the entity. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

fieldMappings List<Property Map>

A list of field_mapping blocks as defined below.

AlertRuleScheduledEntityMappingFieldMapping

ColumnName string

The column name to be mapped to the identifier.

Identifier string

The identifier of the entity.

ColumnName string

The column name to be mapped to the identifier.

Identifier string

The identifier of the entity.

columnName String

The column name to be mapped to the identifier.

identifier String

The identifier of the entity.

columnName string

The column name to be mapped to the identifier.

identifier string

The identifier of the entity.

column_name str

The column name to be mapped to the identifier.

identifier str

The identifier of the entity.

columnName String

The column name to be mapped to the identifier.

identifier String

The identifier of the entity.

AlertRuleScheduledEventGrouping

AggregationMethod string

The aggregation type of grouping the events.

AggregationMethod string

The aggregation type of grouping the events.

aggregationMethod String

The aggregation type of grouping the events.

aggregationMethod string

The aggregation type of grouping the events.

aggregation_method str

The aggregation type of grouping the events.

aggregationMethod String

The aggregation type of grouping the events.

AlertRuleScheduledIncidentConfiguration

CreateIncident bool

Whether to create an incident from alerts triggered by this Sentinel Scheduled Alert Rule?

Grouping AlertRuleScheduledIncidentConfigurationGrouping

A grouping block as defined below.

CreateIncident bool

Whether to create an incident from alerts triggered by this Sentinel Scheduled Alert Rule?

Grouping AlertRuleScheduledIncidentConfigurationGrouping

A grouping block as defined below.

createIncident Boolean

Whether to create an incident from alerts triggered by this Sentinel Scheduled Alert Rule?

grouping AlertRuleScheduledIncidentConfigurationGrouping

A grouping block as defined below.

createIncident boolean

Whether to create an incident from alerts triggered by this Sentinel Scheduled Alert Rule?

grouping AlertRuleScheduledIncidentConfigurationGrouping

A grouping block as defined below.

create_incident bool

Whether to create an incident from alerts triggered by this Sentinel Scheduled Alert Rule?

grouping AlertRuleScheduledIncidentConfigurationGrouping

A grouping block as defined below.

createIncident Boolean

Whether to create an incident from alerts triggered by this Sentinel Scheduled Alert Rule?

grouping Property Map

A grouping block as defined below.

AlertRuleScheduledIncidentConfigurationGrouping

Enabled bool

Enable grouping incidents created from alerts triggered by this Sentinel Scheduled Alert Rule. Defaults to true.

EntityMatchingMethod string

The method used to group incidents. Possible values are AnyAlert, Selected and AllEntities. Defaults to AnyAlert.

GroupByAlertDetails List<string>
GroupByCustomDetails List<string>
GroupByEntities List<string>

A list of entity types to group by, only when the entity_matching_method is Selected. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

LookbackDuration string

Limit the group to alerts created within the lookback duration (in ISO 8601 duration format). Defaults to PT5M.

ReopenClosedIncidents bool

Whether to re-open closed matching incidents? Defaults to false.

Enabled bool

Enable grouping incidents created from alerts triggered by this Sentinel Scheduled Alert Rule. Defaults to true.

EntityMatchingMethod string

The method used to group incidents. Possible values are AnyAlert, Selected and AllEntities. Defaults to AnyAlert.

GroupByAlertDetails []string
GroupByCustomDetails []string
GroupByEntities []string

A list of entity types to group by, only when the entity_matching_method is Selected. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

LookbackDuration string

Limit the group to alerts created within the lookback duration (in ISO 8601 duration format). Defaults to PT5M.

ReopenClosedIncidents bool

Whether to re-open closed matching incidents? Defaults to false.

enabled Boolean

Enable grouping incidents created from alerts triggered by this Sentinel Scheduled Alert Rule. Defaults to true.

entityMatchingMethod String

The method used to group incidents. Possible values are AnyAlert, Selected and AllEntities. Defaults to AnyAlert.

groupByAlertDetails List<String>
groupByCustomDetails List<String>
groupByEntities List<String>

A list of entity types to group by, only when the entity_matching_method is Selected. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

lookbackDuration String

Limit the group to alerts created within the lookback duration (in ISO 8601 duration format). Defaults to PT5M.

reopenClosedIncidents Boolean

Whether to re-open closed matching incidents? Defaults to false.

enabled boolean

Enable grouping incidents created from alerts triggered by this Sentinel Scheduled Alert Rule. Defaults to true.

entityMatchingMethod string

The method used to group incidents. Possible values are AnyAlert, Selected and AllEntities. Defaults to AnyAlert.

groupByAlertDetails string[]
groupByCustomDetails string[]
groupByEntities string[]

A list of entity types to group by, only when the entity_matching_method is Selected. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

lookbackDuration string

Limit the group to alerts created within the lookback duration (in ISO 8601 duration format). Defaults to PT5M.

reopenClosedIncidents boolean

Whether to re-open closed matching incidents? Defaults to false.

enabled bool

Enable grouping incidents created from alerts triggered by this Sentinel Scheduled Alert Rule. Defaults to true.

entity_matching_method str

The method used to group incidents. Possible values are AnyAlert, Selected and AllEntities. Defaults to AnyAlert.

group_by_alert_details Sequence[str]
group_by_custom_details Sequence[str]
group_by_entities Sequence[str]

A list of entity types to group by, only when the entity_matching_method is Selected. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

lookback_duration str

Limit the group to alerts created within the lookback duration (in ISO 8601 duration format). Defaults to PT5M.

reopen_closed_incidents bool

Whether to re-open closed matching incidents? Defaults to false.

enabled Boolean

Enable grouping incidents created from alerts triggered by this Sentinel Scheduled Alert Rule. Defaults to true.

entityMatchingMethod String

The method used to group incidents. Possible values are AnyAlert, Selected and AllEntities. Defaults to AnyAlert.

groupByAlertDetails List<String>
groupByCustomDetails List<String>
groupByEntities List<String>

A list of entity types to group by, only when the entity_matching_method is Selected. Possible values are Account, AzureResource, CloudApplication, DNS, File, FileHash, Host, IP, Mailbox, MailCluster, MailMessage, Malware, Process, RegistryKey, RegistryValue, SecurityGroup, SubmissionMail, URL.

lookbackDuration String

Limit the group to alerts created within the lookback duration (in ISO 8601 duration format). Defaults to PT5M.

reopenClosedIncidents Boolean

Whether to re-open closed matching incidents? Defaults to false.

Import

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

 $ pulumi import azure:sentinel/alertRuleScheduled:AlertRuleScheduled example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.OperationalInsights/workspaces/workspace1/providers/Microsoft.SecurityInsights/alertRules/rule1

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.