Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.azure_event_hub Namespace Reference

Namespaces

 client
 
 config_flow
 
 const
 

Classes

class  AzureEventHub
 

Functions

bool async_setup (HomeAssistant hass, ConfigType yaml_config)
 
bool async_setup_entry (HomeAssistant hass, AzureEventHubConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, AzureEventHubConfigEntry entry)
 
None async_update_listener (HomeAssistant hass, AzureEventHubConfigEntry entry)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 AzureEventHubConfigEntry
 
 CONFIG_SCHEMA
 

Detailed Description

Support for Azure Event Hubs.

Function Documentation

◆ async_setup()

bool homeassistant.components.azure_event_hub.async_setup ( HomeAssistant  hass,
ConfigType  yaml_config 
)
Activate Azure EH component from yaml.

Adds an empty filter to hass data.
Tries to get a filter from yaml, if present set to hass data.
If config is empty after getting the filter, return, otherwise emit
deprecated warning and pass the rest to the config flow.

Definition at line 69 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.azure_event_hub.async_setup_entry ( HomeAssistant  hass,
AzureEventHubConfigEntry   entry 
)
Do the setup based on the config entry and the filter from yaml.

Definition at line 98 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.azure_event_hub.async_unload_entry ( HomeAssistant  hass,
AzureEventHubConfigEntry   entry 
)
Unload a config entry.

Definition at line 125 of file __init__.py.

◆ async_update_listener()

None homeassistant.components.azure_event_hub.async_update_listener ( HomeAssistant  hass,
AzureEventHubConfigEntry   entry 
)
Update listener for options.

Definition at line 118 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.azure_event_hub._LOGGER = logging.getLogger(__name__)
private

Definition at line 47 of file __init__.py.

◆ AzureEventHubConfigEntry

homeassistant.components.azure_event_hub.AzureEventHubConfigEntry

Definition at line 45 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.azure_event_hub.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Optional(CONF_EVENT_HUB_INSTANCE_NAME): cv.string,
6  vol.Optional(CONF_EVENT_HUB_CON_STRING): cv.string,
7  vol.Optional(CONF_EVENT_HUB_NAMESPACE): cv.string,
8  vol.Optional(CONF_EVENT_HUB_SAS_POLICY): cv.string,
9  vol.Optional(CONF_EVENT_HUB_SAS_KEY): cv.string,
10  vol.Optional(CONF_SEND_INTERVAL): cv.positive_int,
11  vol.Optional(CONF_MAX_DELAY): cv.positive_int,
12  vol.Optional(CONF_FILTER, default={}): FILTER_SCHEMA,
13  },
14  )
15  },
16  extra=vol.ALLOW_EXTRA,
17 )

Definition at line 49 of file __init__.py.