Skip to content

Commit af9f0c2

Browse files
committed
Fix review comments
1 parent 974be9c commit af9f0c2

10 files changed

+23
-23
lines changed

articles/sentinel/authentication-normalization-schema.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ When implementing custom parsers for the Authentication information model, name
4242
- `vimAuthentication<vendor><Product>` for filtering parsers
4343
- `ASiAuthentication<vendor><Product>` for parameter-less parsers
4444

45-
For information on adding the your custom parsers to the unifying parser, refer to [Managing ASIM parsers](normalization-manage-parsers.md).
45+
For information on adding your custom parsers to the unifying parser, refer to [Managing ASIM parsers](normalization-manage-parsers.md).
4646

4747
### Filtering parser parameters
4848

49-
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimized-parsers). While these parsers are optional, they can improve your query performance.
49+
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimizing-parsing-using-parameters). While these parsers are optional, they can improve your query performance.
5050

5151
The following filtering parameters are available:
5252

5353
| Name | Type | Description |
5454
|----------|-----------|-------------|
5555
| **starttime** | datetime | Filter only authentication events that ran at or after this time. |
5656
| **endtime** | datetime | Filter only authentication events that finished running at or before this time. |
57-
| **targetusername_has** | string | Filter only authentication events that has any of the listed user names. |
57+
| **targetusername_has** | string | Filter only authentication events that have any of the listed user names. |
5858

5959

6060
For example, to filter only authentication events from the last day to a specific user, use:
@@ -208,7 +208,7 @@ Fields that appear in the table below are common to all ASIM schemas. Any guidel
208208

209209
| Field | Class | Type | Description |
210210
|---------------|--------------|------------|-----------------|
211-
| <a name="dst"></a>**Dst** | Recommended | String | A unique identifier of the authetication target. <br><br>This field may alias the [TargerDvcId](#targetdvcid), [TargetHostname](#targethostname), [TargetIpAddr](#targetipaddr), [TargetAppId](#targetappid), or [TargetAppName](#targetappname) fields. <br><br>Example: `192.168.12.1` |
211+
| <a name="dst"></a>**Dst** | Recommended | String | A unique identifier of the authentication target. <br><br>This field may alias the [TargerDvcId](#targetdvcid), [TargetHostname](#targethostname), [TargetIpAddr](#targetipaddr), [TargetAppId](#targetappid), or [TargetAppName](#targetappname) fields. <br><br>Example: `192.168.12.1` |
212212
| <a name="targetappid"></a>**TargetAppId** |Optional | String| The ID of the application to which the authorization is required, often assigned by the reporting device. <br><br>Example: `89162` |
213213
|<a name="targetappname"></a>**TargetAppName** |Optional |String |The name of the application to which the authorization is required, including a service, a URL, or a SaaS application. <br><br>Example: `Saleforce` |
214214
| **TargetAppType**|Optional |AppType |The type of the application authorizing on behalf of the Actor. For more information, and allowed list of values, see [AppType](normalization-about-schemas.md#apptype) in the [Schema Overview article](normalization-about-schemas.md).|

articles/sentinel/dns-normalization-schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ When implementing custom parsers for the Dns information model, name your KQL fu
8282

8383
### Filtering parser parameters
8484

85-
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimized-parsers). While these parsers are optional, they can improve your query performance.
85+
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimizing-parsing-using-parameters). While these parsers are optional, they can improve your query performance.
8686

8787
The following filtering parameters are available:
8888

articles/sentinel/network-normalization-schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Refer to the article [Managing ASIM parsers](normalization-manage-parsers.md) to
5151

5252
### Filtering parser parameters
5353

54-
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimized-parsers). While these parsers are optional, they can improve your query performance.
54+
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimizing-parsing-using-parameters). While these parsers are optional, they can improve your query performance.
5555

5656
The following filtering parameters are available:
5757

