diff --git a/source/_integrations/azure_event_hub.markdown b/source/_integrations/azure_event_hub.markdown
index 5d35e1715b2..067467fdd3e 100644
--- a/source/_integrations/azure_event_hub.markdown
+++ b/source/_integrations/azure_event_hub.markdown
@@ -8,6 +8,7 @@ ha_iot_class: Cloud Push
ha_codeowners:
- '@eavanvalkenburg'
ha_domain: azure_event_hub
+ha_config_flow: true
---
The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to an [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
@@ -24,60 +25,59 @@ Once you have the name of your namespace, instance, Shared Access Policy and the
The alternative approach is to use a connection string and instance name, this can be retrieved in the same way as the Shared Access Policy and this can also be gotten for a device in an IoT Hub (Event Hub-compatible connection string). In the case of IoT Hub, you need to put the Device ID as the instance name.
-The final thing to consider is how often you want the integration to send messages in a batch to your hub, this is set with the `send_interval`, with a default of 5 seconds. The other thing to look at is what the maximum delay you want to use, since this component runs in an asynchronous way there is no guarantee that the sending happens exactly on time, so depending on your semantics you might want messages discarded. The actual check of the time happens with `max_delay` plus `send_interval`, so that even with a long `send_interval` the semantics are the same.
+The final thing to consider is how often you want the integration to send messages in a batch to your hub, this is set with the `send_interval`, with a default of 5 seconds. Since this component runs in an asynchronous way there is no guarantee that the sending happens exactly on time, and because your Home Assistant might be very busy with lots of events happening it might discard several events that are older then 20 seconds plus the `send_interval`.
-## Configuration
+{% include integrations/config_flow.md %}
-Add the following lines to your `configuration.yaml` file:
+You can setup [filters](#filter-configuration) through the `configuration.yaml`.
+
+
+Not filtering domains or entities will send every event to Azure Event Hub, thus taking up a lot of space and bandwidth.
+
+
+
+Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.
+
+
+### Filter Configuration
+
+By default, no entity will be excluded. To limit which entities are being exposed to `Azure Event Hub`, you can use the `filter` parameter.
```yaml
-# Example configuration.yaml entry
+# Example filter to include specified domains and exclude specified entities
azure_event_hub:
- event_hub_namespace: NAMESPACE_NAME
- event_hub_instance_name: EVENT_HUB_INSTANCE_NAME
- event_hub_sas_policy: SAS_POLICY_NAME
- event_hub_sas_key: SAS_KEY
filter:
include_domains:
- - homeassistant
- - light
- - media_player
+ - alarm_control_panel
+ - light
+ include_entity_globs:
+ - binary_sensor.*_occupancy
+ exclude_entities:
+ - light.kitchen_light
```
+Filters are applied as follows:
+
+1. No includes or excludes - pass all entities
+2. Includes, no excludes - only include specified entities
+3. Excludes, no includes - only exclude specified entities
+4. Both includes and excludes:
+ - Include domain and/or glob patterns specified
+ - If domain is included, and entity not excluded or match exclude glob pattern, pass
+ - If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
+ - If domain is not included, glob pattern does not match, and entity not included, fail
+ - Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
+ - If domain is excluded and entity not included, fail
+ - If entity matches exclude glob pattern and entity not included, fail
+ - If entity does not match any exclude criteria (domain, glob pattern or listed), pass
+ - Neither include or exclude specifies domains or glob patterns
+ - If entity is included, pass (as #2 above)
+ - If entity include and exclude, the entity exclude is ignored
+
{% configuration %}
-event_hub_namespace:
- description: The name of your Event Hub namespace.
- required: exclusive
- type: string
-event_hub_instance_name:
- description: The name of your Event Hub instance.
- required: true
- type: string
-event_hub_sas_policy:
- description: The name of your Shared Access Policy.
- required: exclusive
- type: string
-event_hub_sas_key:
- description: The key for the Shared Access Policy.
- required: exclusive
- type: string
-event_hub_connection_string:
- description: The connection string to your event hub.
- required: exclusive
- type: string
-send_interval:
- description: The interval in seconds should events be sent to the Event Hub.
- required: false
- type: integer
- default: 5
-max_delay:
- description: The time in seconds after which a message is to be discarded.
- required: false
- type: integer
- default: 30
filter:
- description: Filter domains and entities for Event Hub. ([Configure Filter](#configure-filter))
- required: true
+ description: Filter domains and entities for Event Hub.
+ required: false
type: map
default: Includes all entities from all domains
keys:
@@ -107,66 +107,6 @@ filter:
type: list
{% endconfiguration %}
-
-Not filtering domains or entities will send every event to Azure Event Hub, thus taking up a lot of space.
-
-
-
-Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.
-
-
-### Configure Filter
-
-By default, no entity will be excluded. To limit which entities are being exposed to `Azure Event Hub`, you can use the `filter` parameter.
-
-```yaml
-# Example filter to include specified domains and exclude specified entities
-azure_event_hub:
- event_hub_namespace: NAMESPACE_NAME
- event_hub_instance_name: EVENT_HUB_INSTANCE_NAME
- event_hub_sas_policy: SAS_POLICY_NAME
- event_hub_sas_key: SAS_KEY
- filter:
- include_domains:
- - alarm_control_panel
- - light
- include_entity_globs:
- - binary_sensor.*_occupancy
- exclude_entities:
- - light.kitchen_light
-```
-
-Filters are applied as follows:
-
-1. No includes or excludes - pass all entities
-2. Includes, no excludes - only include specified entities
-3. Excludes, no includes - only exclude specified entities
-4. Both includes and excludes:
- - Include domain and/or glob patterns specified
- - If domain is included, and entity not excluded or match exclude glob pattern, pass
- - If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
- - If domain is not included, glob pattern does not match, and entity not included, fail
- - Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
- - If domain is excluded and entity not included, fail
- - If entity matches exclude glob pattern and entity not included, fail
- - If entity does not match any exclude criteria (domain, glob pattern or listed), pass
- - Neither include or exclude specifies domains or glob patterns
- - If entity is included, pass (as #2 above)
- - If entity include and exclude, the entity exclude is ignored
-
-### Advanced configuration
-
-This is what the configuration will look like when using a connection string directly, instead of the four parameters. It also shows how to set the send_interval and max_delay to something other than the default. This means once every minute the integration will connect to your hub and send messages, but the messages have to be less than 65 seconds old at the time of sending for them to be counted (send_interval + max_delay).
-
-```yaml
-# Connection string config with non-defaults for send_interval and max_delay
-azure_event_hub:
- event_hub_connection_string: CONNECTION_STRING
- event_hub_instance_name: EVENT_HUB_INSTANCE_NAME
- send_interval: 60
- max_delay: 5
-```
-
## Using the data in Azure
There are a number of ways to stream the data that comes into the Event Hub into storages in Azure, the easiest way is to use the built-in Capture function and this allows you to capture the data in Azure Blob Storage or Azure Data Lake store, [details here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-capture-overview).