Skip to content

Commit 00d6dc9

Browse files
committed
Final draft
1 parent d35a201 commit 00d6dc9

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

articles/sentinel/security-alert-schema.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,42 +27,42 @@ Because alerts come from many sources, not all fields are used by all providers.
2727

2828
## Schema definitions
2929

30-
| Column Name | Type | Description | *Questions* |
31-
| --- | --- | --- | --- |
30+
| Column Name | Type | Description |
31+
| --- | --- | --- |
3232
| **AlertLink** | string | A link to the alert in the portal of the originating product. |
33-
| **AlertName** | string | The display name of the alert. <ul><li>**Scheduled rule alerts:** taken from the rule name.<li>**Ingested alerts:** the display name of the alert in the originating product. | Check for correctness |
33+
| **AlertName** | string | The display name of the alert. <ul><li>**Scheduled rule alerts:** taken from the rule name.<li>**Ingested alerts:** the display name of the alert in the originating product. |
3434
| **AlertSeverity** | string | The severity of the alert. [Informational / Low / Medium / High] |
35-
| **AlertType** | string | The type of alert. <ul><li>**Scheduled rule alerts:** taken from the rule ID.<li>**Ingested alerts:** some products group their alerts by type. In some cases, may be identical to or synonymous with the product name. | Check for correctness |
35+
| **AlertType** | string | The type of alert. <ul><li>**Scheduled rule alerts:** taken from the rule ID.<li>**Ingested alerts:** some products group their alerts by type. In some cases, may be identical to or synonymous with the product name. |
3636
| **CompromisedEntity** | string | The display name of the main entity being alerted on. |
3737
| **ConfidenceLevel** | string | The confidence level of this alert: how sure the provider is that this is not a false positive. |
3838
| **ConfidenceScore** | real | The confidence score of the alert, on a scale of 0.0-1.0, if applicable. This property allows for a more fine-grained representation of the confidence level of the alert compared to the ConfidenceLevel field. |
3939
| **Description** | string | The description of the alert. |
40-
| **DisplayName** | string | The display name of the alert. Synonymous with **AlertName** but retained for compatibility. | Check for correctness |
41-
| **EndTime** | datetime | The end time of the impact of the alert. <ul><li>**Scheduled rule alerts:** the value of the TimeGenerated field for the last *event* captured by the query.<li>**Ingested alerts:** the time of the last event or activity included in the alert. | Check for correctness |
42-
| **Entities** | string | A list of the entities identified in the alert. This list can include a combination of entities of different types. The entities' types can be any of those defined in the schema, as described in the [entities documentation](entities-reference.md). | Can entities be identified in ingested alerts, or only in scheduled alerts that have entity mapping? |
40+
| **DisplayName** | string | The display name of the alert. Synonymous with *AlertName* but retained for compatibility. |
41+
| **EndTime** | datetime | The end time of the impact of the alert. <ul><li>**Scheduled rule alerts:** the value of the *TimeGenerated* field for the last *event* captured by the query.<li>**Ingested alerts:** the time of the last event or activity included in the alert. |
42+
| **Entities** | string | A list of the entities identified in the alert. This list can include a combination of entities of different types. The entities' types can be any of those defined in the schema, as described in the [entities documentation](entities-reference.md). |
4343
| **ExtendedLinks** | string | A bag (a collection) for all links related to the alert. This bag can include a combination of links of different types. |
4444
| **ExtendedProperties** | string | A collection of other properties of the alert, including user-defined properties. Any [custom details](surface-custom-details-in-alerts.md) defined in the alert, and any dynamic content in the [alert details](customize-alert-details.md), are stored here. | |
4545
| **IsIncident** | boolean | DEPRECATED. Always set to *false*. |
46-
| **ProcessingEndTime** | datetime | The time of the alert's publishing. For scheduled rule alerts, this is the value of the TimeGenerated field. | For ingested alerts, what is it? The ingestion time? How is it differentiated from *TimeGenerated*? |
47-
| **ProductComponentName** | string | The name of the component of the product that generated the alert. | Example of how this is different than *ProviderName*? |
46+
| **ProcessingEndTime** | datetime | The time of the alert's publishing. <ul><li>**Scheduled rule alerts:** the value of the *TimeGenerated* field.<li>**Ingested alerts:** the time that the originating product completes the production of the alert. |
47+
| **ProductComponentName** | string | The name of the component of the product that generated the alert. |
4848
| **ProductName** | string | The name of the product that generated the alert. |
49-
| **ProviderName** | string | The name of the alert provider - the service within the product - that generated the alert. | Example of how this is different than *ProductComponentName*? |
49+
| **ProviderName** | string | The name of the alert provider - the service within the product - that generated the alert. |
5050
| **RemediationSteps** | string | A list of action items to take to remediate the alert. |
5151
| **ResourceId** | string | A unique identifier for the resource that is the subject of the alert. |
5252
| **SourceComputerId** | string | DEPRECATED. Was the agent ID on the server that created the alert. |
5353
| **SourceSystem** | string | DEPRECATED. Always populated with the string "Detection". |
54-
| **StartTime** | datetime | The start time of the impact of the alert. <ul><li>**Scheduled rule alerts:** the value of the *TimeGenerated* field for the first *event* captured by the query.<li>**Ingested alerts:** the time of the first event or activity included in the alert. | Check for correctness |
54+
| **StartTime** | datetime | The start time of the impact of the alert. <ul><li>**Scheduled rule alerts:** the value of the *TimeGenerated* field for the first *event* captured by the query.<li>**Ingested alerts:** the time of the first event or activity included in the alert. |
5555
| **Status** | string | The status of the alert within the life cycle. [New / InProgress / Resolved / Dismissed / Unknown] |
5656
| **SystemAlertId** | string | The internal unique ID for the alert in Microsoft Sentinel. |
5757
| **Tactics** | string | A comma-delineated list of MITRE ATT&CK tactics associated with the alert. |
5858
| **Techniques** | string | A comma-delineated list of MITRE ATT&CK techniques associated with the alert. |
5959
| **TenantId** | string | The unique ID of the tenant. |
6060
| **TimeGenerated** | datetime | The time the alert was generated (in UTC). | Also for ingested alerts? Or is it the ingestion time for those? |
61-
| **Type** | string | The constant ('SecurityAlert') | Check for correctness |
61+
| **Type** | string | The constant ('SecurityAlert') |
6262
| **VendorName** | string | The vendor of the product that produced the alert. |
6363
| **VendorOriginalId** | string | Unique ID for the specific alert instance, set by the originating product. |
64-
| **WorkspaceResourceGroup** | string | DEPRECATED. Was the Azure resource group of the Log Analytics workspace containing the resource that generated the alert. | Check for correctness |
65-
| **WorkspaceSubscriptionId** | string | DEPRECATED. Was the Azure subscription ID of the Log Analytics workspace containing the resource that generated the alert | Check for correctness |
64+
| **WorkspaceResourceGroup** | string | DEPRECATED |
65+
| **WorkspaceSubscriptionId** | string | DEPRECATED |
6666
| | | |
6767

6868
## Next steps

0 commit comments

Comments
 (0)