View queue, topic and subscription message counts (including scheduled)

[alexespencer]

I would like to be able to obtain the active, pending and dead-letter message counts from a queue, topic or subscription

Either via ServiceBusAdministrationClient or the receiver itself?

You used to be able to do this with the old library?

[swathipil]

@alexespencer Thanks for your question!

The active, scheduled, and dead-letter message counts are all provided by the *RuntimeProperties objects returned by the list_*_runtime_properties methods on the ServiceBusAdministrationClient.

For example, you can use the get_queue_runtime_properties method to obtain the QueueRuntimeProperties object:

import os
from azure.servicebus.management import ServiceBusAdministrationClient

CONNECTION_STR = os.environ['SERVICE_BUS_CONNECTION_STR']
QUEUE_NAME = os.environ['SERVICE_BUS_QUEUE_NAME']

servicebus_mgmt_client = ServiceBusAdministrationClient.from_connection_string(CONNECTION_STR)

# below returned object is a QueueRuntimeProperties object
queue_info = servicebus_mgmt_client.get_queue_runtime_properties(QUEUE_NAME)

# access the active, scheduled, and dead-letter message counts
print(queue_info.active_message_count)
print(queue_info.scheduled_message_count)
print(queue_info.dead_letter_message_count)

You can also find similar methods for subscription and topic here and here.

Thanks!

Hi @alexespencer. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text “/unresolve” to remove the “issue-addressed” label and continue the conversation.

[swathipil]

@alexespencer - You mentioned that you were able to find the active, scheduled, and dead-letter message counts in the "old library". Out of curiosity, were you referring to azure-servicebus==0.50.3 or a different version? This would be useful to know so that we can update our migration guide with this info to help others that have the same question as you. Thanks!