Skip to content

Commit 4012bb3

Browse files
Merge pull request #296861 from yelevin/yelevin/strong-identifier-examples
Identifier examples
2 parents 6e8c9a0 + e5a800e commit 4012bb3

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

articles/sentinel/entities-reference.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,22 @@ You can currently use up to three identifiers for a given entity when creating a
3131
| - | - | - | - |
3232
| [**Account**](#account) | Name<br>*FullName \**<br>NTDomain<br>DnsDomain<br>UPNSuffix<br>Sid<br>AadTenantId<br>AadUserId<br>PUID<br>IsDomainJoined<br>*DisplayName \**<br>ObjectGuid | Name+UPNSuffix<br>AADUserId<br>Sid [\*\*](#strong-identifiers-of-an-account-entity)<br>Sid+*Host* [\*\*](#strong-identifiers-of-an-account-entity)<br>Name+*Host*+NTDomain [\*\*](#strong-identifiers-of-an-account-entity)<br>Name+NTDomain [\*\*](#strong-identifiers-of-an-account-entity)<br>Name+DnsDomain<br>PUID<br>ObjectGuid | Name |
3333
| [**Host**](#host) | DnsDomain<br>NTDomain<br>HostName<br>*FullName \**<br>NetBiosName<br>AzureID<br>OMSAgentID<br>OSFamily<br>OSVersion<br>IsDomainJoined | HostName+NTDomain<br>HostName+DnsDomain<br>NetBiosName+NTDomain<br>NetBiosName+DnsDomain<br>AzureID<br>OMSAgentID | HostName<br>NetBiosName |
34-
| [**IP**](#ip) | Address<br>AddressScope | Address [\*\*](#strong-identifiers-of-an-ip-entity)<br>Address+AddressScope [\*\*](#strong-identifiers-of-an-ip-entity) | |
34+
| **Entity type** | **Identifiers** | **Strong identifiers** | **Weak identifiers** |
35+
| [**IP**](#ip) | Address<br>AddressScope | [Global address:](#strong-identifiers-of-an-ip-entity) Address<br>[Private address:](#strong-identifiers-of-an-ip-entity) Address+AddressScope | <br>[Private address:](#weak-identifiers-of-an-ip-entity) Address |
3536
| [**URL**](#url) | Url | Url *(if absolute URL)* [\*\*](#strong-identifiers-of-a-url-entity) | Url *(if relative URL)* [\*\*](#strong-identifiers-of-a-url-entity) |
3637
| [**Azure resource**](#azure-resource)<br>*(AzureResource)* | ResourceId | ResourceId | |
3738
| [**Cloud application**](#cloud-application)<br>*(CloudApplication)* | AppId<br>Name<br>InstanceName | AppId<br>Name<br>AppId+InstanceName<br>Name+InstanceName | |
3839
| [**DNS resolution**](#dns-resolution)<br>*(DNS)* | DomainName | DomainName+*DnsServerIp*+*HostIpAddress* | DomainName+*HostIpAddress* |
3940
| [**File**](#file) | Directory<br>Name | Directory+Name | |
4041
| [**File hash**](#file-hash)<br>*(FileHash)* | Algorithm<br>Value | Algorithm+Value | |
4142
| [**Malware**](#malware) | Name<br>Category | Name+Category | |
43+
| **Entity type** | **Identifiers** | **Strong identifiers** | **Weak identifiers** |
4244
| [**Process**](#process) | ProcessId<br>CommandLine<br>ElevationToken<br>CreationTimeUtc | *Host*+ProcessID+CreationTimeUtc<br>*Host*+*ParentProcessId*+<br>&nbsp;&nbsp;&nbsp;CreationTimeUtc+CommandLine<br>*Host*+ProcessId+<br>&nbsp;&nbsp;&nbsp;CreationTimeUtc+*ImageFile*<br>*Host*+ProcessId+<br>&nbsp;&nbsp;&nbsp;CreationTimeUtc+*ImageFile*+<br>&nbsp;&nbsp;&nbsp;*FileHash* | ProcessId+CreationTimeUtc+<br>&nbsp;&nbsp;&nbsp;CommandLine (no Host)<br>ProcessId+CreationTimeUtc+<br>&nbsp;&nbsp;&nbsp;*ImageFile* (no Host) |
4345
| [**Registry key**](#registry-key)<br>*(RegistryKey)* | Hive<br>Key | Hive+Key | |
4446
| [**Registry value**](#registry-value)<br>*(RegistryValue)* | Name<br>Value<br>ValueType<br> | *Key*+Name | Name (no Key) |
4547
| [**Security group**](#security-group)<br>*(SecurityGroup)* | DistinguishedName<br>SID<br>ObjectGuid | DistinguishedName<br>SID<br>ObjectGuid | |
4648
| [**Mailbox**](#mailbox) | MailboxPrimaryAddress<br>DisplayName<br>Upn<br>ExternalDirectoryObjectId<br>RiskLevel | MailboxPrimaryAddress | |
49+
| **Entity type** | **Identifiers** | **Strong identifiers** | **Weak identifiers** |
4750
| [**Mail cluster**](#mail-cluster)<br>*(MailCluster)* | NetworkMessageIds<br>CountByDeliveryStatus<br>CountByThreatType<br>CountByProtectionStatus<br>Threats<br>Query<br>QueryTime<br>MailCount<br>IsVolumeAnomaly<br>Source<br>*ClusterSourceIdentifier \**<br>*ClusterSourceType \**<br>*ClusterQueryStartTime \**<br>*ClusterQueryEndTime \**<br>*ClusterGroup \** | Query+Source | |
4851
| [**Mail message**](#mail-message)<br>*(MailMessage)* | Recipient<br>Urls<br>Threats<br>Sender<br>*P1Sender \**<br>*P1SenderDisplayName \**<br>*P1SenderDomain \**<br>SenderIP<br>*P2Sender \**<br>*P2SenderDisplayName \**<br>*P2SenderDomain \**<br>ReceivedDate<br>NetworkMessageId<br>InternetMessageId<br>Subject<br>*BodyFingerprintBin1 \**<br>*BodyFingerprintBin2 \**<br>*BodyFingerprintBin3 \**<br>*BodyFingerprintBin4 \**<br>*BodyFingerprintBin5 \**<br>AntispamDirection<br>DeliveryAction<br>DeliveryLocation<br>*Language \**<br>*ThreatDetectionMethods \** | NetworkMessageId+Recipient | |
4952
| [**Submission mail**](#submission-mail)<br>*(SubmissionMail)* | NetworkMessageId<br>Timestamp<br>Recipient<br>Sender<br>SenderIp<br>Subject<br>ReportType<br>SubmissionId<br>SubmissionDate<br>Submitter | SubmissionId+NetworkMessageId+<br>&nbsp;&nbsp;&nbsp;Recipient+Submitter | |
@@ -94,9 +97,9 @@ The following section contains a more in-depth look at the full schemas of each
9497
| **Type** | String | 'account' |
9598
| **Name** | String | The name of the account. This field should hold only the name without any domain added to it. |
9699
| ***FullName*** | -- | *Not part of schema, included for backward compatibility with old version of entity mapping.* |
97-
| **NTDomain** | String | The NETBIOS domain name as it appears in the alert format&mdash;domain\username. Examples: Finance, NT AUTHORITY |
98-
| **DnsDomain** | String | The fully qualified domain DNS name. Examples: finance.contoso.com |
99-
| **UPNSuffix** | String | The user principal name suffix for the account. In many cases the UPN Suffix is also the domain name. Examples: contoso.com |
100+
| **NTDomain** | String | The NETBIOS domain name as it appears in the alert format&mdash;domain\username. <br>*Examples:* Finance, NT AUTHORITY |
101+
| **DnsDomain** | String | The fully qualified domain DNS name. <br>*Examples:* finance.contoso.com |
102+
| **UPNSuffix** | String | The user principal name suffix for the account. In many cases the UPN Suffix is also the domain name. <br>*Examples:* contoso.com |
100103
| **Host** | Entity ([Host](#host)) | The host that contains the account, if it's a local account. |
101104
| **Sid** | String | The account's security identifier. |
102105
| **AadTenantId** | Guid? | The Microsoft Entra tenant ID, if known. |
@@ -187,17 +190,22 @@ The following section contains a more in-depth look at the full schemas of each
187190
| Field | Type | Description |
188191
| ----- | ---- | ----------- |
189192
| **Type** | String | 'ip' |
190-
| **Address** | String | The IP address as string, for example. 127.0.0.1 (either in IPv4 or IPv6). |
191-
| **AddressScope** | String | Name of the host, subnet, or private network for private, non-global IP addresses. Null or empty for global IP addresses (default). |
193+
| **Address** | String | The IP address as string (either in IPv4 or IPv6).<br>*Examples:* `20.112.250.133`, `2603:1030:b:3::152` |
194+
| **AddressScope** | String | Name of the host, subnet, or private network for private, non-global IP addresses. Null or empty for global IP addresses (default).<br>*Examples:* `/27`, `255.255.255.128` |
192195
| **Location** | GeoLocation | The geo-location context attached to the IP entity. <br><br>For more information, see also [Enrich entities in Microsoft Sentinel with geolocation data via REST API (Public preview)](geolocation-data-api.md). |
193196
| **Stream** | Stream | The source of discovery logs related to the specific IP. Optional. |
194197

195198
#### Strong identifiers of an IP entity
196199

197200
- **Address**
198-
\*\* Address alone is a unique, strong identifier when the IP address is a global address.
201+
When the IP address is a global address, the Address identifier by itself is a unique, strong identifier.
199202
- **Address + AddressScope**
200-
\*\* For private/internal, non-global IP addresses, the AddressScope component is required to make this a strong identifier.
203+
For private/internal, non-global IP addresses, the AddressScope component is required to make this a strong identifier.
204+
205+
#### Weak identifiers of an IP entity
206+
207+
- **Address**
208+
The Address identifier by itself is a weak identifier when the IP address is a private/internal, non-global IP address.
201209

202210
[Back to list of entity type schemas](#list-of-entity-type-schemas) | [Back to entity identifiers table](#entity-types-and-identifiers)
203211

0 commit comments

Comments
 (0)