Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AlertRules- Add SentinelEntities and extend AlertDetailsOverride #20645

Merged
merged 2 commits into from
Sep 13, 2022
Merged

AlertRules- Add SentinelEntities and extend AlertDetailsOverride #20645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21e1963
Add SentinelEntities and extend AlertDetailsOverride
necoh Sep 8, 2022
129cef2
Add SentinelEntities and extend AlertDetailsOverride
necoh Sep 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions ...ts/resource-manager/Microsoft.SecurityInsights/preview/2022-10-01-preview/AlertRules.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -797,6 +797,10 @@
"eventGroupingSettings": {
"$ref": "#/definitions/EventGroupingSettings",
"description": "The event grouping settings."
},
"sentinelEntitiesMappings": {
"$ref": "#/definitions/SentinelEntitiesMappings",
"description": "Array of the sentinel entity mappings of the alert rule"
}
},
"type": "object"
Expand Down Expand Up @@ -1759,6 +1763,10 @@
"eventGroupingSettings": {
"$ref": "#/definitions/EventGroupingSettings",
"description": "The event grouping settings."
},
"sentinelEntitiesMappings": {
"$ref": "#/definitions/SentinelEntitiesMappings",
"description": "Array of the sentinel entity mappings of the alert rule"
}
},
"required": [
Expand Down Expand Up @@ -1878,6 +1886,10 @@
"type": "object",
"$ref": "#/definitions/AlertDetailsOverride",
"description": "The alert details override settings"
},
"sentinelEntitiesMappings": {
"$ref": "#/definitions/SentinelEntitiesMappings",
"description": "Array of the sentinel entity mappings of the alert rule"
}
},
"type": "object"
Expand Down Expand Up @@ -2051,6 +2063,10 @@
"type": "object",
"$ref": "#/definitions/AlertDetailsOverride",
"description": "The alert details override settings"
},
"sentinelEntitiesMappings": {
"$ref": "#/definitions/SentinelEntitiesMappings",
"description": "Array of the sentinel entity mappings of the alert rule"
}
},
"type": "object"
Expand Down Expand Up @@ -2094,6 +2110,24 @@
},
"type": "object"
},
"SentinelEntitiesMappings": {
"description": "List of sentinel entity mappings of the alert rule",
"type": "array",
"items": {
"$ref": "#/definitions/SentinelEntityMapping"
},
"x-ms-identifiers": []
},
"SentinelEntityMapping": {
"description": "A single sentinel entity mapping",
"properties": {
"columnName": {
"description": "the column name to be mapped to the SentinelEntities",
"type": "string"
}
},
"type": "object"
},
"AlertDetailsOverride": {
"description": "Settings for how to dynamically override alert static details",
"properties": {
Expand All @@ -2112,6 +2146,27 @@
"alertSeverityColumnName": {
"description": "the column name to take the alert severity from",
"type": "string"
},
"alertDynamicProperties": {
"description": "List of additional dynamic properties to override",
"type": "array",
"items": {
"$ref": "#/definitions/AlertPropertyMapping"
},
"x-ms-identifiers": []
}
},
"type": "object"
},
"AlertPropertyMapping": {
"description": "A single alert property mapping to override",
"properties": {
"alertProperty": {
"$ref": "#/definitions/AlertProperty"
},
"value": {
"description": "the column name to use to override this property",
"type": "string"
}
},
"type": "object"
Expand Down Expand Up @@ -2426,6 +2481,63 @@
}
]
}
},
"AlertProperty": {
"description": "The V3 alert property",
"enum": [
"AlertLink",
"ConfidenceLevel",
"ConfidenceScore",
"ExtendedLinks",
"ProductName",
"ProviderName",
"ProductComponentName",
"RemediationSteps",
"Techniques"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "AlertProperty",
"values": [
{
"description": "Alert's link",
"value": "AlertLink"
},
{
"description": "Confidence level property",
"value": "ConfidenceLevel"
},
{
"description": "Confidence score",
"value": "ConfidenceScore"
},
{
"description": "Extended links to the alert",
"value": "ExtendedLinks"
},
{
"description": "Product name alert property",
"value": "ProductName"
},
{
"description": "Provider name alert property",
"value": "ProviderName"
},
{
"description": "Product component name alert property",
"value": "ProductComponentName"
},
{
"description": "Remediation steps alert property",
"value": "RemediationSteps"
},
{
"description": "Techniques alert property",
"value": "Techniques"
}
]
}
}
}
}
21 changes: 20 additions & 1 deletion ...rityInsights/preview/2022-10-01-preview/examples/alertRules/CreateScheduledAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,28 @@
]
}
],
"sentinelEntitiesMappings": [
{
"columnName": "Entities"
}
],
"alertDetailsOverride": {
"alertDisplayNameFormat": "Alert from {{Computer}}",
"alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}"
"alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}",
"alertDynamicProperties": [
{
"alertProperty": "ProductComponentName",
"value": "ProductComponentNameCustomColumn"
},
{
"alertProperty": "ProductName",
"value": "ProductNameCustomColumn"
},
{
"alertProperty": "AlertLink",
"value": "Link"
}
]
},
"incidentConfiguration": {
"createIncident": true,
Expand Down