@@ -236,7 +236,7 @@ Fields that appear in the table below are common to all ASIM schemas. Any guidel
236236
| <a name="srcusername"></a>**SrcUsername** | Optional | String | The source username, including domain information when available. For the supported format for different ID types, refer to [the User entity](normalization-about-schemas.md#the-user-entity). Use the simple form only if domain information isn't available.<br><br>Store the Username type in the [SrcUsernameType](#srcusernametype) field. If other username formats are available, store them in the fields `SrcUsername<UsernameType>`.<br><br>Example: `AlbertE` |
237237
| <a name="srcusernametype"></a>**SrcUsernameType** | Optional | UsernameType | Specifies the type of the username stored in the [SrcUsername](#srcusername) field. For a list of allowed values and further information refer to [UsernameType](normalization-about-schemas.md#usernametype) in the [Schema Overview article](normalization-about-schemas.md).<br><br>Example: `Windows` |
238238
| **SrcUserType** | Optional | UserType | The type of source user. For a list of allowed values and further information refer to [UserType](normalization-about-schemas.md#usertype) in the [Schema Overview article](normalization-about-schemas.md). <br><br>**Note**: The value might be provided in the source record by using different terms, which should be normalized to these values. Store the original value in the [SrcOriginalUserType](#srcoriginalusertype) field. |
239-
| <a name="srcoriginalusertype"></a>**SrcOriginalUserType** | Optional | String | The original destination user type, if provided by the reporting decice. |
239+
| <a name="srcoriginalusertype"></a>**SrcOriginalUserType** | Optional | String | The original destination user type, if provided by the reporting device. |
240240

241241

242242
### Source application fields

articles/sentinel/normalization-about-parsers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ _Im_Dns(starttime=ago(1d), responsecodename='NXDOMAIN')
2929
| summarize count() by SrcIpAddr, bin(TimeGenerated,15m)
3030
```
3131

32-
The example uses [filtering parameters](#optimized-parsers), which improve ASIM performance. The same example without filtering parameters would look like this:
32+
The example uses [filtering parameters](#optimizing-parsing-using-parameters), which improve ASIM performance. The same example without filtering parameters would look like this:
3333

3434
```kusto
3535
_Im_Dns
@@ -55,7 +55,7 @@ The following table lists unifying parsers available:
5555
| Web Session | _Im_WebSession |
5656

5757

58-
## <a name="optimized-parsers"></a>Optimizing parsing using parameters
58+
## Optimizing parsing using parameters
5959

6060
Using parsers may impact your query performance, primarily from filtering the results after parsing. For this reason, many parsers have optional filtering parameters, which enable you to filter before parsing and enhance query performance. With query optimization and pre-filtering efforts, ASIM parsers often provide better performance when compared to not using normalization at all.
6161

@@ -71,7 +71,7 @@ Every schema that supports filtering parameters supports at least the `starttime
7171

7272
For an example of using filtering parsers see [Unifying parsers](#unifying-parsers) above.
7373

74-
## <a name="next-steps"></a>Next steps
74+
## Next steps
7575

7676
Learn more about ASIM parsers:
7777

articles/sentinel/normalization-develop-parsers.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To understand how parsers fit within the ASIM architecture, refer to the [ASIM a
3333

3434
## Custom parser development process
3535

36-
The following workflow describe the high level steps in developing a custom ASIM, source-specific parser:
36+
The following workflow describes the high level steps in developing a custom ASIM, source-specific parser:
3737

3838
1. [Collect sample logs](#collect-sample-logs).
3939

@@ -59,7 +59,7 @@ This article guides you through the process's development, testing, and deployme
5959

6060
### Collect sample logs
6161

62-
To built effective ASIM parsers, you need a representative set of logs, which in most case will require setting up the source system and connecting it to Microsoft Sentinel. If you do not have the source device available, cloud pay-as-you-go services let you deploy many devices for development and testing.
62+
To build effective ASIM parsers, you need a representative set of logs, which in most case will require setting up the source system and connecting it to Microsoft Sentinel. If you do not have the source device available, cloud pay-as-you-go services let you deploy many devices for development and testing.
6363

6464
In addition, finding the vendor documentation and samples for the logs can help accelerate development and reduce mistakes by ensuring broad log format coverage.
6565

@@ -138,7 +138,7 @@ To use this sample in your parser:
138138

139139
#### Filtering based on parser parameters
140140

141-
When developing [filtering parsers](normalization-about-parsers.md#optimized-parsers), make sure that your parser accepts the filtering parameters for the relevant schema, as documented in the reference article for that schema. Using an existing parser as a starting point ensures that your parser includes the correct function signature. In most cases, the actual filtering code is also similar for filtering parsers for the same schema.
141+
When developing [filtering parsers](normalization-about-parsers.md#optimizing-parsing-using-parameters), make sure that your parser accepts the filtering parameters for the relevant schema, as documented in the reference article for that schema. Using an existing parser as a starting point ensures that your parser includes the correct function signature. In most cases, the actual filtering code is also similar for filtering parsers for the same schema.
142142

143143
When filtering, make sure that you:
144144

@@ -248,7 +248,7 @@ When each source value maps to a target value, define the mapping using the `dat
248248

249249
Notice that lookup is useful and efficient also when the mapping has only two possible values.
250250

251-
When the mapping condition are more complex use the the `iff` or `case` functions. The `iff` function enables mapping two values:
251+
When the mapping conditiond are more complex use the `iff` or `case` functions. The `iff` function enables mapping two values:
252252

253253
```KQL
254254
| extend EventResult =
@@ -418,7 +418,7 @@ To contribute your parsers:
418418
| Step | Description |
419419
| ---- | ----------- |
420420
| Develop the parsers | - Develop both a filtering parser and a parameter-less parser.<br>- Create a YAML file for the parser as described in [Deploying Parsers](#deploy-parsers) above.|
421-
| Test the parsers | - Make sure that your parsers pass all [testings](#test-parsers) with no errors.<br>- If any warnings are left, document them in the parser YAML file as descried below. |
421+
| Test the parsers | - Make sure that your parsers pass all [testings](#test-parsers) with no errors.<br>- If any warnings are left, document them in the parser YAML file as described below. |
422422
| Contribute | - Create a pull request against the [Microsoft Sentinel GitHub repository](https://github.com/Azure/Azure-Sentinel)<br>- Add to the PR your parsers YAML files to the ASIM parser folders (`/Parsers/ASim<schema>/Parsers`)<br>- Adds representative sample data to the sample data folder (`/Sample Data`) |
423423

424424
### Documenting accepted warnings
@@ -437,7 +437,7 @@ Exceptions:
437437

438438
The warning specified in the YAML file should be a short form of the warning message uniquely identifying. The value is used to match warning messages when performing automated testings and ignore them.
439439

440-
## <a name="next-steps"></a>Next steps
440+
## Next steps
441441

442442
This article discusses developing ASIM parsers.
443443

articles/sentinel/normalization-modify-content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Modify content to use the Microsoft Sentinel Advanced Security Information Model (ASIM) | Microsoft Docs
3-
description: This article explains how to convert Microsoft Sentinel content to use the the Advanced Security Information Model (ASIM).
3+
description: This article explains how to convert Microsoft Sentinel content to use the Advanced Security Information Model (ASIM).
44
author: oshezaf
55
ms.topic: conceptual
66
ms.date: 11/09/2021

articles/sentinel/normalization-parsers-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ It is recommended to use built-in parsers for schemas for which built-in parser
3939

4040
ASIM includes two levels of parsers: **unifying** parser and **source-specific** parsers. The user usually uses the **unifying** parser for the relevant schema, ensuring all data relevant to the schema is queried. The **unifying** parser in turn calls **source-specific** parsers to perform the actual parsing and normalization, which is specific for each source.
4141

42-
The unifying parser name is `_Im_<schema>` for built-in parsers and `im<schema>` for workspace deployed parsers, where `<schema>` stands for the specific schema it serves. sSource-specific parsers can also be used independently. For example, in an Infoblox-specific workbook, use the `vimDnsInfobloxNIOS` source-specific parser. Ypu can find a list of source-specific parsers in the [ASIM parsers list](normalization-parsers-list.md).
42+
The unifying parser name is `_Im_<schema>` for built-in parsers and `im<schema>` for workspace deployed parsers, where `<schema>` stands for the specific schema it serves. sSource-specific parsers can also be used independently. For example, in an Infoblox-specific workbook, use the `vimDnsInfobloxNIOS` source-specific parser. You can find a list of source-specific parsers in the [ASIM parsers list](normalization-parsers-list.md).
4343

4444

4545
>[!TIP]

articles/sentinel/normalization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Microsoft Sentinel ingests data from many sources. Working with various data typ
1616

1717
Sometimes, you'll need separate rules, workbooks, and queries, even when data types share common elements, such as firewall devices. Correlating between different types of data during an investigation and hunting can also be challenging.
1818

19-
The Advanced Security Information Model (ASIM) is a layer that is located between these diverse sources and the user. ASIM follows the [robustness principal](https://en.wikipedia.org/wiki/Robustness_principle): **"Be strict in what you send, be flexible in what you accept"**. Using the robustness principal as design pattern, ASIM transforms Microsoft Sentinel's inconsistent and hard to use source telemetry to user friendly data.
19+
The Advanced Security Information Model (ASIM) is a layer that is located between these diverse sources and the user. ASIM follows the [robustness principle](https://en.wikipedia.org/wiki/Robustness_principle): **"Be strict in what you send, be flexible in what you accept"**. Using the robustness principle as design pattern, ASIM transforms Microsoft Sentinel's inconsistent and hard to use source telemetry to user friendly data.
2020

2121
This article provides an overview of the Advanced Security Information Model (ASIM), its use cases and major components. Refer to the [next steps](#next-steps) section for more details.
2222

articles/sentinel/process-events-normalization-schema.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Add your KQL function to the `imProcess<Type>` and `imProcess` unifying parsers
4545

4646
### Filtering parser parameters
4747

48-
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimized-parsers). While these parsers are optional, they can improve your query performance.
48+
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimizing-parsing-using-parameters). While these parsers are optional, they can improve your query performance.
4949

5050
The following filtering parameters are available:
5151

@@ -151,7 +151,7 @@ The process event schema references the following entities, which are central to
151151
| **ActorUserIdType**| Recommended | String | The type of the ID stored in the [ActorUserId](#actoruserid) field. For a list of allowed values and further information refer to [UserIdType](normalization-about-schemas.md#useridtype) in the [Schema Overview article](normalization-about-schemas.md). |
152152
| **ActorSessionId** | Optional | String | The unique ID of the login session of the Actor. <br><br>Example: `999`<br><br>**Note**: The type is defined as *string* to support varying systems, but on Windows this value must be numeric. <br><br>If you are using a Windows machine and used a different type, make sure to convert the values. For example, if you used a hexadecimal value, convert it to a decimal value. |
153153
| **ActorUserType** | Optional | UserType | The type of Actor. For a list of allowed values and further information refer to [UserType](normalization-about-schemas.md#usertype) in the [Schema Overview article](normalization-about-schemas.md). <br><br>**Note**: The value might be provided in the source record by using different terms, which should be normalized to these values. Store the original value in the [ActorOriginalUserType](#actororiginalusertype) field. |
154-
| <a name="actororiginalusertype"></a>**ActorOriginalUserType** | Optional | String | The original destination user type, if provided by the reporting decice. |
154+
| <a name="actororiginalusertype"></a>**ActorOriginalUserType** | Optional | String | The original destination user type, if provided by the reporting device. |
155155

156156
### Acting process fields
157157

@@ -212,7 +212,7 @@ The process event schema references the following entities, which are central to
212212
| **TargetUserIdType** | Recommended | String | The type of the ID stored in the [TargetUserId](#targetuserid) field. For a list of allowed values and further information refer to [UserIdType](normalization-about-schemas.md#useridtype) in the [Schema Overview article](normalization-about-schemas.md). |
213213
| **TargetUserSessionId** | Optional | String |The unique ID of the target user's login session. <br><br>Example: `999` <br><br>**Note**: The type is defined as *string* to support varying systems, but on Windows this value must be numeric. <br><br>If you are using a Windows or Linux machine and used a different type, make sure to convert the values. For example, if you used a hexadecimal value, convert it to a decimal value. |
214214
| **TargetUserType** | Optional | UserType | The type of Actor. For a list of allowed values and further information refer to [UserType](normalization-about-schemas.md#usertype) in the [Schema Overview article](normalization-about-schemas.md). <br><br>**Note**: The value might be provided in the source record by using different terms, which should be normalized to these values. Store the original value in the [TargetOriginalUserType](#targetoriginalusertype) field. |
215-
| <a name="targetoriginalusertype"></a>**TargetOriginalUserType** | Optional | String | The original destination user type, if provided by the reporting decice. |
215+
| <a name="targetoriginalusertype"></a>**TargetOriginalUserType** | Optional | String | The original destination user type, if provided by the reporting device. |
216216

217217

218218
### Target process fields

articles/sentinel/web-normalization-schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ When implementing custom parsers for the Web Session information model, name you
6868

6969
### Filtering parser parameters
7070

71-
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#optimized-parsers). While these parsers are optional, they can improve your query performance.
71+
The `im` and `vim*` parsers support [filtering parameters](normalization-about-parsers.md#). While these parsers are optional, they can improve your query performance.
7272

7373
The following filtering parameters are available:
7474

0 commit comments

Comments
 (0)