Skip to content

Commit 284a11e

Browse files
authored
Merge pull request #163076 from yanivlavi/IncludeSearchResultsFix
Corrected flag name IncludeSearchResults -> IncludedSearchResults
2 parents cd0fb10 + 369730f commit 284a11e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

articles/azure-monitor/alerts/alerts-common-schema-definitions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Any alert instance describes the resource that was affected and the cause of the
174174
### Log alerts
175175

176176
> [!NOTE]
177-
> For log alerts that have a custom email subject and/or JSON payload defined, enabling the common schema reverts email subject and/or payload schema to the one described as follows. This means that if you want to have a custom JSON payload defined, the webhook cannot use the common alert schema. Alerts with the common schema enabled have an upper size limit of 256 KB per alert. Search results aren't embedded in the log alerts payload if they cause the alert size to cross this threshold. You can determine this by checking the flag `IncludeSearchResults`. When the search results aren't included, you should use the `LinkToFilteredSearchResultsAPI` or `LinkToSearchResultsAPI` to access query results with the [Log Analytics API](/rest/api/loganalytics/dataaccess/query/get).
177+
> For log alerts that have a custom email subject and/or JSON payload defined, enabling the common schema reverts email subject and/or payload schema to the one described as follows. This means that if you want to have a custom JSON payload defined, the webhook cannot use the common alert schema. Alerts with the common schema enabled have an upper size limit of 256 KB per alert. Search results aren't embedded in the log alerts payload if they cause the alert size to cross this threshold. You can determine this by checking the flag `IncludedSearchResults`. When the search results aren't included, you should use the `LinkToFilteredSearchResultsAPI` or `LinkToSearchResultsAPI` to access query results with the [Log Analytics API](/rest/api/loganalytics/dataaccess/query/get).
178178
179179
#### `monitoringService` = `Log Analytics`
180180

@@ -246,7 +246,7 @@ Any alert instance describes the resource that was affected and the cause of the
246246
]
247247
}
248248
],
249-
"IncludeSearchResults": "True",
249+
"IncludedSearchResults": "True",
250250
"AlertType": "Metric measurement"
251251
}
252252
}
@@ -318,7 +318,7 @@ Any alert instance describes the resource that was affected and the cause of the
318318
}
319319
]
320320
},
321-
"IncludeSearchResults": "True",
321+
"IncludedSearchResults": "True",
322322
"AlertType": "Metric measurement"
323323
}
324324
}

0 commit comments

Comments
 (0)