Skill v1.0.1
currentAutomated scan100/100+9 new
name: azure-eventhub-py description: Azure Event Hubs SDK for Python streaming. Use for high-throughput event ingestion, producers, consumers, and checkpointing. risk: critical source: community date_added: '2026-02-27' metadata: version: "1.0.1"
Bundled upstream support
Supporting files are included at skill-relative paths. See UPSTREAM-NOTICE.md for their pinned sources, licenses, hashes, and import changes.
Restored helper safety
scripts/setup_consumer.py authenticates to the configured Event Hub. send publishes event data; receive prints event bodies and properties and can write or advance a Blob checkpoint. Confirm the exact namespace, hub, payload/count, starting position, data handling, and checkpoint destination before live use.
Azure Event Hubs SDK for Python
Big data streaming platform for high-throughput event ingestion.
Installation
pip install azure-eventhub azure-identity# For checkpointing with blob storagepip install azure-eventhub-checkpointstoreblob# For the async examples instead:pip install azure-eventhub-checkpointstoreblob-aio
Environment Variables
EVENT_HUB_FULLY_QUALIFIED_NAMESPACE=<namespace>.servicebus.windows.netEVENT_HUB_NAME=my-eventhubSTORAGE_ACCOUNT_URL=https://<account>.blob.core.windows.netCHECKPOINT_CONTAINER=checkpoints
Use an approved tenant/subscription identity with least-privilege data-plane access and a separate test consumer group/checkpoint container. DefaultAzureCredential chooses from configured credentials; verify the actual principal before use. Starting positions apply when no stored checkpoint overrides them. Checkpoint only after durable application processing and use idempotent effects: replay and retention loss remain possible. Close credentials and clients; context-managing a client does not automatically close an externally supplied credential.
Authentication
from azure.identity import DefaultAzureCredentialfrom azure.eventhub import EventHubProducerClient, EventHubConsumerClientcredential = DefaultAzureCredential()namespace = "<namespace>.servicebus.windows.net"eventhub_name = "my-eventhub"# Producerproducer = EventHubProducerClient(fully_qualified_namespace=namespace,eventhub_name=eventhub_name,credential=credential)# Consumerconsumer = EventHubConsumerClient(fully_qualified_namespace=namespace,eventhub_name=eventhub_name,consumer_group="$Default",credential=credential)
Client Types
| Client | Purpose | |
|---|---|---|
EventHubProducerClient | Send events to Event Hub | |
EventHubConsumerClient | Receive events from Event Hub | |
BlobCheckpointStore | Track consumer progress |
Send Events
from azure.eventhub import EventHubProducerClient, EventDatafrom azure.identity import DefaultAzureCredentialproducer = EventHubProducerClient(fully_qualified_namespace="<namespace>.servicebus.windows.net",eventhub_name="my-eventhub",credential=DefaultAzureCredential())with producer:# Create batch (handles size limits)event_data_batch = producer.create_batch()for i in range(10):try:event_data_batch.add(EventData(f"Event {i}"))except ValueError:# Batch is full, send and create new oneproducer.send_batch(event_data_batch)event_data_batch = producer.create_batch()event_data_batch.add(EventData(f"Event {i}"))# Send remainingproducer.send_batch(event_data_batch)
Send to Specific Partition
# By partition IDevent_data_batch = producer.create_batch(partition_id="0")# By partition key (consistent hashing)event_data_batch = producer.create_batch(partition_key="user-123")
Receive Events
Simple Receive
from azure.eventhub import EventHubConsumerClientdef on_event(partition_context, event):print(f"Partition: {partition_context.partition_id}")print(f"Data: {event.body_as_str()}")partition_context.update_checkpoint(event)consumer = EventHubConsumerClient(fully_qualified_namespace="<namespace>.servicebus.windows.net",eventhub_name="my-eventhub",consumer_group="$Default",credential=DefaultAzureCredential())with consumer:consumer.receive(on_event=on_event,starting_position="-1", # Beginning of stream)
With Blob Checkpoint Store (Sketch)
from azure.eventhub import EventHubConsumerClientfrom azure.eventhub.extensions.checkpointstoreblob import BlobCheckpointStorefrom azure.identity import DefaultAzureCredentialcheckpoint_store = BlobCheckpointStore(blob_account_url="https://<account>.blob.core.windows.net",container_name="checkpoints",credential=DefaultAzureCredential())consumer = EventHubConsumerClient(fully_qualified_namespace="<namespace>.servicebus.windows.net",eventhub_name="my-eventhub",consumer_group="$Default",credential=DefaultAzureCredential(),checkpoint_store=checkpoint_store)def on_event(partition_context, event):print(f"Received: {event.body_as_str()}")# Checkpoint after processingpartition_context.update_checkpoint(event)with consumer:consumer.receive(on_event=on_event)
Async Client
from azure.eventhub import EventDatafrom azure.eventhub.aio import EventHubProducerClient, EventHubConsumerClientfrom azure.identity.aio import DefaultAzureCredentialimport asyncioasync def send_events():credential = DefaultAzureCredential()async with EventHubProducerClient(fully_qualified_namespace="<namespace>.servicebus.windows.net",eventhub_name="my-eventhub",credential=credential) as producer:batch = await producer.create_batch()batch.add(EventData("Async event"))await producer.send_batch(batch)async def receive_events():async def on_event(partition_context, event):print(event.body_as_str())await partition_context.update_checkpoint(event)async with EventHubConsumerClient(fully_qualified_namespace="<namespace>.servicebus.windows.net",eventhub_name="my-eventhub",consumer_group="$Default",credential=DefaultAzureCredential()) as consumer:await consumer.receive(on_event=on_event)asyncio.run(send_events())
Event Properties
event = EventData("My event body")# Set propertiesevent.properties = {"custom_property": "value"}event.content_type = "application/json"# Read properties (on receive)print(event.body_as_str())print(event.sequence_number)print(event.offset)print(event.enqueued_time)print(event.partition_key)
Get Event Hub Info
with producer:info = producer.get_eventhub_properties()print(f"Name: {info['name']}")print(f"Partitions: {info['partition_ids']}")for partition_id in info['partition_ids']:partition_info = producer.get_partition_properties(partition_id)print(f"Partition {partition_id}: {partition_info['last_enqueued_sequence_number']}")
Best Practices
- Use batches for sending multiple events
- Use checkpoint store in production for reliable processing
- Use async client for high-throughput scenarios
- Use partition keys for ordered delivery within a partition
- Handle batch size limits — catch ValueError when batch is full
- Use context managers (
with/async with) for proper cleanup - Set appropriate consumer groups for different applications
Reference Files
| File | Contents | |
|---|---|---|
| references/checkpointing.md | Checkpoint store patterns, blob checkpointing, checkpoint strategies | |
| references/partitions.md | Partition management, load balancing, starting positions | |
| scripts/setup_consumer.py | CLI for Event Hub info, consumer setup, and event sending/receiving |
When to Use
This skill is applicable to execute the workflow or actions described in the overview.
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.