I am using Azure Service Bus message queue. I want to retrieve first queue's message based on the correlation id when the 2nd message arrives. (both message have same correlation id) I would like to know the equivalent of .Net API's MessageQueue.ReceiveByCorrelationId in Python API. Below is the .net API but I could not find ReceiveByCorrelationId in Python SDK. https://learn.microsoft.com/en-us/dotnet/api/system.messaging.messagequeue.receivebycorrelationid?view=netframework-4.8.1

@ShilpaGopal Thanks for reaching out. Unfortunately, there is no equivalent method in python as per the reference document here as we have in C# for MessageQueue.ReceiveByCorrelationId. The workaround in Python would be you can use the ServiceBusReceiver class to receive messages from a Service Bus queue. You can use the receive_messages() method to receive messages from the queue. To receive the first message based on the correlation id when the second message arrives, you can use the peek_messages() method to peek at the messages in the queue and then filter the messages based on the correlation id. Once you have the message that matches the correlation id, you can use the complete_message() method to remove the message from the queue. Feel free to provide the feedback/feature request in the Azure SDK for python repo here . Please accept as " Yes " if the answer is helpful so that it can help others in the community. If you need any help/clarification/concerns/follow up questions, then please click on " Add Comment " on my answer and provide more details.

Service bus queue message - ReceiveByCorrelationId equivalent in ServiceBus Message Python SDK

Accepted answer

MayankBargali-MSFT 70,141 Reputation points

2023-03-31T11:04:03.3966667+00:00

@ShilpaGopal Thanks for reaching out. Unfortunately, there is no equivalent method in python as per the reference document here as we have in C# for MessageQueue.ReceiveByCorrelationId.

The workaround in Python would be you can use the ServiceBusReceiver class to receive messages from a Service Bus queue. You can use the receive_messages() method to receive messages from the queue.

To receive the first message based on the correlation id when the second message arrives, you can use the peek_messages() method to peek at the messages in the queue and then filter the messages based on the correlation id. Once you have the message that matches the correlation id, you can use the complete_message() method to remove the message from the queue.

Feel free to provide the feedback/feature request in the Azure SDK for python repo here.

Please accept as "Yes" if the answer is helpful so that it can help others in the community. If you need any help/clarification/concerns/follow up questions, then please click on "Add Comment" on my answer and provide more details.
Please sign in to rate this answer.
ShilpaGopal 100 Reputation points

2023-03-31T11:17:22.7666667+00:00

Thanks for the update @MayankBargali-MSFT ,

In peak___message() mode, the api does'nt allow to settle ie completemessage(), settling message is only available in receive__message mode._

Receive____message() does not provide all the past messages, it only retrieves a partial incoming messages or a single message at a particular point in time, no option to retrieve all the past messages in the queue. So either option does not work for my scenario.

I will mark the post as answered for now.

MayankBargali-MSFT 70,141 Reputation points

2023-03-31T12:18:20.0166667+00:00

@ShilpaGopal Thanks for your response. Yes, your understanding is correct, and I missed to mentioned that before completing you need to receive_messages again.

from azure.servicebus import ServiceBusClient, ServiceBusMessage # Create a Service Bus client conn_str = "your_connection_string" queue_name = "your_queue_name" servicebus_client = ServiceBusClient.from_connection_string(conn_str) # Get a Service Bus receiver object receiver = servicebus_client.get_queue_receiver(queue_name=queue_name) # Peek at the messages in the queue messages = receiver.peek_messages(max_message_count=10) # Filter the messages based on the correlation id correlation_id = "your_correlation_id" for message in messages: if message.correlation_id == correlation_id: # Receive the message received_message = receiver.receive_messages(max_message_count=1, max_wait_time=5)[0] # Complete the message to remove it from the queue receiver.complete_message(received_message) break # Close the Service Bus client servicebus_client.close()

Feel free to create the feature request so the SDK team can review, track and implement this in the near future. I will also pass the feedback internally.

ShilpaGopal 100 Reputation points

2023-03-31T12:30:59.9966667+00:00

Thank you for the code snippet @MayankBargali-MSFT

In the below code, when the correlation id matches, receive__messages() has no link to the matched correlation id. If there was an api feature to receive matched correlation id then this would have worked (just a hypothetical example) - receiver.receive__messages(correlationid =matched__corr_id)

Also, receive_messages() does not look at all the past messages, but only looks at incoming partial messages. So, the below code does not help in settling the message in the queue.

correlation_id = "your_correlation_id" for message in messages: if message.correlation_id == correlation_id: # Receive the message received_message = receiver.receive_messages(max_message_count=1, max_wait_time=5)[0] # Complete the message to remove it from the queue receiver.complete_message(received_message) break
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Service bus queue message - ReceiveByCorrelationId equivalent in ServiceBus Message Python SDK

0 additional answers

Your answer