jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update config for Azure Event Hub (#18283)

Browse Source 
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Eduard van Valkenburg 2021-06-24 11:54:22 +02:00 committed by GitHub
parent eb7b732567
commit f9949ce475
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
source/_integrations/azure_event_hub.markdown
View File

@ -22,7 +22,7 @@ You must then create a Shared Access Policy for the Event Hub with 'Send' claims
Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the integration itself.
The alternative approach is to use a connection string, 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).
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 a 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.
@ -51,7 +51,7 @@ event_hub_namespace:
type: string
event_hub_instance_name:
description: The name of your Event Hub instance.
required: exclusive
required: true
type: string
event_hub_sas_policy:
description: The name of your Shared Access Policy.
@ -162,6 +162,7 @@ This is what the configuration will look like when using a connection string dir
# 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
```