EventhubsClient

Attributes

SendEventsInput module-attribute

SendEventsInput = List['SendEvent']

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewEvents': {'operation_id': 'OnNewEvents', 'path': '/{connectionId}/{eventHubName}/events/batch/head', 'method': 'get', 'required_parameters': ['eventHubName'], 'callback_payload_type': 'Event'}}

Classes

Event dataclass

Event(content_data: Optional[ObjectEntity] = None, properties: Optional[Dict[str, Any]] = None, system_properties: Optional[SystemProperties] = None)

Response for When events are available in Event Hub

Attributes

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Key-value pairs for each application property

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Response for Generate event schema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SystemProperties dataclass

SystemProperties(enqueued_time_utc: Optional[str] = None, offset: Optional[str] = None, partition_key: Optional[str] = None, sequence_number: Optional[int] = None)

Definition: SystemProperties

Attributes

enqueued_time_utc class-attribute instance-attribute

enqueued_time_utc: Optional[str] = field(default=None, metadata={'wire_name': 'EnqueuedTimeUtc'})

Enqueued time

offset class-attribute instance-attribute

offset: Optional[str] = field(default=None, metadata={'wire_name': 'Offset'})

Offset in a partition

partition_key class-attribute instance-attribute

partition_key: Optional[str] = field(default=None, metadata={'wire_name': 'PartitionKey'})

Partition Key

sequence_number class-attribute instance-attribute

sequence_number: Optional[int] = field(default=None, metadata={'wire_name': 'SequenceNumber'})

Sequence number

SendEvent dataclass

SendEvent(content_data: Optional[str] = None, properties: Optional[Dict[str, Any]] = None)

Definition: SendEvent

Attributes

content_data class-attribute instance-attribute

content_data: Optional[str] = field(default=None, metadata={'wire_name': 'ContentData'})

Content of the event

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Key-value pairs for each application property

EventhubsClient

EventhubsClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for eventhubs connector.

Initialize a EventhubsClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

send_event_async async

send_event_async(input: SendEvent, event_hub_name: str, partition_key: Optional[str] = None) -> None

Send event

Send event.

send_events_async async

send_events_async(input: SendEventsInput, event_hub_name: str, partition_key: str) -> None

Send one or more events to the Event Hub partition

Send one or more events to the Event Hub partition.

get_event_hubs_async async

get_event_hubs_async() -> dict[str, Any] | None

Get all Event Hubs in a namespace

Get all Event Hubs in a namespace.

get_content_types_async async

get_content_types_async() -> dict[str, Any] | None

Get all content types

Get all content types.

get_consumer_groups_async async

get_consumer_groups_async(event_hub_name: str) -> dict[str, Any] | None

Get all the consumer groups for an event hub

Get all the consumer groups for an event hub.

get_partition_keys_async async

get_partition_keys_async(event_hub_name: str) -> dict[str, Any] | None

Get all partition keys in an Event Hub

Get all partition keys in an Event Hub.

generate_event_schema_async async

generate_event_schema_async(content_type: str, content_schema: Optional[str] = None) -> dict[str, Any] | None

Generate event schema

Generate event schema V2.