Represents scheduled alert rule.
Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
Example Usage
Creates or updates a Fusion alert rule.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var scheduledAlertRule = new AzureNative.SecurityInsights.ScheduledAlertRule("scheduledAlertRule", new()
{
ResourceGroupName = "myRg",
RuleId = "myFirstFusionRule",
WorkspaceName = "myWorkspace",
});
});
package main
import (
securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := securityinsights.NewScheduledAlertRule(ctx, "scheduledAlertRule", &securityinsights.ScheduledAlertRuleArgs{
ResourceGroupName: pulumi.String("myRg"),
RuleId: pulumi.String("myFirstFusionRule"),
WorkspaceName: pulumi.String("myWorkspace"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_securityinsights_scheduled_alert_rule" "scheduledAlertRule" {
lifecycle {
create_before_destroy = true
}
resource_group_name = "myRg"
rule_id = "myFirstFusionRule"
workspace_name = "myWorkspace"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.ScheduledAlertRule;
import com.pulumi.azurenative.securityinsights.ScheduledAlertRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 scheduledAlertRule = new ScheduledAlertRule("scheduledAlertRule", ScheduledAlertRuleArgs.builder()
.resourceGroupName("myRg")
.ruleId("myFirstFusionRule")
.workspaceName("myWorkspace")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const scheduledAlertRule = new azure_native.securityinsights.ScheduledAlertRule("scheduledAlertRule", {
resourceGroupName: "myRg",
ruleId: "myFirstFusionRule",
workspaceName: "myWorkspace",
});
import pulumi
import pulumi_azure_native as azure_native
scheduled_alert_rule = azure_native.securityinsights.ScheduledAlertRule("scheduledAlertRule",
resource_group_name="myRg",
rule_id="myFirstFusionRule",
workspace_name="myWorkspace")
resources:
scheduledAlertRule:
type: azure-native:securityinsights:ScheduledAlertRule
properties:
resourceGroupName: myRg
ruleId: myFirstFusionRule
workspaceName: myWorkspace
Creates or updates a MicrosoftSecurityIncidentCreation rule.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var scheduledAlertRule = new AzureNative.SecurityInsights.ScheduledAlertRule("scheduledAlertRule", new()
{
ResourceGroupName = "myRg",
RuleId = "microsoftSecurityIncidentCreationRuleExample",
WorkspaceName = "myWorkspace",
});
});
package main
import (
securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := securityinsights.NewScheduledAlertRule(ctx, "scheduledAlertRule", &securityinsights.ScheduledAlertRuleArgs{
ResourceGroupName: pulumi.String("myRg"),
RuleId: pulumi.String("microsoftSecurityIncidentCreationRuleExample"),
WorkspaceName: pulumi.String("myWorkspace"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_securityinsights_scheduled_alert_rule" "scheduledAlertRule" {
lifecycle {
create_before_destroy = true
}
resource_group_name = "myRg"
rule_id = "microsoftSecurityIncidentCreationRuleExample"
workspace_name = "myWorkspace"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.ScheduledAlertRule;
import com.pulumi.azurenative.securityinsights.ScheduledAlertRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 scheduledAlertRule = new ScheduledAlertRule("scheduledAlertRule", ScheduledAlertRuleArgs.builder()
.resourceGroupName("myRg")
.ruleId("microsoftSecurityIncidentCreationRuleExample")
.workspaceName("myWorkspace")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const scheduledAlertRule = new azure_native.securityinsights.ScheduledAlertRule("scheduledAlertRule", {
resourceGroupName: "myRg",
ruleId: "microsoftSecurityIncidentCreationRuleExample",
workspaceName: "myWorkspace",
});
import pulumi
import pulumi_azure_native as azure_native
scheduled_alert_rule = azure_native.securityinsights.ScheduledAlertRule("scheduledAlertRule",
resource_group_name="myRg",
rule_id="microsoftSecurityIncidentCreationRuleExample",
workspace_name="myWorkspace")
resources:
scheduledAlertRule:
type: azure-native:securityinsights:ScheduledAlertRule
properties:
resourceGroupName: myRg
ruleId: microsoftSecurityIncidentCreationRuleExample
workspaceName: myWorkspace
Creates or updates a Scheduled alert rule.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var scheduledAlertRule = new AzureNative.SecurityInsights.ScheduledAlertRule("scheduledAlertRule", new()
{
AlertDetailsOverride = new AzureNative.SecurityInsights.Inputs.AlertDetailsOverrideArgs
{
AlertDescriptionFormat = "Suspicious activity was made by {{ComputerIP}}",
AlertDisplayNameFormat = "Alert from {{Computer}}",
AlertDynamicProperties = new[]
{
new AzureNative.SecurityInsights.Inputs.AlertPropertyMappingArgs
{
AlertProperty = AzureNative.SecurityInsights.AlertProperty.ProductComponentName,
Value = "ProductComponentNameCustomColumn",
},
new AzureNative.SecurityInsights.Inputs.AlertPropertyMappingArgs
{
AlertProperty = AzureNative.SecurityInsights.AlertProperty.ProductName,
Value = "ProductNameCustomColumn",
},
new AzureNative.SecurityInsights.Inputs.AlertPropertyMappingArgs
{
AlertProperty = AzureNative.SecurityInsights.AlertProperty.AlertLink,
Value = "Link",
},
},
},
CustomDetails =
{
{ "OperatingSystemName", "OSName" },
{ "OperatingSystemType", "OSType" },
},
Description = "An example for a scheduled rule",
DisplayName = "My scheduled rule",
Enabled = true,
EntityMappings = new[]
{
new AzureNative.SecurityInsights.Inputs.EntityMappingArgs
{
EntityType = AzureNative.SecurityInsights.EntityMappingType.Host,
FieldMappings = new[]
{
new AzureNative.SecurityInsights.Inputs.FieldMappingArgs
{
ColumnName = "Computer",
Identifier = "FullName",
},
},
},
new AzureNative.SecurityInsights.Inputs.EntityMappingArgs
{
EntityType = AzureNative.SecurityInsights.EntityMappingType.IP,
FieldMappings = new[]
{
new AzureNative.SecurityInsights.Inputs.FieldMappingArgs
{
ColumnName = "ComputerIP",
Identifier = "Address",
},
},
},
},
EventGroupingSettings = new AzureNative.SecurityInsights.Inputs.EventGroupingSettingsArgs
{
AggregationKind = AzureNative.SecurityInsights.EventGroupingAggregationKind.AlertPerResult,
},
IncidentConfiguration = new AzureNative.SecurityInsights.Inputs.IncidentConfigurationArgs
{
CreateIncident = true,
GroupingConfiguration = new AzureNative.SecurityInsights.Inputs.GroupingConfigurationArgs
{
Enabled = true,
GroupByAlertDetails =
{
AzureNative.SecurityInsights.AlertDetail.DisplayName,
},
GroupByCustomDetails = new[]
{
"OperatingSystemType",
"OperatingSystemName",
},
GroupByEntities =
{
AzureNative.SecurityInsights.EntityMappingType.Host,
},
LookbackDuration = "PT5H",
MatchingMethod = AzureNative.SecurityInsights.MatchingMethod.Selected,
ReopenClosedIncident = false,
},
},
Kind = "Scheduled",
Query = "Heartbeat",
QueryFrequency = "PT1H",
QueryPeriod = "P2DT1H30M",
ResourceGroupName = "myRg",
RuleId = "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
Severity = AzureNative.SecurityInsights.AlertSeverity.High,
SuppressionDuration = "PT1H",
SuppressionEnabled = false,
Tactics =
{
AzureNative.SecurityInsights.AttackTactic.Persistence,
AzureNative.SecurityInsights.AttackTactic.LateralMovement,
},
TriggerOperator = AzureNative.SecurityInsights.TriggerOperator.GreaterThan,
TriggerThreshold = 0,
WorkspaceName = "myWorkspace",
});
});
package main
import (
securityinsights "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := securityinsights.NewScheduledAlertRule(ctx, "scheduledAlertRule", &securityinsights.ScheduledAlertRuleArgs{
AlertDetailsOverride: &securityinsights.AlertDetailsOverrideArgs{
AlertDescriptionFormat: pulumi.String("Suspicious activity was made by {{ComputerIP}}"),
AlertDisplayNameFormat: pulumi.String("Alert from {{Computer}}"),
AlertDynamicProperties: securityinsights.AlertPropertyMappingArray{
&securityinsights.AlertPropertyMappingArgs{
AlertProperty: pulumi.String(securityinsights.AlertPropertyProductComponentName),
Value: pulumi.String("ProductComponentNameCustomColumn"),
},
&securityinsights.AlertPropertyMappingArgs{
AlertProperty: pulumi.String(securityinsights.AlertPropertyProductName),
Value: pulumi.String("ProductNameCustomColumn"),
},
&securityinsights.AlertPropertyMappingArgs{
AlertProperty: pulumi.String(securityinsights.AlertPropertyAlertLink),
Value: pulumi.String("Link"),
},
},
},
CustomDetails: pulumi.StringMap{
"OperatingSystemName": pulumi.String("OSName"),
"OperatingSystemType": pulumi.String("OSType"),
},
Description: pulumi.String("An example for a scheduled rule"),
DisplayName: pulumi.String("My scheduled rule"),
Enabled: pulumi.Bool(true),
EntityMappings: securityinsights.EntityMappingArray{
&securityinsights.EntityMappingArgs{
EntityType: pulumi.String(securityinsights.EntityMappingTypeHost),
FieldMappings: securityinsights.FieldMappingArray{
&securityinsights.FieldMappingArgs{
ColumnName: pulumi.String("Computer"),
Identifier: pulumi.String("FullName"),
},
},
},
&securityinsights.EntityMappingArgs{
EntityType: pulumi.String(securityinsights.EntityMappingTypeIP),
FieldMappings: securityinsights.FieldMappingArray{
&securityinsights.FieldMappingArgs{
ColumnName: pulumi.String("ComputerIP"),
Identifier: pulumi.String("Address"),
},
},
},
},
EventGroupingSettings: &securityinsights.EventGroupingSettingsArgs{
AggregationKind: pulumi.String(securityinsights.EventGroupingAggregationKindAlertPerResult),
},
IncidentConfiguration: &securityinsights.IncidentConfigurationArgs{
CreateIncident: pulumi.Bool(true),
GroupingConfiguration: &securityinsights.GroupingConfigurationArgs{
Enabled: pulumi.Bool(true),
GroupByAlertDetails: pulumi.StringArray{
pulumi.String(securityinsights.AlertDetailDisplayName),
},
GroupByCustomDetails: pulumi.StringArray{
pulumi.String("OperatingSystemType"),
pulumi.String("OperatingSystemName"),
},
GroupByEntities: pulumi.StringArray{
pulumi.String(securityinsights.EntityMappingTypeHost),
},
LookbackDuration: pulumi.String("PT5H"),
MatchingMethod: pulumi.String(securityinsights.MatchingMethodSelected),
ReopenClosedIncident: pulumi.Bool(false),
},
},
Kind: pulumi.String("Scheduled"),
Query: pulumi.String("Heartbeat"),
QueryFrequency: pulumi.String("PT1H"),
QueryPeriod: pulumi.String("P2DT1H30M"),
ResourceGroupName: pulumi.String("myRg"),
RuleId: pulumi.String("73e01a99-5cd7-4139-a149-9f2736ff2ab5"),
Severity: pulumi.String(securityinsights.AlertSeverityHigh),
SuppressionDuration: pulumi.String("PT1H"),
SuppressionEnabled: pulumi.Bool(false),
Tactics: pulumi.StringArray{
pulumi.String(securityinsights.AttackTacticPersistence),
pulumi.String(securityinsights.AttackTacticLateralMovement),
},
TriggerOperator: securityinsights.TriggerOperatorGreaterThan,
TriggerThreshold: pulumi.Int(0),
WorkspaceName: pulumi.String("myWorkspace"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_securityinsights_scheduled_alert_rule" "scheduledAlertRule" {
lifecycle {
create_before_destroy = true
}
alert_details_override = {
alert_description_format = "Suspicious activity was made by {{ComputerIP}}"
alert_display_name_format = "Alert from {{Computer}}"
alert_dynamic_properties = [{
alert_property = "ProductComponentName"
value = "ProductComponentNameCustomColumn"
}, {
alert_property = "ProductName"
value = "ProductNameCustomColumn"
}, {
alert_property = "AlertLink"
value = "Link"
}]
}
custom_details = {
"OperatingSystemName" = "OSName"
"OperatingSystemType" = "OSType"
}
description = "An example for a scheduled rule"
display_name = "My scheduled rule"
enabled = true
entity_mappings {
entity_type = "Host"
field_mappings {
column_name = "Computer"
identifier = "FullName"
}
}
entity_mappings {
entity_type = "IP"
field_mappings {
column_name = "ComputerIP"
identifier = "Address"
}
}
event_grouping_settings = {
aggregation_kind = "AlertPerResult"
}
incident_configuration = {
create_incident = true
grouping_configuration = {
enabled = true
group_by_alert_details = ["DisplayName"]
group_by_custom_details = ["OperatingSystemType", "OperatingSystemName"]
group_by_entities = ["Host"]
lookback_duration = "PT5H"
matching_method = "Selected"
reopen_closed_incident = false
}
}
kind = "Scheduled"
query = "Heartbeat"
query_frequency = "PT1H"
query_period = "P2DT1H30M"
resource_group_name = "myRg"
rule_id = "73e01a99-5cd7-4139-a149-9f2736ff2ab5"
severity = "High"
suppression_duration = "PT1H"
suppression_enabled = false
tactics = ["Persistence", "LateralMovement"]
trigger_operator = "GreaterThan"
trigger_threshold = 0
workspace_name = "myWorkspace"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.securityinsights.ScheduledAlertRule;
import com.pulumi.azurenative.securityinsights.ScheduledAlertRuleArgs;
import com.pulumi.azurenative.securityinsights.inputs.AlertDetailsOverrideArgs;
import com.pulumi.azurenative.securityinsights.inputs.AlertPropertyMappingArgs;
import com.pulumi.azurenative.securityinsights.inputs.EntityMappingArgs;
import com.pulumi.azurenative.securityinsights.inputs.FieldMappingArgs;
import com.pulumi.azurenative.securityinsights.inputs.EventGroupingSettingsArgs;
import com.pulumi.azurenative.securityinsights.inputs.IncidentConfigurationArgs;
import com.pulumi.azurenative.securityinsights.inputs.GroupingConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 scheduledAlertRule = new ScheduledAlertRule("scheduledAlertRule", ScheduledAlertRuleArgs.builder()
.alertDetailsOverride(AlertDetailsOverrideArgs.builder()
.alertDescriptionFormat("Suspicious activity was made by {{ComputerIP}}")
.alertDisplayNameFormat("Alert from {{Computer}}")
.alertDynamicProperties(
AlertPropertyMappingArgs.builder()
.alertProperty("ProductComponentName")
.value("ProductComponentNameCustomColumn")
.build(),
AlertPropertyMappingArgs.builder()
.alertProperty("ProductName")
.value("ProductNameCustomColumn")
.build(),
AlertPropertyMappingArgs.builder()
.alertProperty("AlertLink")
.value("Link")
.build())
.build())
.customDetails(Map.ofEntries(
Map.entry("OperatingSystemName", "OSName"),
Map.entry("OperatingSystemType", "OSType")
))
.description("An example for a scheduled rule")
.displayName("My scheduled rule")
.enabled(true)
.entityMappings(
EntityMappingArgs.builder()
.entityType("Host")
.fieldMappings(FieldMappingArgs.builder()
.columnName("Computer")
.identifier("FullName")
.build())
.build(),
EntityMappingArgs.builder()
.entityType("IP")
.fieldMappings(FieldMappingArgs.builder()
.columnName("ComputerIP")
.identifier("Address")
.build())
.build())
.eventGroupingSettings(EventGroupingSettingsArgs.builder()
.aggregationKind("AlertPerResult")
.build())
.incidentConfiguration(IncidentConfigurationArgs.builder()
.createIncident(true)
.groupingConfiguration(GroupingConfigurationArgs.builder()
.enabled(true)
.groupByAlertDetails("DisplayName")
.groupByCustomDetails(
"OperatingSystemType",
"OperatingSystemName")
.groupByEntities("Host")
.lookbackDuration("PT5H")
.matchingMethod("Selected")
.reopenClosedIncident(false)
.build())
.build())
.query("Heartbeat")
.queryFrequency("PT1H")
.queryPeriod("P2DT1H30M")
.resourceGroupName("myRg")
.ruleId("73e01a99-5cd7-4139-a149-9f2736ff2ab5")
.severity("High")
.suppressionDuration("PT1H")
.suppressionEnabled(false)
.tactics(
"Persistence",
"LateralMovement")
.triggerOperator("GreaterThan")
.triggerThreshold(0)
.workspaceName("myWorkspace")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const scheduledAlertRule = new azure_native.securityinsights.ScheduledAlertRule("scheduledAlertRule", {
alertDetailsOverride: {
alertDescriptionFormat: "Suspicious activity was made by {{ComputerIP}}",
alertDisplayNameFormat: "Alert from {{Computer}}",
alertDynamicProperties: [
{
alertProperty: azure_native.securityinsights.AlertProperty.ProductComponentName,
value: "ProductComponentNameCustomColumn",
},
{
alertProperty: azure_native.securityinsights.AlertProperty.ProductName,
value: "ProductNameCustomColumn",
},
{
alertProperty: azure_native.securityinsights.AlertProperty.AlertLink,
value: "Link",
},
],
},
customDetails: {
OperatingSystemName: "OSName",
OperatingSystemType: "OSType",
},
description: "An example for a scheduled rule",
displayName: "My scheduled rule",
enabled: true,
entityMappings: [
{
entityType: azure_native.securityinsights.EntityMappingType.Host,
fieldMappings: [{
columnName: "Computer",
identifier: "FullName",
}],
},
{
entityType: azure_native.securityinsights.EntityMappingType.IP,
fieldMappings: [{
columnName: "ComputerIP",
identifier: "Address",
}],
},
],
eventGroupingSettings: {
aggregationKind: azure_native.securityinsights.EventGroupingAggregationKind.AlertPerResult,
},
incidentConfiguration: {
createIncident: true,
groupingConfiguration: {
enabled: true,
groupByAlertDetails: [azure_native.securityinsights.AlertDetail.DisplayName],
groupByCustomDetails: [
"OperatingSystemType",
"OperatingSystemName",
],
groupByEntities: [azure_native.securityinsights.EntityMappingType.Host],
lookbackDuration: "PT5H",
matchingMethod: azure_native.securityinsights.MatchingMethod.Selected,
reopenClosedIncident: false,
},
},
kind: "Scheduled",
query: "Heartbeat",
queryFrequency: "PT1H",
queryPeriod: "P2DT1H30M",
resourceGroupName: "myRg",
ruleId: "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
severity: azure_native.securityinsights.AlertSeverity.High,
suppressionDuration: "PT1H",
suppressionEnabled: false,
tactics: [
azure_native.securityinsights.AttackTactic.Persistence,
azure_native.securityinsights.AttackTactic.LateralMovement,
],
triggerOperator: azure_native.securityinsights.TriggerOperator.GreaterThan,
triggerThreshold: 0,
workspaceName: "myWorkspace",
});
import pulumi
import pulumi_azure_native as azure_native
scheduled_alert_rule = azure_native.securityinsights.ScheduledAlertRule("scheduledAlertRule",
alert_details_override={
"alert_description_format": "Suspicious activity was made by {{ComputerIP}}",
"alert_display_name_format": "Alert from {{Computer}}",
"alert_dynamic_properties": [
{
"alert_property": azure_native.securityinsights.AlertProperty.PRODUCT_COMPONENT_NAME,
"value": "ProductComponentNameCustomColumn",
},
{
"alert_property": azure_native.securityinsights.AlertProperty.PRODUCT_NAME,
"value": "ProductNameCustomColumn",
},
{
"alert_property": azure_native.securityinsights.AlertProperty.ALERT_LINK,
"value": "Link",
},
],
},
custom_details={
"OperatingSystemName": "OSName",
"OperatingSystemType": "OSType",
},
description="An example for a scheduled rule",
display_name="My scheduled rule",
enabled=True,
entity_mappings=[
{
"entity_type": azure_native.securityinsights.EntityMappingType.HOST,
"field_mappings": [{
"column_name": "Computer",
"identifier": "FullName",
}],
},
{
"entity_type": azure_native.securityinsights.EntityMappingType.IP,
"field_mappings": [{
"column_name": "ComputerIP",
"identifier": "Address",
}],
},
],
event_grouping_settings={
"aggregation_kind": azure_native.securityinsights.EventGroupingAggregationKind.ALERT_PER_RESULT,
},
incident_configuration={
"create_incident": True,
"grouping_configuration": {
"enabled": True,
"group_by_alert_details": [azure_native.securityinsights.AlertDetail.DISPLAY_NAME],
"group_by_custom_details": [
"OperatingSystemType",
"OperatingSystemName",
],
"group_by_entities": [azure_native.securityinsights.EntityMappingType.HOST],
"lookback_duration": "PT5H",
"matching_method": azure_native.securityinsights.MatchingMethod.SELECTED,
"reopen_closed_incident": False,
},
},
kind="Scheduled",
query="Heartbeat",
query_frequency="PT1H",
query_period="P2DT1H30M",
resource_group_name="myRg",
rule_id="73e01a99-5cd7-4139-a149-9f2736ff2ab5",
severity=azure_native.securityinsights.AlertSeverity.HIGH,
suppression_duration="PT1H",
suppression_enabled=False,
tactics=[
azure_native.securityinsights.AttackTactic.PERSISTENCE,
azure_native.securityinsights.AttackTactic.LATERAL_MOVEMENT,
],
trigger_operator=azure_native.securityinsights.TriggerOperator.GREATER_THAN,
trigger_threshold=0,
workspace_name="myWorkspace")
resources:
scheduledAlertRule:
type: azure-native:securityinsights:ScheduledAlertRule
properties:
alertDetailsOverride:
alertDescriptionFormat: Suspicious activity was made by {{ComputerIP}}
alertDisplayNameFormat: Alert from {{Computer}}
alertDynamicProperties:
- alertProperty: ProductComponentName
value: ProductComponentNameCustomColumn
- alertProperty: ProductName
value: ProductNameCustomColumn
- alertProperty: AlertLink
value: Link
customDetails:
OperatingSystemName: OSName
OperatingSystemType: OSType
description: An example for a scheduled rule
displayName: My scheduled rule
enabled: true
entityMappings:
- entityType: Host
fieldMappings:
- columnName: Computer
identifier: FullName
- entityType: IP
fieldMappings:
- columnName: ComputerIP
identifier: Address
eventGroupingSettings:
aggregationKind: AlertPerResult
incidentConfiguration:
createIncident: true
groupingConfiguration:
enabled: true
groupByAlertDetails:
- DisplayName
groupByCustomDetails:
- OperatingSystemType
- OperatingSystemName
groupByEntities:
- Host
lookbackDuration: PT5H
matchingMethod: Selected
reopenClosedIncident: false
kind: Scheduled
query: Heartbeat
queryFrequency: PT1H
queryPeriod: P2DT1H30M
resourceGroupName: myRg
ruleId: 73e01a99-5cd7-4139-a149-9f2736ff2ab5
severity: High
suppressionDuration: PT1H
suppressionEnabled: false
tactics:
- Persistence
- LateralMovement
triggerOperator: GreaterThan
triggerThreshold: 0
workspaceName: myWorkspace
Create ScheduledAlertRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def ScheduledAlertRule(resource_name: str,
args: ScheduledAlertRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ScheduledAlertRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
suppression_enabled: Optional[bool] = None,
workspace_name: Optional[str] = None,
trigger_threshold: Optional[int] = None,
trigger_operator: Optional[TriggerOperator] = None,
display_name: Optional[str] = None,
enabled: Optional[bool] = None,
resource_group_name: Optional[str] = None,
suppression_duration: Optional[str] = None,
severity: Optional[Union[str, AlertSeverity]] = None,
query: Optional[str] = None,
query_frequency: Optional[str] = None,
query_period: Optional[str] = None,
entity_mappings: Optional[Sequence[EntityMappingArgs]] = None,
rule_id: Optional[str] = None,
incident_configuration: Optional[IncidentConfigurationArgs] = None,
event_grouping_settings: Optional[EventGroupingSettingsArgs] = None,
alert_details_override: Optional[AlertDetailsOverrideArgs] = None,
tactics: Optional[Sequence[Union[str, AttackTactic]]] = None,
techniques: Optional[Sequence[str]] = None,
template_version: Optional[str] = None,
description: Optional[str] = None,
custom_details: Optional[Mapping[str, str]] = None,
alert_rule_template_name: Optional[str] = None)
type: azure-native:securityinsights:ScheduledAlertRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "azure-native_securityinsights_scheduled_alert_rule" "name" {
# resource properties
}
Parameters
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
ScheduledAlertRuleArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
ScheduledAlertRuleArgs
- 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 scheduledAlertRuleResource = new AzureNative.SecurityInsights.ScheduledAlertRule("scheduledAlertRuleResource", new()
{
SuppressionEnabled = false,
WorkspaceName = "string",
TriggerThreshold = 0,
TriggerOperator = AzureNative.SecurityInsights.TriggerOperator.GreaterThan,
DisplayName = "string",
Enabled = false,
ResourceGroupName = "string",
SuppressionDuration = "string",
Severity = "string",
Kind = "string",
Query = "string",
QueryFrequency = "string",
QueryPeriod = "string",
EntityMappings = new[]
{
new AzureNative.SecurityInsights.Inputs.EntityMappingArgs
{
EntityType = "string",
FieldMappings = new[]
{
new AzureNative.SecurityInsights.Inputs.FieldMappingArgs
{
ColumnName = "string",
Identifier = "string",
},
},
},
},
RuleId = "string",
IncidentConfiguration = new AzureNative.SecurityInsights.Inputs.IncidentConfigurationArgs
{
CreateIncident = false,
GroupingConfiguration = new AzureNative.SecurityInsights.Inputs.GroupingConfigurationArgs
{
Enabled = false,
LookbackDuration = "string",
MatchingMethod = "string",
ReopenClosedIncident = false,
GroupByAlertDetails =
{
"string",
},
GroupByCustomDetails = new[]
{
"string",
},
GroupByEntities =
{
"string",
},
},
},
EventGroupingSettings = new AzureNative.SecurityInsights.Inputs.EventGroupingSettingsArgs
{
AggregationKind = "string",
},
AlertDetailsOverride = new AzureNative.SecurityInsights.Inputs.AlertDetailsOverrideArgs
{
AlertDescriptionFormat = "string",
AlertDisplayNameFormat = "string",
AlertDynamicProperties = new[]
{
new AzureNative.SecurityInsights.Inputs.AlertPropertyMappingArgs
{
AlertProperty = "string",
Value = "string",
},
},
AlertSeverityColumnName = "string",
AlertTacticsColumnName = "string",
},
Tactics =
{
"string",
},
Techniques = new[]
{
"string",
},
TemplateVersion = "string",
Description = "string",
CustomDetails =
{
{ "string", "string" },
},
AlertRuleTemplateName = "string",
});
example, err := securityinsights.NewScheduledAlertRule(ctx, "scheduledAlertRuleResource", &securityinsights.ScheduledAlertRuleArgs{
SuppressionEnabled: pulumi.Bool(false),
WorkspaceName: pulumi.String("string"),
TriggerThreshold: pulumi.Int(0),
TriggerOperator: securityinsights.TriggerOperatorGreaterThan,
DisplayName: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ResourceGroupName: pulumi.String("string"),
SuppressionDuration: pulumi.String("string"),
Severity: pulumi.String("string"),
Kind: pulumi.String("string"),
Query: pulumi.String("string"),
QueryFrequency: pulumi.String("string"),
QueryPeriod: pulumi.String("string"),
EntityMappings: securityinsights.EntityMappingArray{
&securityinsights.EntityMappingArgs{
EntityType: pulumi.String("string"),
FieldMappings: securityinsights.FieldMappingArray{
&securityinsights.FieldMappingArgs{
ColumnName: pulumi.String("string"),
Identifier: pulumi.String("string"),
},
},
},
},
RuleId: pulumi.String("string"),
IncidentConfiguration: &securityinsights.IncidentConfigurationArgs{
CreateIncident: pulumi.Bool(false),
GroupingConfiguration: &securityinsights.GroupingConfigurationArgs{
Enabled: pulumi.Bool(false),
LookbackDuration: pulumi.String("string"),
MatchingMethod: pulumi.String("string"),
ReopenClosedIncident: pulumi.Bool(false),
GroupByAlertDetails: pulumi.StringArray{
pulumi.String("string"),
},
GroupByCustomDetails: pulumi.StringArray{
pulumi.String("string"),
},
GroupByEntities: pulumi.StringArray{
pulumi.String("string"),
},
},
},
EventGroupingSettings: &securityinsights.EventGroupingSettingsArgs{
AggregationKind: pulumi.String("string"),
},
AlertDetailsOverride: &securityinsights.AlertDetailsOverrideArgs{
AlertDescriptionFormat: pulumi.String("string"),
AlertDisplayNameFormat: pulumi.String("string"),
AlertDynamicProperties: securityinsights.AlertPropertyMappingArray{
&securityinsights.AlertPropertyMappingArgs{
AlertProperty: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
AlertSeverityColumnName: pulumi.String("string"),
AlertTacticsColumnName: pulumi.String("string"),
},
Tactics: pulumi.StringArray{
pulumi.String("string"),
},
Techniques: pulumi.StringArray{
pulumi.String("string"),
},
TemplateVersion: pulumi.String("string"),
Description: pulumi.String("string"),
CustomDetails: pulumi.StringMap{
"string": pulumi.String("string"),
},
AlertRuleTemplateName: pulumi.String("string"),
})
resource "azure-native_securityinsights_scheduled_alert_rule" "scheduledAlertRuleResource" {
lifecycle {
create_before_destroy = true
}
suppression_enabled = false
workspace_name = "string"
trigger_threshold = 0
trigger_operator = "GreaterThan"
display_name = "string"
enabled = false
resource_group_name = "string"
suppression_duration = "string"
severity = "string"
kind = "string"
query = "string"
query_frequency = "string"
query_period = "string"
entity_mappings {
entity_type = "string"
field_mappings {
column_name = "string"
identifier = "string"
}
}
rule_id = "string"
incident_configuration = {
create_incident = false
grouping_configuration = {
enabled = false
lookback_duration = "string"
matching_method = "string"
reopen_closed_incident = false
group_by_alert_details = ["string"]
group_by_custom_details = ["string"]
group_by_entities = ["string"]
}
}
event_grouping_settings = {
aggregation_kind = "string"
}
alert_details_override = {
alert_description_format = "string"
alert_display_name_format = "string"
alert_dynamic_properties = [{
alert_property = "string"
value = "string"
}]
alert_severity_column_name = "string"
alert_tactics_column_name = "string"
}
tactics = ["string"]
techniques = ["string"]
template_version = "string"
description = "string"
custom_details = {
"string" = "string"
}
alert_rule_template_name = "string"
}
var scheduledAlertRuleResource = new ScheduledAlertRule("scheduledAlertRuleResource", ScheduledAlertRuleArgs.builder()
.suppressionEnabled(false)
.workspaceName("string")
.triggerThreshold(0)
.triggerOperator(com.pulumi.azurenative.securityinsights.enums.TriggerOperator.GreaterThan)
.displayName("string")
.enabled(false)
.resourceGroupName("string")
.suppressionDuration("string")
.severity("string")
.query("string")
.queryFrequency("string")
.queryPeriod("string")
.entityMappings(EntityMappingArgs.builder()
.entityType("string")
.fieldMappings(FieldMappingArgs.builder()
.columnName("string")
.identifier("string")
.build())
.build())
.ruleId("string")
.incidentConfiguration(IncidentConfigurationArgs.builder()
.createIncident(false)
.groupingConfiguration(GroupingConfigurationArgs.builder()
.enabled(false)
.lookbackDuration("string")
.matchingMethod("string")
.reopenClosedIncident(false)
.groupByAlertDetails("string")
.groupByCustomDetails("string")
.groupByEntities("string")
.build())
.build())
.eventGroupingSettings(EventGroupingSettingsArgs.builder()
.aggregationKind("string")
.build())
.alertDetailsOverride(AlertDetailsOverrideArgs.builder()
.alertDescriptionFormat("string")
.alertDisplayNameFormat("string")
.alertDynamicProperties(AlertPropertyMappingArgs.builder()
.alertProperty("string")
.value("string")
.build())
.alertSeverityColumnName("string")
.alertTacticsColumnName("string")
.build())
.tactics("string")
.techniques("string")
.templateVersion("string")
.description("string")
.customDetails(Map.of("string", "string"))
.alertRuleTemplateName("string")
.build());
scheduled_alert_rule_resource = azure_native.securityinsights.ScheduledAlertRule("scheduledAlertRuleResource",
suppression_enabled=False,
workspace_name="string",
trigger_threshold=0,
trigger_operator=azure_native.securityinsights.TriggerOperator.GREATER_THAN,
display_name="string",
enabled=False,
resource_group_name="string",
suppression_duration="string",
severity="string",
kind="string",
query="string",
query_frequency="string",
query_period="string",
entity_mappings=[{
"entity_type": "string",
"field_mappings": [{
"column_name": "string",
"identifier": "string",
}],
}],
rule_id="string",
incident_configuration={
"create_incident": False,
"grouping_configuration": {
"enabled": False,
"lookback_duration": "string",
"matching_method": "string",
"reopen_closed_incident": False,
"group_by_alert_details": ["string"],
"group_by_custom_details": ["string"],
"group_by_entities": ["string"],
},
},
event_grouping_settings={
"aggregation_kind": "string",
},
alert_details_override={
"alert_description_format": "string",
"alert_display_name_format": "string",
"alert_dynamic_properties": [{
"alert_property": "string",
"value": "string",
}],
"alert_severity_column_name": "string",
"alert_tactics_column_name": "string",
},
tactics=["string"],
techniques=["string"],
template_version="string",
description="string",
custom_details={
"string": "string",
},
alert_rule_template_name="string")
const scheduledAlertRuleResource = new azure_native.securityinsights.ScheduledAlertRule("scheduledAlertRuleResource", {
suppressionEnabled: false,
workspaceName: "string",
triggerThreshold: 0,
triggerOperator: azure_native.securityinsights.TriggerOperator.GreaterThan,
displayName: "string",
enabled: false,
resourceGroupName: "string",
suppressionDuration: "string",
severity: "string",
kind: "string",
query: "string",
queryFrequency: "string",
queryPeriod: "string",
entityMappings: [{
entityType: "string",
fieldMappings: [{
columnName: "string",
identifier: "string",
}],
}],
ruleId: "string",
incidentConfiguration: {
createIncident: false,
groupingConfiguration: {
enabled: false,
lookbackDuration: "string",
matchingMethod: "string",
reopenClosedIncident: false,
groupByAlertDetails: ["string"],
groupByCustomDetails: ["string"],
groupByEntities: ["string"],
},
},
eventGroupingSettings: {
aggregationKind: "string",
},
alertDetailsOverride: {
alertDescriptionFormat: "string",
alertDisplayNameFormat: "string",
alertDynamicProperties: [{
alertProperty: "string",
value: "string",
}],
alertSeverityColumnName: "string",
alertTacticsColumnName: "string",
},
tactics: ["string"],
techniques: ["string"],
templateVersion: "string",
description: "string",
customDetails: {
string: "string",
},
alertRuleTemplateName: "string",
});
type: azure-native:securityinsights:ScheduledAlertRule
properties:
alertDetailsOverride:
alertDescriptionFormat: string
alertDisplayNameFormat: string
alertDynamicProperties:
- alertProperty: string
value: string
alertSeverityColumnName: string
alertTacticsColumnName: string
alertRuleTemplateName: string
customDetails:
string: string
description: string
displayName: string
enabled: false
entityMappings:
- entityType: string
fieldMappings:
- columnName: string
identifier: string
eventGroupingSettings:
aggregationKind: string
incidentConfiguration:
createIncident: false
groupingConfiguration:
enabled: false
groupByAlertDetails:
- string
groupByCustomDetails:
- string
groupByEntities:
- string
lookbackDuration: string
matchingMethod: string
reopenClosedIncident: false
kind: string
query: string
queryFrequency: string
queryPeriod: string
resourceGroupName: string
ruleId: string
severity: string
suppressionDuration: string
suppressionEnabled: false
tactics:
- string
techniques:
- string
templateVersion: string
triggerOperator: GreaterThan
triggerThreshold: 0
workspaceName: string
ScheduledAlertRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ScheduledAlertRule resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the ScheduledAlertRule resource produces the following output properties:
- AzureApiVersion
string
- The Azure API version of the resource.
- Id
string
- The provider-assigned unique ID for this managed resource.
- LastModifiedUtc
string
- The last time that this alert rule has been modified.
- Name
string
- The name of the resource
- SystemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Etag
string
- Etag of the azure resource
- azure_api_version
string
- The Azure API version of the resource.
- id
string
- The provider-assigned unique ID for this managed resource.
- last_modified_utc
string
- The last time that this alert rule has been modified.
- name
string
- The name of the resource
- system_data
object
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag
string
- Etag of the azure resource
- azureApiVersion
String
- The Azure API version of the resource.
- id
String
- The provider-assigned unique ID for this managed resource.
- lastModifiedUtc
String
- The last time that this alert rule has been modified.
- name
String
- The name of the resource
- systemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag
String
- Etag of the azure resource
- azureApiVersion
string
- The Azure API version of the resource.
- id
string
- The provider-assigned unique ID for this managed resource.
- lastModifiedUtc
string
- The last time that this alert rule has been modified.
- name
string
- The name of the resource
- systemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag
string
- Etag of the azure resource
- azure_api_version
str
- The Azure API version of the resource.
- id
str
- The provider-assigned unique ID for this managed resource.
- last_modified_utc
str
- The last time that this alert rule has been modified.
- name
str
- The name of the resource
- system_data
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag
str
- Etag of the azure resource
- azureApiVersion
String
- The Azure API version of the resource.
- id
String
- The provider-assigned unique ID for this managed resource.
- lastModifiedUtc
String
- The last time that this alert rule has been modified.
- name
String
- The name of the resource
- systemData
Property Map
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag
String
- Etag of the azure resource
Look up Existing ScheduledAlertRule Resource
Get an existing ScheduledAlertRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
func GetScheduledAlertRule(ctx *Context, name string, id IDInput, state *ScheduledAlertRuleState, opts ...ResourceOption) (*ScheduledAlertRule, error)
public static ScheduledAlertRule get(String name, Output<String> id, CustomResourceOptions options)
resources: existingScheduledAlertRule: type: azure-native:securityinsights:ScheduledAlertRule get: id: ${id}
import {
to = azure-native_securityinsights_scheduled_alert_rule.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
ScheduledAlertRuleState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
AlertDetail
Alert detail
| Name | Value | Description |
|---|
| DisplayName | DisplayName | Alert display name |
| Severity | Severity | Alert severity |
| Name | Value | Description |
|---|
| AlertDetailDisplayName | DisplayName | Alert display name |
| AlertDetailSeverity | Severity | Alert severity |
| Value | Description |
|---|
DisplayName | Alert display name |
Severity | Alert severity |
| Name | Value | Description |
|---|
| DisplayName | DisplayName | Alert display name |
| Severity | Severity | Alert severity |
| Name | Value | Description |
|---|
| DisplayName | DisplayName | Alert display name |
| Severity | Severity | Alert severity |
| Name | Value | Description |
|---|
| DISPLAY_NAME | DisplayName | Alert display name |
| SEVERITY | Severity | Alert severity |
| Value | Description |
|---|
DisplayName | Alert display name |
Severity | Alert severity |
AlertDetailsOverride, AlertDetailsOverrideArgs
Settings for how to dynamically override alert static details
AlertDetailsOverrideResponse
Settings for how to dynamically override alert static details
AlertProperty
The V3 alert property
| Name | Value | Description |
|---|
| AlertLink | AlertLink | Alert's link |
| ConfidenceLevel | ConfidenceLevel | Confidence level property |
| ConfidenceScore | ConfidenceScore | Confidence score |
| ExtendedLinks | ExtendedLinks | Extended links to the alert |
| ProductName | ProductName | Product name alert property |
| ProviderName | ProviderName | Provider name alert property |
| ProductComponentName | ProductComponentName | Product component name alert property |
| RemediationSteps | RemediationSteps | Remediation steps alert property |
| Techniques | Techniques | Techniques alert property |
| Name | Value | Description |
|---|
| AlertPropertyAlertLink | AlertLink | Alert's link |
| AlertPropertyConfidenceLevel | ConfidenceLevel | Confidence level property |
| AlertPropertyConfidenceScore | ConfidenceScore | Confidence score |
| AlertPropertyExtendedLinks | ExtendedLinks | Extended links to the alert |
| AlertPropertyProductName | ProductName | Product name alert property |
| AlertPropertyProviderName | ProviderName | Provider name alert property |
| AlertPropertyProductComponentName | ProductComponentName | Product component name alert property |
| AlertPropertyRemediationSteps | RemediationSteps | Remediation steps alert property |
| AlertPropertyTechniques | Techniques | Techniques alert property |
| Value | Description |
|---|
AlertLink | Alert's link |
ConfidenceLevel | Confidence level property |
ConfidenceScore | Confidence score |
ExtendedLinks | Extended links to the alert |
ProductName | Product name alert property |
ProviderName | Provider name alert property |
ProductComponentName | Product component name alert property |
RemediationSteps | Remediation steps alert property |
Techniques | Techniques alert property |
| Name | Value | Description |
|---|
| AlertLink | AlertLink | Alert's link |
| ConfidenceLevel | ConfidenceLevel | Confidence level property |
| ConfidenceScore | ConfidenceScore | Confidence score |
| ExtendedLinks | ExtendedLinks | Extended links to the alert |
| ProductName | ProductName | Product name alert property |
| ProviderName | ProviderName | Provider name alert property |
| ProductComponentName | ProductComponentName | Product component name alert property |
| RemediationSteps | RemediationSteps | Remediation steps alert property |
| Techniques | Techniques | Techniques alert property |
| Name | Value | Description |
|---|
| AlertLink | AlertLink | Alert's link |
| ConfidenceLevel | ConfidenceLevel | Confidence level property |
| ConfidenceScore | ConfidenceScore | Confidence score |
| ExtendedLinks | ExtendedLinks | Extended links to the alert |
| ProductName | ProductName | Product name alert property |
| ProviderName | ProviderName | Provider name alert property |
| ProductComponentName | ProductComponentName | Product component name alert property |
| RemediationSteps | RemediationSteps | Remediation steps alert property |
| Techniques | Techniques | Techniques alert property |
| Name | Value | Description |
|---|
| ALERT_LINK | AlertLink | Alert's link |
| CONFIDENCE_LEVEL | ConfidenceLevel | Confidence level property |
| CONFIDENCE_SCORE | ConfidenceScore | Confidence score |
| EXTENDED_LINKS | ExtendedLinks | Extended links to the alert |
| PRODUCT_NAME | ProductName | Product name alert property |
| PROVIDER_NAME | ProviderName | Provider name alert property |
| PRODUCT_COMPONENT_NAME | ProductComponentName | Product component name alert property |
| REMEDIATION_STEPS | RemediationSteps | Remediation steps alert property |
| TECHNIQUES | Techniques | Techniques alert property |
| Value | Description |
|---|
AlertLink | Alert's link |
ConfidenceLevel | Confidence level property |
ConfidenceScore | Confidence score |
ExtendedLinks | Extended links to the alert |
ProductName | Product name alert property |
ProviderName | Provider name alert property |
ProductComponentName | Product component name alert property |
RemediationSteps | Remediation steps alert property |
Techniques | Techniques alert property |
AlertPropertyMapping, AlertPropertyMappingArgs
A single alert property mapping to override
AlertPropertyMappingResponse
A single alert property mapping to override
- AlertProperty
string
- The V3 alert property
- Value
string
- the column name to use to override this property
- AlertProperty
string
- The V3 alert property
- Value
string
- the column name to use to override this property
- alert_property
string
- The V3 alert property
- value
string
- the column name to use to override this property
- alertProperty
String
- The V3 alert property
- value
String
- the column name to use to override this property
- alertProperty
string
- The V3 alert property
- value
string
- the column name to use to override this property
- alert_property
str
- The V3 alert property
- value
str
- the column name to use to override this property
- alertProperty
String
- The V3 alert property
- value
String
- the column name to use to override this property
AlertSeverity
The severity for alerts created by this alert rule.
| Name | Value | Description |
|---|
| High | High | High severity |
| Medium | Medium | Medium severity |
| Low | Low | Low severity |
| Informational | Informational | Informational severity |
| Name | Value | Description |
|---|
| AlertSeverityHigh | High | High severity |
| AlertSeverityMedium | Medium | Medium severity |
| AlertSeverityLow | Low | Low severity |
| AlertSeverityInformational | Informational | Informational severity |
| Value | Description |
|---|
High | High severity |
Medium | Medium severity |
Low | Low severity |
Informational | Informational severity |
| Name | Value | Description |
|---|
| High | High | High severity |
| Medium | Medium | Medium severity |
| Low | Low | Low severity |
| Informational | Informational | Informational severity |
| Name | Value | Description |
|---|
| High | High | High severity |
| Medium | Medium | Medium severity |
| Low | Low | Low severity |
| Informational | Informational | Informational severity |
| Name | Value | Description |
|---|
| HIGH | High | High severity |
| MEDIUM | Medium | Medium severity |
| LOW | Low | Low severity |
| INFORMATIONAL | Informational | Informational severity |
| Value | Description |
|---|
High | High severity |
Medium | Medium severity |
Low | Low severity |
Informational | Informational severity |
AttackTactic
The severity for alerts created by this alert rule.
| Name | Value |
|---|
| Reconnaissance | Reconnaissance |
| ResourceDevelopment | ResourceDevelopment |
| InitialAccess | InitialAccess |
| Execution | Execution |
| Persistence | Persistence |
| PrivilegeEscalation | PrivilegeEscalation |
| DefenseEvasion | DefenseEvasion |
| CredentialAccess | CredentialAccess |
| Discovery | Discovery |
| LateralMovement | LateralMovement |
| Collection | Collection |
| Exfiltration | Exfiltration |
| CommandAndControl | CommandAndControl |
| Impact | Impact |
| PreAttack | PreAttack |
| ImpairProcessControl | ImpairProcessControl |
| InhibitResponseFunction | InhibitResponseFunction |
| Name | Value |
|---|
| AttackTacticReconnaissance | Reconnaissance |
| AttackTacticResourceDevelopment | ResourceDevelopment |
| AttackTacticInitialAccess | InitialAccess |
| AttackTacticExecution | Execution |
| AttackTacticPersistence | Persistence |
| AttackTacticPrivilegeEscalation | PrivilegeEscalation |
| AttackTacticDefenseEvasion | DefenseEvasion |
| AttackTacticCredentialAccess | CredentialAccess |
| AttackTacticDiscovery | Discovery |
| AttackTacticLateralMovement | LateralMovement |
| AttackTacticCollection | Collection |
| AttackTacticExfiltration | Exfiltration |
| AttackTacticCommandAndControl | CommandAndControl |
| AttackTacticImpact | Impact |
| AttackTacticPreAttack | PreAttack |
| AttackTacticImpairProcessControl | ImpairProcessControl |
| AttackTacticInhibitResponseFunction | InhibitResponseFunction |
| Value |
|---|
Reconnaissance |
ResourceDevelopment |
InitialAccess |
Execution |
Persistence |
PrivilegeEscalation |
DefenseEvasion |
CredentialAccess |
Discovery |
LateralMovement |
Collection |
Exfiltration |
CommandAndControl |
Impact |
PreAttack |
ImpairProcessControl |
InhibitResponseFunction |
| Name | Value |
|---|
| Reconnaissance | Reconnaissance |
| ResourceDevelopment | ResourceDevelopment |
| InitialAccess | InitialAccess |
| Execution | Execution |
| Persistence | Persistence |
| PrivilegeEscalation | PrivilegeEscalation |
| DefenseEvasion | DefenseEvasion |
| CredentialAccess | CredentialAccess |
| Discovery | Discovery |
| LateralMovement | LateralMovement |
| Collection | Collection |
| Exfiltration | Exfiltration |
| CommandAndControl | CommandAndControl |
| Impact | Impact |
| PreAttack | PreAttack |
| ImpairProcessControl | ImpairProcessControl |
| InhibitResponseFunction | InhibitResponseFunction |
| Name | Value |
|---|
| Reconnaissance | Reconnaissance |
| ResourceDevelopment | ResourceDevelopment |
| InitialAccess | InitialAccess |
| Execution | Execution |
| Persistence | Persistence |
| PrivilegeEscalation | PrivilegeEscalation |
| DefenseEvasion | DefenseEvasion |
| CredentialAccess | CredentialAccess |
| Discovery | Discovery |
| LateralMovement | LateralMovement |
| Collection | Collection |
| Exfiltration | Exfiltration |
| CommandAndControl | CommandAndControl |
| Impact | Impact |
| PreAttack | PreAttack |
| ImpairProcessControl | ImpairProcessControl |
| InhibitResponseFunction | InhibitResponseFunction |
| Name | Value |
|---|
| RECONNAISSANCE | Reconnaissance |
| RESOURCE_DEVELOPMENT | ResourceDevelopment |
| INITIAL_ACCESS | InitialAccess |
| EXECUTION | Execution |
| PERSISTENCE | Persistence |
| PRIVILEGE_ESCALATION | PrivilegeEscalation |
| DEFENSE_EVASION | DefenseEvasion |
| CREDENTIAL_ACCESS | CredentialAccess |
| DISCOVERY | Discovery |
| LATERAL_MOVEMENT | LateralMovement |
| COLLECTION | Collection |
| EXFILTRATION | Exfiltration |
| COMMAND_AND_CONTROL | CommandAndControl |
| IMPACT | Impact |
| PRE_ATTACK | PreAttack |
| IMPAIR_PROCESS_CONTROL | ImpairProcessControl |
| INHIBIT_RESPONSE_FUNCTION | InhibitResponseFunction |
| Value |
|---|
Reconnaissance |
ResourceDevelopment |
InitialAccess |
Execution |
Persistence |
PrivilegeEscalation |
DefenseEvasion |
CredentialAccess |
Discovery |
LateralMovement |
Collection |
Exfiltration |
CommandAndControl |
Impact |
PreAttack |
ImpairProcessControl |
InhibitResponseFunction |
EntityMapping, EntityMappingArgs
Single entity mapping for the alert rule
EntityMappingResponse
Single entity mapping for the alert rule
EntityMappingType
The V3 type of the mapped entity
| Name | Value | Description |
|---|
| Account | Account | User account entity type |
| Host | Host | Host entity type |
| IP | IP | IP address entity type |
| Malware | Malware | Malware entity type |
| File | File | System file entity type |
| Process | Process | Process entity type |
| CloudApplication | CloudApplication | Cloud app entity type |
| DNS | DNS | DNS entity type |
| AzureResource | AzureResource | Azure resource entity type |
| FileHash | FileHash | File-hash entity type |
| RegistryKey | RegistryKey | Registry key entity type |
| RegistryValue | RegistryValue | Registry value entity type |
| SecurityGroup | SecurityGroup | Security group entity type |
| URL | URL | URL entity type |
| Mailbox | Mailbox | Mailbox entity type |
| MailCluster | MailCluster | Mail cluster entity type |
| MailMessage | MailMessage | Mail message entity type |
| SubmissionMail | SubmissionMail | Submission mail entity type |
| Name | Value | Description |
|---|
| EntityMappingTypeAccount | Account | User account entity type |
| EntityMappingTypeHost | Host | Host entity type |
| EntityMappingTypeIP | IP | IP address entity type |
| EntityMappingTypeMalware | Malware | Malware entity type |
| EntityMappingTypeFile | File | System file entity type |
| EntityMappingTypeProcess | Process | Process entity type |
| EntityMappingTypeCloudApplication | CloudApplication | Cloud app entity type |
| EntityMappingTypeDNS | DNS | DNS entity type |
| EntityMappingTypeAzureResource | AzureResource | Azure resource entity type |
| EntityMappingTypeFileHash | FileHash | File-hash entity type |
| EntityMappingTypeRegistryKey | RegistryKey | Registry key entity type |
| EntityMappingTypeRegistryValue | RegistryValue | Registry value entity type |
| EntityMappingTypeSecurityGroup | SecurityGroup | Security group entity type |
| EntityMappingTypeURL | URL | URL entity type |
| EntityMappingTypeMailbox | Mailbox | Mailbox entity type |
| EntityMappingTypeMailCluster | MailCluster | Mail cluster entity type |
| EntityMappingTypeMailMessage | MailMessage | Mail message entity type |
| EntityMappingTypeSubmissionMail | SubmissionMail | Submission mail entity type |
| Value | Description |
|---|
Account | User account entity type |
Host | Host entity type |
IP | IP address entity type |
Malware | Malware entity type |
File | System file entity type |
Process | Process entity type |
CloudApplication | Cloud app entity type |
DNS | DNS entity type |
AzureResource | Azure resource entity type |
FileHash | File-hash entity type |
RegistryKey | Registry key entity type |
RegistryValue | Registry value entity type |
SecurityGroup | Security group entity type |
URL | URL entity type |
Mailbox | Mailbox entity type |
MailCluster | Mail cluster entity type |
MailMessage | Mail message entity type |
SubmissionMail | Submission mail entity type |
| Name | Value | Description |
|---|
| Account | Account | User account entity type |
| Host | Host | Host entity type |
| IP | IP | IP address entity type |
| Malware | Malware | Malware entity type |
| File | File | System file entity type |
| Process | Process | Process entity type |
| CloudApplication | CloudApplication | Cloud app entity type |
| DNS | DNS | DNS entity type |
| AzureResource | AzureResource | Azure resource entity type |
| FileHash | FileHash | File-hash entity type |
| RegistryKey | RegistryKey | Registry key entity type |
| RegistryValue | RegistryValue | Registry value entity type |
| SecurityGroup | SecurityGroup | Security group entity type |
| URL | URL | URL entity type |
| Mailbox | Mailbox | Mailbox entity type |
| MailCluster | MailCluster | Mail cluster entity type |
| MailMessage | MailMessage | Mail message entity type |
| SubmissionMail | SubmissionMail | Submission mail entity type |
| Name | Value | Description |
|---|
| Account | Account | User account entity type |
| Host | Host | Host entity type |
| IP | IP | IP address entity type |
| Malware | Malware | Malware entity type |
| File | File | System file entity type |
| Process | Process | Process entity type |
| CloudApplication | CloudApplication | Cloud app entity type |
| DNS | DNS | DNS entity type |
| AzureResource | AzureResource | Azure resource entity type |
| FileHash | FileHash | File-hash entity type |
| RegistryKey | RegistryKey | Registry key entity type |
| RegistryValue | RegistryValue | Registry value entity type |
| SecurityGroup | SecurityGroup | Security group entity type |
| URL | URL | URL entity type |
| Mailbox | Mailbox | Mailbox entity type |
| MailCluster | MailCluster | Mail cluster entity type |
| MailMessage | MailMessage | Mail message entity type |
| SubmissionMail | SubmissionMail | Submission mail entity type |
| Name | Value | Description |
|---|
| ACCOUNT | Account | User account entity type |
| HOST | Host | Host entity type |
| IP | IP | IP address entity type |
| MALWARE | Malware | Malware entity type |
| FILE | File | System file entity type |
| PROCESS | Process | Process entity type |
| CLOUD_APPLICATION | CloudApplication | Cloud app entity type |
| DNS | DNS | DNS entity type |
| AZURE_RESOURCE | AzureResource | Azure resource entity type |
| FILE_HASH | FileHash | File-hash entity type |
| REGISTRY_KEY | RegistryKey | Registry key entity type |
| REGISTRY_VALUE | RegistryValue | Registry value entity type |
| SECURITY_GROUP | SecurityGroup | Security group entity type |
| URL | URL | URL entity type |
| MAILBOX | Mailbox | Mailbox entity type |
| MAIL_CLUSTER | MailCluster | Mail cluster entity type |
| MAIL_MESSAGE | MailMessage | Mail message entity type |
| SUBMISSION_MAIL | SubmissionMail | Submission mail entity type |
| Value | Description |
|---|
Account | User account entity type |
Host | Host entity type |
IP | IP address entity type |
Malware | Malware entity type |
File | System file entity type |
Process | Process entity type |
CloudApplication | Cloud app entity type |
DNS | DNS entity type |
AzureResource | Azure resource entity type |
FileHash | File-hash entity type |
RegistryKey | Registry key entity type |
RegistryValue | Registry value entity type |
SecurityGroup | Security group entity type |
URL | URL entity type |
Mailbox | Mailbox entity type |
MailCluster | Mail cluster entity type |
MailMessage | Mail message entity type |
SubmissionMail | Submission mail entity type |
EventGroupingAggregationKind
The event grouping aggregation kinds
| Name | Value |
|---|
| SingleAlert | SingleAlert |
| AlertPerResult | AlertPerResult |
| Name | Value |
|---|
| EventGroupingAggregationKindSingleAlert | SingleAlert |
| EventGroupingAggregationKindAlertPerResult | AlertPerResult |
| Value |
|---|
SingleAlert |
AlertPerResult |
| Name | Value |
|---|
| SingleAlert | SingleAlert |
| AlertPerResult | AlertPerResult |
| Name | Value |
|---|
| SingleAlert | SingleAlert |
| AlertPerResult | AlertPerResult |
| Name | Value |
|---|
| SINGLE_ALERT | SingleAlert |
| ALERT_PER_RESULT | AlertPerResult |
| Value |
|---|
SingleAlert |
AlertPerResult |
EventGroupingSettings, EventGroupingSettingsArgs
Event grouping settings property bag.
EventGroupingSettingsResponse
Event grouping settings property bag.
FieldMapping, FieldMappingArgs
A single field mapping of the mapped entity
- ColumnName
string
- the column name to be mapped to the identifier
- Identifier
string
- the V3 identifier of the entity
- ColumnName
string
- the column name to be mapped to the identifier
- Identifier
string
- the V3 identifier of the entity
- column_name
string
- the column name to be mapped to the identifier
- identifier
string
- the V3 identifier of the entity
- columnName
String
- the column name to be mapped to the identifier
- identifier
String
- the V3 identifier of the entity
- columnName
string
- the column name to be mapped to the identifier
- identifier
string
- the V3 identifier of the entity
- column_name
str
- the column name to be mapped to the identifier
- identifier
str
- the V3 identifier of the entity
- columnName
String
- the column name to be mapped to the identifier
- identifier
String
- the V3 identifier of the entity
FieldMappingResponse
A single field mapping of the mapped entity
- ColumnName
string
- the column name to be mapped to the identifier
- Identifier
string
- the V3 identifier of the entity
- ColumnName
string
- the column name to be mapped to the identifier
- Identifier
string
- the V3 identifier of the entity
- column_name
string
- the column name to be mapped to the identifier
- identifier
string
- the V3 identifier of the entity
- columnName
String
- the column name to be mapped to the identifier
- identifier
String
- the V3 identifier of the entity
- columnName
string
- the column name to be mapped to the identifier
- identifier
string
- the V3 identifier of the entity
- column_name
str
- the column name to be mapped to the identifier
- identifier
str
- the V3 identifier of the entity
- columnName
String
- the column name to be mapped to the identifier
- identifier
String
- the V3 identifier of the entity
GroupingConfiguration, GroupingConfigurationArgs
Grouping configuration property bag.
- Enabled
bool
- Grouping enabled
- LookbackDuration
string
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- MatchingMethod
string | Pulumi.AzureNative.SecurityInsights.MatchingMethod
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- ReopenClosedIncident
bool
- Re-open closed matching incidents
- GroupByAlertDetails
List<Union<string, Pulumi.AzureNative.SecurityInsights.AlertDetail>>
- A list of alert details to group by (when matchingMethod is Selected)
- GroupByCustomDetails
List<string>
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- GroupByEntities
List<Union<string, Pulumi.AzureNative.SecurityInsights.EntityMappingType>>
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- Enabled
bool
- Grouping enabled
- LookbackDuration
string
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- MatchingMethod
string | MatchingMethod
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- ReopenClosedIncident
bool
- Re-open closed matching incidents
- GroupByAlertDetails
[]string
- A list of alert details to group by (when matchingMethod is Selected)
- GroupByCustomDetails
[]string
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- GroupByEntities
[]string
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
bool
- Grouping enabled
- lookback_duration
string
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matching_method
string | "AllEntities" | "AnyAlert" | "Selected"
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopen_closed_incident
bool
- Re-open closed matching incidents
- group_by_alert_details
list(string | "DisplayName" | "Severity")
- A list of alert details to group by (when matchingMethod is Selected)
- group_by_custom_details
list(string)
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- group_by_entities
list(string | "Account" | "Host" | "IP" | "Malware" | "File" | "Process" | "CloudApplication" | "DNS" | "AzureResource" | "FileHash" | "RegistryKey" | "RegistryValue" | "SecurityGroup" | "URL" | "Mailbox" | "MailCluster" | "MailMessage" | "SubmissionMail")
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
Boolean
- Grouping enabled
- lookbackDuration
String
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matchingMethod
String | MatchingMethod
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopenClosedIncident
Boolean
- Re-open closed matching incidents
- groupByAlertDetails
List<Either<String,AlertDetail>>
- A list of alert details to group by (when matchingMethod is Selected)
- groupByCustomDetails
List<String>
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- groupByEntities
List<Either<String,EntityMappingType>>
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
boolean
- Grouping enabled
- lookbackDuration
string
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matchingMethod
string | MatchingMethod
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopenClosedIncident
boolean
- Re-open closed matching incidents
- groupByAlertDetails
(string | AlertDetail)[]
- A list of alert details to group by (when matchingMethod is Selected)
- groupByCustomDetails
string[]
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- groupByEntities
(string | EntityMappingType)[]
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
bool
- Grouping enabled
- lookback_duration
str
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matching_method
str | MatchingMethod
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopen_closed_incident
bool
- Re-open closed matching incidents
- group_by_alert_details
Sequence[Union[str, AlertDetail]]
- A list of alert details to group by (when matchingMethod is Selected)
- group_by_custom_details
Sequence[str]
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- group_by_entities
Sequence[Union[str, EntityMappingType]]
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
Boolean
- Grouping enabled
- lookbackDuration
String
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matchingMethod
String | "AllEntities" | "AnyAlert" | "Selected"
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopenClosedIncident
Boolean
- Re-open closed matching incidents
- groupByAlertDetails
List<String | "DisplayName" | "Severity">
- A list of alert details to group by (when matchingMethod is Selected)
- groupByCustomDetails
List<String>
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- groupByEntities
List<String | "Account" | "Host" | "IP" | "Malware" | "File" | "Process" | "CloudApplication" | "DNS" | "AzureResource" | "FileHash" | "RegistryKey" | "RegistryValue" | "SecurityGroup" | "URL" | "Mailbox" | "MailCluster" | "MailMessage" | "SubmissionMail">
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
GroupingConfigurationResponse
Grouping configuration property bag.
- Enabled
bool
- Grouping enabled
- LookbackDuration
string
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- MatchingMethod
string
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- ReopenClosedIncident
bool
- Re-open closed matching incidents
- GroupByAlertDetails
List<string>
- A list of alert details to group by (when matchingMethod is Selected)
- GroupByCustomDetails
List<string>
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- GroupByEntities
List<string>
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- Enabled
bool
- Grouping enabled
- LookbackDuration
string
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- MatchingMethod
string
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- ReopenClosedIncident
bool
- Re-open closed matching incidents
- GroupByAlertDetails
[]string
- A list of alert details to group by (when matchingMethod is Selected)
- GroupByCustomDetails
[]string
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- GroupByEntities
[]string
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
bool
- Grouping enabled
- lookback_duration
string
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matching_method
string
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopen_closed_incident
bool
- Re-open closed matching incidents
- group_by_alert_details
list(string)
- A list of alert details to group by (when matchingMethod is Selected)
- group_by_custom_details
list(string)
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- group_by_entities
list(string)
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
Boolean
- Grouping enabled
- lookbackDuration
String
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matchingMethod
String
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopenClosedIncident
Boolean
- Re-open closed matching incidents
- groupByAlertDetails
List<String>
- A list of alert details to group by (when matchingMethod is Selected)
- groupByCustomDetails
List<String>
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- groupByEntities
List<String>
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
boolean
- Grouping enabled
- lookbackDuration
string
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matchingMethod
string
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopenClosedIncident
boolean
- Re-open closed matching incidents
- groupByAlertDetails
string[]
- A list of alert details to group by (when matchingMethod is Selected)
- groupByCustomDetails
string[]
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- groupByEntities
string[]
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
bool
- Grouping enabled
- lookback_duration
str
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matching_method
str
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopen_closed_incident
bool
- Re-open closed matching incidents
- group_by_alert_details
Sequence[str]
- A list of alert details to group by (when matchingMethod is Selected)
- group_by_custom_details
Sequence[str]
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- group_by_entities
Sequence[str]
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
- enabled
Boolean
- Grouping enabled
- lookbackDuration
String
- Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)
- matchingMethod
String
- Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
- reopenClosedIncident
Boolean
- Re-open closed matching incidents
- groupByAlertDetails
List<String>
- A list of alert details to group by (when matchingMethod is Selected)
- groupByCustomDetails
List<String>
- A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.
- groupByEntities
List<String>
- A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.
IncidentConfiguration, IncidentConfigurationArgs
Incident Configuration property bag.
IncidentConfigurationResponse
Incident Configuration property bag.
MatchingMethod
Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.
| Name | Value | Description |
|---|
| AllEntities | AllEntities | Grouping alerts into a single incident if all the entities match |
| AnyAlert | AnyAlert | Grouping any alerts triggered by this rule into a single incident |
| Selected | Selected | Grouping alerts into a single incident if the selected entities, custom details and alert details match |
| Name | Value | Description |
|---|
| MatchingMethodAllEntities | AllEntities | Grouping alerts into a single incident if all the entities match |
| MatchingMethodAnyAlert | AnyAlert | Grouping any alerts triggered by this rule into a single incident |
| MatchingMethodSelected | Selected | Grouping alerts into a single incident if the selected entities, custom details and alert details match |
| Value | Description |
|---|
AllEntities | Grouping alerts into a single incident if all the entities match |
AnyAlert | Grouping any alerts triggered by this rule into a single incident |
Selected | Grouping alerts into a single incident if the selected entities, custom details and alert details match |
| Name | Value | Description |
|---|
| AllEntities | AllEntities | Grouping alerts into a single incident if all the entities match |
| AnyAlert | AnyAlert | Grouping any alerts triggered by this rule into a single incident |
| Selected | Selected | Grouping alerts into a single incident if the selected entities, custom details and alert details match |
| Name | Value | Description |
|---|
| AllEntities | AllEntities | Grouping alerts into a single incident if all the entities match |
| AnyAlert | AnyAlert | Grouping any alerts triggered by this rule into a single incident |
| Selected | Selected | Grouping alerts into a single incident if the selected entities, custom details and alert details match |
| Name | Value | Description |
|---|
| ALL_ENTITIES | AllEntities | Grouping alerts into a single incident if all the entities match |
| ANY_ALERT | AnyAlert | Grouping any alerts triggered by this rule into a single incident |
| SELECTED | Selected | Grouping alerts into a single incident if the selected entities, custom details and alert details match |
| Value | Description |
|---|
AllEntities | Grouping alerts into a single incident if all the entities match |
AnyAlert | Grouping any alerts triggered by this rule into a single incident |
Selected | Grouping alerts into a single incident if the selected entities, custom details and alert details match |
SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
- CreatedAt
string
- The timestamp of resource creation (UTC).
- CreatedBy
string
- The identity that created the resource.
- CreatedByType
string
- The type of identity that created the resource.
- LastModifiedAt
string
- The timestamp of resource last modification (UTC)
- LastModifiedBy
string
- The identity that last modified the resource.
- LastModifiedByType
string
- The type of identity that last modified the resource.
- CreatedAt
string
- The timestamp of resource creation (UTC).
- CreatedBy
string
- The identity that created the resource.
- CreatedByType
string
- The type of identity that created the resource.
- LastModifiedAt
string
- The timestamp of resource last modification (UTC)
- LastModifiedBy
string
- The identity that last modified the resource.
- LastModifiedByType
string
- The type of identity that last modified the resource.
- createdAt
String
- The timestamp of resource creation (UTC).
- createdBy
String
- The identity that created the resource.
- createdByType
String
- The type of identity that created the resource.
- lastModifiedAt
String
- The timestamp of resource last modification (UTC)
- lastModifiedBy
String
- The identity that last modified the resource.
- lastModifiedByType
String
- The type of identity that last modified the resource.
- createdAt
string
- The timestamp of resource creation (UTC).
- createdBy
string
- The identity that created the resource.
- createdByType
string
- The type of identity that created the resource.
- lastModifiedAt
string
- The timestamp of resource last modification (UTC)
- lastModifiedBy
string
- The identity that last modified the resource.
- lastModifiedByType
string
- The type of identity that last modified the resource.
- createdAt
String
- The timestamp of resource creation (UTC).
- createdBy
String
- The identity that created the resource.
- createdByType
String
- The type of identity that created the resource.
- lastModifiedAt
String
- The timestamp of resource last modification (UTC)
- lastModifiedBy
String
- The identity that last modified the resource.
- lastModifiedByType
String
- The type of identity that last modified the resource.
TriggerOperator
The operation against the threshold that triggers alert rule.
| Name | Value |
|---|
| GreaterThan | GreaterThan |
| LessThan | LessThan |
| Equal | Equal |
| NotEqual | NotEqual |
| Name | Value |
|---|
| TriggerOperatorGreaterThan | GreaterThan |
| TriggerOperatorLessThan | LessThan |
| TriggerOperatorEqual | Equal |
| TriggerOperatorNotEqual | NotEqual |
| Value |
|---|
GreaterThan |
LessThan |
Equal |
NotEqual |
| Name | Value |
|---|
| GreaterThan | GreaterThan |
| LessThan | LessThan |
| Equal | Equal |
| NotEqual | NotEqual |
| Name | Value |
|---|
| GreaterThan | GreaterThan |
| LessThan | LessThan |
| Equal | Equal |
| NotEqual | NotEqual |
| Name | Value |
|---|
| GREATER_THAN | GreaterThan |
| LESS_THAN | LessThan |
| EQUAL | Equal |
| NOT_EQUAL | NotEqual |
| Value |
|---|
GreaterThan |
LessThan |
Equal |
NotEqual |
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:securityinsights:ScheduledAlertRule 73e01a99-5cd7-4139-a149-9f2736ff2ab5 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0