File: create_scheduled_alert_rule.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (89 lines) | stat: -rw-r--r-- 4,157 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------

from azure.identity import DefaultAzureCredential
from azure.mgmt.securityinsight import SecurityInsights

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-securityinsight
# USAGE
    python create_scheduled_alert_rule.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityInsights(
        credential=DefaultAzureCredential(),
        subscription_id="d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
    )

    response = client.alert_rules.create_or_update(
        resource_group_name="myRg",
        workspace_name="myWorkspace",
        rule_id="73e01a99-5cd7-4139-a149-9f2736ff2ab5",
        alert_rule={
            "etag": '"0300bf09-0000-0000-0000-5c37296e0000"',
            "kind": "Scheduled",
            "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,
                    },
                },
                "query": "Heartbeat",
                "queryFrequency": "PT1H",
                "queryPeriod": "P2DT1H30M",
                "sentinelEntitiesMappings": [{"columnName": "Entities"}],
                "severity": "High",
                "suppressionDuration": "PT1H",
                "suppressionEnabled": False,
                "tactics": ["Persistence", "LateralMovement"],
                "techniques": ["T1037", "T1021"],
                "triggerOperator": "GreaterThan",
                "triggerThreshold": 0,
            },
        },
    )
    print(response)


# x-ms-original-file: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-12-01-preview/examples/alertRules/CreateScheduledAlertRule.json
if __name__ == "__main__":
    main()