Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
9808f2c
Add Azure Service Bus integration with triggers and documentation
prdai Jul 14, 2025
b31564d
Implement Azure Service Bus Queue and Subscription triggers with asyn…
prdai Jul 15, 2025
88e9e91
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Jul 17, 2025
7964971
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Aug 8, 2025
af956ab
feat(Azure): Add methods to read messages from Service Bus queue and …
prdai Aug 9, 2025
ee3742e
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Aug 9, 2025
c9dc444
Update providers/microsoft/azure/src/airflow/providers/microsoft/azur…
prdai Aug 20, 2025
ea5be12
Update providers/microsoft/azure/src/airflow/providers/microsoft/azur…
prdai Aug 20, 2025
f32cc2e
Update providers/microsoft/azure/src/airflow/providers/microsoft/azur…
prdai Aug 20, 2025
0fc82fc
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Aug 20, 2025
51cc11b
Remove Queue URI format documentation for Azure Service Bus Queue and…
prdai Aug 20, 2025
a36238f
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Aug 22, 2025
e32438b
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Sep 4, 2025
2b962c4
Enhance Azure Service Bus integration by adding new message types and…
prdai Sep 4, 2025
dab8917
Fix Azure Service Bus message trigger test failures
prdai Sep 4, 2025
0ec2cfd
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Sep 9, 2025
17f4e0a
Fix Azure Service Bus trigger test mocking issues
prdai Sep 9, 2025
f106eea
Update the Trigger Event Message to Include the Actual Content
prdai Sep 14, 2025
f7d8470
Merge remote-tracking branch 'upstream/main' into ffr/aip-82-add-azur…
prdai Sep 27, 2025
bc40ae6
resolve review comments
prdai Sep 27, 2025
86bb974
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Sep 27, 2025
ec7dbbf
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Oct 4, 2025
fac1b19
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
prdai Nov 22, 2025
8831f2d
chore: change BaseTrigger to BaseEventTrigger
prdai Nov 22, 2025
8b1f57f
Update providers/microsoft/azure/src/airflow/providers/microsoft/azur…
prdai Nov 22, 2025
3fe57fd
chore: fix ci/cd
prdai Nov 23, 2025
0d35d14
Merge branch 'main' into ffr/aip-82-add-azure-message-bus-integration
jason810496 Nov 24, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1623,6 +1623,8 @@ serializer
serializers
serverless
ServiceAccount
servicebus
ServiceBusReceivedMessage
ServicePrincipalCredentials
ServiceResource
SES
Expand Down
99 changes: 99 additions & 0 deletions providers/microsoft/azure/docs/connections/message_bus.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

.. http://www.apache.org/licenses/LICENSE-2.0

.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.

.. _howto/trigger:azure_service_bus_queue:

Microsoft Azure Service Bus Queue Trigger
=========================================

The Microsoft Azure Service Bus Queue trigger enables you to monitor Azure Service Bus queues for new messages and trigger DAG runs when messages arrive.

Authenticating to Azure
-----------------------

The trigger uses the connection you have configured in Airflow to connect to Azure.
Please refer to the :ref:`howto/connection:azure_service_bus` documentation for details on how to configure your connection.

Using the Trigger
-----------------

This example shows how to use the ``AzureServiceBusQueueTrigger``.

.. code-block:: python

from airflow.providers.microsoft.azure.triggers.message_bus import AzureServiceBusQueueTrigger

trigger = AzureServiceBusQueueTrigger(
queues=["my_queue"],
azure_service_bus_conn_id="azure_service_bus_default",
max_message_count=1,
poll_interval=5.0,
)

# The trigger will fire when a message is available in the queue.

.. _howto/trigger:azure_service_bus_subscription:

Microsoft Azure Service Bus Subscription Trigger
================================================

The Microsoft Azure Service Bus Subscription trigger enables you to monitor Azure Service Bus topic subscriptions for new messages and trigger DAG runs when messages arrive.

Authenticating to Azure
-----------------------

