From 8ebe6cc3a0d1e870534b1de3b960ce9af7de5416 Mon Sep 17 00:00:00 2001 From: mamari90 <130982006+mamari90@users.noreply.github.com> Date: Tue, 24 Dec 2024 11:58:30 +0100 Subject: [PATCH] docs --- monitoring_function/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/monitoring_function/README.md b/monitoring_function/README.md index 275f1281..2444a3de 100644 --- a/monitoring_function/README.md +++ b/monitoring_function/README.md @@ -11,6 +11,13 @@ This is the minimum configuration required to use the monitoring function Field `monitoring_configuration_encoded` is required to be passed as a string, using `jsonencode()` function or `file()` function details on its content can be found [here](https://github.com/pagopa/azure-synthetic-monitoring) +In addition to the fields required by the monitoring function, you can specify the followings: + +| Field Name | Description | Default value | +|------------|--------------------------------------------------------------------------------|---------------| +| enabled | enables the monitoring of that specific `appName`-`apiName`-`type` combination | true | + + ### Alert configuration In addition to the properties defined above, `alertConfiguration` can be specified to customize the alert associated to the monitored api