Event Grid Configuration

Event Grid provides many configurations that can be modified per environment. The following section is a reference to all the available options and their defaults.

Important

On March 31, 2023, Event Grid on Azure IoT Edge support will be retired, so make sure to transition to IoT Edge native capabilities prior to that date. For more information, see Transition from Event Grid on Azure IoT Edge to Azure IoT Edge.

TLS configuration

To learn about client authentication in general, see Security and Authentication. Examples of its usage can be found in this article.

Property Name Description
inbound__serverAuth__tlsPolicy TLS Policy of the Event Grid module. Default value is HTTPS only.
inbound__serverAuth__serverCert__source Source of server certificate used by the Event Grid Module for its TLS configuration. Default value is IoT Edge.

Incoming client authentication

To learn about client authentication in general, see Security and Authentication. Examples can be found in this article.

Property Name Description
inbound__clientAuth__clientCert__enabled To turn on/off certificate-based client authentication. Default value is true.
inbound__clientAuth__clientCert__source Source for validating client certificates. Default value is IoT Edge.
inbound__clientAuth__clientCert__allowUnknownCA Policy to allow a self-signed client certificate. Default value is true.
inbound__clientAuth__sasKeys__enabled To turn on/off SAS key based client authentication. Default value is off.
inbound__clientAuth__sasKeys__key1 One of the values to validate incoming requests.
inbound__clientAuth__sasKeys__key2 Optional second value to validate incoming requests.

Outgoing client authentication

To learn about client authentication in general, see Security and Authentication. Examples can be found in this article.

Property Name Description
outbound__clientAuth__clientCert__enabled To turn on/off attaching an identity certificate for outgoing requests. Default value is true.
outbound__clientAuth__clientCert__source Source for retrieving Event Grid module's outgoing certificate. Default value is IoT Edge.

Webhook event handlers

To learn about client authentication in general, see Security and Authentication. Examples can be found in this article.

Property Name Description
outbound__webhook__httpsOnly Policy to control whether only HTTPS subscribers will be allowed. Default value is true (only HTTPS).
outbound__webhook__skipServerCertValidation Flag to control whether to validate the subscriber's certificate. Default value is true.
outbound__webhook__allowUnknownCA Policy to control whether a self-signed certificate can be presented by a subscriber. Default value is true.

Delivery and retry

To learn about this feature in general, see Delivery and Retry.

Property Name Description
broker__defaultMaxDeliveryAttempts Maximum number of attempts to deliver an event. Default value is 30.
broker__defaultEventTimeToLiveInSeconds Time-to-live (TTL) in seconds after which an event will be dropped if not delivered. Default value is 7200 seconds

Output batching

To learn about this feature in general, see Delivery and Output batching.

Property Name Description
api__deliveryPolicyLimits__maxBatchSizeInBytes Maximum value allowed for the ApproxBatchSizeInBytes knob. Default value is 1_058_576.
api__deliveryPolicyLimits__maxEventsPerBatch Maximum value allowed for the MaxEventsPerBatch knob. Default value is 50.
broker__defaultMaxBatchSizeInBytes Maximum delivery request size when only MaxEventsPerBatch is specified. Default value is 1_058_576.
broker__defaultMaxEventsPerBatch Maximum number of events to add to a batch when only MaxBatchSizeInBytes is specified. Default value is 10.

Metrics

To learn about using metrics with Event Grid on IoT Edge, see monitor topics and subscriptions

Property Name Description
metrics__reporterType Reporter type for metrics endpoint. Default is none and disables metrics. Setting to prometheus enables metrics in the Prometheus exposition format.