Skip to content

Commit 64a6989

Browse files
committed
Prettier linting
1 parent c533734 commit 64a6989

File tree

1 file changed

+47
-32
lines changed

1 file changed

+47
-32
lines changed

docs/digging-deeper/pipelines.md

Lines changed: 47 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ transformations:
189189
rule_conditions:
190190
- type: logsource
191191
product: m365
192-
service: threat_detection
192+
service: threat_detection
193193
- id: defender_index
194194
type: add_condition
195195
conditions:
@@ -206,16 +206,16 @@ transformations:
206206

207207
### Rule-based Conditions
208208

209-
| Identifier |
210-
| --------------------------- |
211-
| logsource |
212-
| contains_detection_item |
213-
| processing_item_applied |
214-
| processing_state |
215-
| is_sigma_rule |
216-
| is_sigma_correlation_rule |
217-
| rule_attribute |
218-
| tag |
209+
| Identifier |
210+
| ------------------------- |
211+
| logsource |
212+
| contains_detection_item |
213+
| processing_item_applied |
214+
| processing_state |
215+
| is_sigma_rule |
216+
| is_sigma_correlation_rule |
217+
| rule_attribute |
218+
| tag |
219219

220220
#### logsource
221221

@@ -240,7 +240,7 @@ transformations:
240240
rule_conditions:
241241
- type: logsource
242242
product: m365
243-
service: threat_detection
243+
service: threat_detection
244244
```
245245

246246
:::
@@ -250,6 +250,7 @@ transformations:
250250
Returns True if rule contains a detection item that matches the given field name and value.
251251

252252
**Parameters:**
253+
253254
- 'field': The field you'd like to match on.
254255
- 'value': The value you'd like to match on.
255256

@@ -274,6 +275,7 @@ transformations:
274275
Checks if processing item was applied to rule.
275276

276277
**Parameters:**
278+
277279
- 'processing_item_id': The identifier of the processing item you'd like to match on
278280

279281
::: code-group
@@ -300,6 +302,7 @@ transformations:
300302
Matches on processing pipeline state.
301303

302304
**Parameters:**
305+
303306
- 'key': The key for the processing state.
304307
- 'val': The value for the processing state key.
305308

@@ -324,6 +327,7 @@ transformations:
324327
Checks if rule is a SigmaRule.
325328

326329
**Parameters:**
330+
327331
- N/A
328332

329333
::: code-group
@@ -345,6 +349,7 @@ transformations:
345349
Checks if rule is a SigmaRule.
346350

347351
**Parameters:**
352+
348353
- N/A
349354

350355
::: code-group
@@ -374,6 +379,7 @@ Generic match on rule attributes with supported types:
374379
- Fields that contain lists of values, maps or other complex data structures are not supported and raise a SigmaConfigurationError. If the type of the value doesn’t allows a particular relation, the condition also raises a SigmaConfigurationError on match.
375380

376381
**Parameters:**
382+
377383
- 'attribute': The attribute to match on.
378384
- 'value': The value to match on.
379385
- 'op': The relational comparison type to match on (eq (equals), ne (not equals), gte (greater than or equals), gt (greater than), lte (less than or equals), lt (less than)) with the default value of eq
@@ -391,7 +397,7 @@ transformations:
391397
rule_conditions:
392398
- type: rule_attribute
393399
attribute: date
394-
value: '2025-01-01'
400+
value: "2025-01-01"
395401
op: gte
396402
```
397403

@@ -400,6 +406,7 @@ transformations:
400406
Matches if rule is tagged with a specific tag.
401407

402408
**Parameters:**
409+
403410
- 'tag': The tag to match on.
404411

405412
::: code-group
@@ -419,18 +426,19 @@ transformations:
419426

420427
### Detection-based Conditions
421428

422-
| Identifier |
423-
| --------------------------- |
424-
| match_string |
425-
| is_null |
426-
| processing_item_applied |
427-
| processing_state |
429+
| Identifier |
430+
| ----------------------- |
431+
| match_string |
432+
| is_null |
433+
| processing_item_applied |
434+
| processing_state |
428435

429436
#### match_string
430437

431438
Match string values with a regular expression ‘pattern’. The parameter ‘cond’ determines for detection items with multiple values if any or all strings must match. Generally, values which aren’t strings are skipped in any mode or result in a false result in all match mode.
432439

433440
**Parameters:**
441+
434442
- 'cond': 'any' or 'all'
435443
- 'pattern': The pattern to match on
436444
- 'negate': Default to false, but can be changed to True to make a negated condition
@@ -448,7 +456,7 @@ transformations:
448456
detection_item_conditions:
449457
- type: match_string
450458
cond: any
451-
pattern: 'informational'
459+
pattern: "informational"
452460
negate: False
453461
```
454462

@@ -457,6 +465,7 @@ transformations:
457465
Match null values. The parameter ‘cond’ determines for detection items with multiple values if any or all strings must match. Generally, values which aren’t strings are skipped in any mode or result in a false result in all match mode.
458466

459467
**Parameters:**
468+
460469
- 'cond': 'any' or 'all'
461470

462471
:::code-block
@@ -479,6 +488,7 @@ transformations:
479488
Checks if processing item was applied to detection item.
480489

481490
**Parameters:**
491+
482492
- 'processing_item_id': The identifier of the processing item you'd like to match on
483493

484494
:::code-block
@@ -505,6 +515,7 @@ transformations:
505515
Matches on processing pipeline state.
506516

507517
**Parameters:**
518+
508519
- 'key': The key for the processing state.
509520
- 'val': The value for the processing state key.
510521

@@ -526,18 +537,19 @@ transformations:
526537

527538
### Field-based Conditions
528539

529-
| Identifier |
530-
| --------------------------- |
531-
| include_fields |
532-
| exclude_fields |
533-
| processing_item_applied |
534-
| processing_state |
540+
| Identifier |
541+
| ----------------------- |
542+
| include_fields |
543+
| exclude_fields |
544+
| processing_item_applied |
545+
| processing_state |
535546

536547
#### include_fields
537548

538549
Matches on field name if it is contained in fields list. The parameter ‘type’ determines if field names are matched as plain string (“plain”) or regular expressions (“re”).
539550

540551
**Parameters:**
552+
541553
- 'fields': The fields to match on
542554
- 'type': Plain match or regex match using 'plain' or 're'.
543555

@@ -551,14 +563,15 @@ transformations:
551563
type: drop_detection_item
552564
field_name_conditions:
553565
- type: include_fields
554-
fields:
555-
- 'name'
556-
- 'type'
566+
fields:
567+
- "name"
568+
- "type"
557569
```
558570

559571
#### exclude_fields
560572

561573
**Parameters:**
574+
562575
- 'fields': The fields to match on
563576
- 'type': Plain match or regex match using 'plain' or 're'.
564577

@@ -572,10 +585,11 @@ transformations:
572585
type: drop_detection_item
573586
field_name_conditions:
574587
- type: exclude_fields
575-
fields:
576-
- 'name'
577-
- 'value'
588+
fields:
589+
- "name"
590+
- "value"
578591
```
592+
579593
Adding documentation for conditionson
580594

581595
:::code-block
@@ -602,6 +616,7 @@ transformations:
602616
Matches on processing pipeline state.
603617

604618
**Parameters:**
619+
605620
- 'key': The key for the processing state.
606621
- 'val': The value for the processing state key.
607622

0 commit comments

Comments
 (0)