Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.azure_service_bus.notify Namespace Reference

Classes

class  ServiceBusNotificationService
 

Functions

ServiceBusNotificationService|None get_service (HomeAssistant hass, ConfigType config, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_ASB_MESSAGE = "message"
 
string ATTR_ASB_TARGET = "target"
 
string ATTR_ASB_TITLE = "title"
 
string CONF_CONNECTION_STRING = "connection_string"
 
string CONF_QUEUE_NAME = "queue"
 
string CONF_TOPIC_NAME = "topic"
 
 PLATFORM_SCHEMA
 

Detailed Description

Support for azure service bus notification.

Function Documentation

◆ get_service()

ServiceBusNotificationService | None homeassistant.components.azure_service_bus.notify.get_service ( HomeAssistant  hass,
ConfigType  config,
DiscoveryInfoType | None   discovery_info = None 
)
Get the notification service.

Definition at line 55 of file notify.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.azure_service_bus.notify._LOGGER = logging.getLogger(__name__)
private

Definition at line 52 of file notify.py.

◆ ATTR_ASB_MESSAGE

string homeassistant.components.azure_service_bus.notify.ATTR_ASB_MESSAGE = "message"

Definition at line 33 of file notify.py.

◆ ATTR_ASB_TARGET

string homeassistant.components.azure_service_bus.notify.ATTR_ASB_TARGET = "target"

Definition at line 35 of file notify.py.

◆ ATTR_ASB_TITLE

string homeassistant.components.azure_service_bus.notify.ATTR_ASB_TITLE = "title"

Definition at line 34 of file notify.py.

◆ CONF_CONNECTION_STRING

string homeassistant.components.azure_service_bus.notify.CONF_CONNECTION_STRING = "connection_string"

Definition at line 29 of file notify.py.

◆ CONF_QUEUE_NAME

string homeassistant.components.azure_service_bus.notify.CONF_QUEUE_NAME = "queue"

Definition at line 30 of file notify.py.

◆ CONF_TOPIC_NAME

string homeassistant.components.azure_service_bus.notify.CONF_TOPIC_NAME = "topic"

Definition at line 31 of file notify.py.

◆ PLATFORM_SCHEMA

homeassistant.components.azure_service_bus.notify.PLATFORM_SCHEMA
Initial value:
1 = vol.All(
2  cv.has_at_least_one_key(CONF_QUEUE_NAME, CONF_TOPIC_NAME),
3  NOTIFY_PLATFORM_SCHEMA.extend(
4  {
5  vol.Required(CONF_CONNECTION_STRING): cv.string,
6  vol.Exclusive(
7  CONF_QUEUE_NAME, "output", "Can only send to a queue or a topic."
8  ): cv.string,
9  vol.Exclusive(
10  CONF_TOPIC_NAME, "output", "Can only send to a queue or a topic."
11  ): cv.string,
12  }
13  ),
14 )

Definition at line 37 of file notify.py.