The trigger uses the connection you have configured in Airflow to connect to Azure.
Please refer to the :ref:`howto/connection:azure_service_bus` documentation for details on how to configure your connection.

Using the Trigger
-----------------

This example shows how to use the ``AzureServiceBusSubscriptionTrigger``.

.. code-block:: python

from airflow.providers.microsoft.azure.triggers.message_bus import AzureServiceBusSubscriptionTrigger

trigger = AzureServiceBusSubscriptionTrigger(
topics=["my_topic"],
subscription_name="my_subscription",
azure_service_bus_conn_id="azure_service_bus_default",
max_message_count=1,
poll_interval=5.0,
)

# The trigger will fire when a message is available in the topic subscription.

Azure Service Bus Message Queue
===============================

Azure Service Bus Queue Provider
--------------------------------

Implemented by :class:`~airflow.providers.microsoft.azure.triggers.message_bus.AzureServiceBusQueueTrigger`

The Azure Service Bus Queue Provider is a message queue provider that uses Azure Service Bus queues.
It allows you to monitor Azure Service Bus queues for new messages and trigger DAG runs when messages arrive.


Azure Service Bus Subscription Provider
---------------------------------------

Implemented by :class:`~airflow.providers.microsoft.azure.triggers.message_bus.AzureServiceBusSubscriptionTrigger`

The Azure Service Bus Subscription Provider is a message queue provider that uses Azure Service Bus topic subscriptions.
It allows you to monitor Azure Service Bus topic subscriptions for new messages and trigger DAG runs when messages arrive.
3 changes: 3 additions & 0 deletions providers/microsoft/azure/provider.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,9 @@ triggers:
- integration-name: Microsoft Power BI
python-modules:
- airflow.providers.microsoft.azure.triggers.powerbi
- integration-name: Microsoft Azure Service Bus
python-modules:
- airflow.providers.microsoft.azure.triggers.message_bus

transfers:
- source-integration-name: Local
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,10 @@ def get_provider_info():
"integration-name": "Microsoft Power BI",
"python-modules": ["airflow.providers.microsoft.azure.triggers.powerbi"],
},
{
"integration-name": "Microsoft Azure Service Bus",
"python-modules": ["airflow.providers.microsoft.azure.triggers.message_bus"],
},
],
"transfers": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -606,6 +606,60 @@ def receive_subscription_message(
for msg in received_msgs:
self._process_message(msg, context, message_callback, subscription_receiver)

def read_message(
self,
queue_name: str,
max_wait_time: float | None = None,
) -> ServiceBusReceivedMessage | None:
"""
Read a single message from a Service Bus queue without callback processing.

:param queue_name: The name of the queue to read from.
:param max_wait_time: Maximum time to wait for messages (seconds).
:return: The received message or None if no message is available.
"""
with (
self.get_conn() as service_bus_client,
service_bus_client.get_queue_receiver(queue_name=queue_name) as receiver,
receiver,
):
received_msgs = receiver.receive_messages(max_message_count=1, max_wait_time=max_wait_time)
if received_msgs:
msg = received_msgs[0]
receiver.complete_message(msg)
return msg
return None

def read_subscription_message(
self,
topic_name: str,
subscription_name: str,
max_wait_time: float | None = None,
) -> ServiceBusReceivedMessage | None:
"""
Read a single message from a Service Bus topic subscription without callback processing.

:param topic_name: The name of the topic.
:param subscription_name: The name of the subscription.
:param max_wait_time: Maximum time to wait for messages (seconds).
:return: The received message or None if no message is available.
"""
with (
self.get_conn() as service_bus_client,
service_bus_client.get_subscription_receiver(
topic_name, subscription_name
) as subscription_receiver,
subscription_receiver,
):
received_msgs = subscription_receiver.receive_messages(
max_message_count=1, max_wait_time=max_wait_time
)
if received_msgs:
msg = received_msgs[0]
subscription_receiver.complete_message(msg)
return msg
return None

def _process_message(
self,
msg: ServiceBusReceivedMessage,
Expand Down
Loading
Loading