Python Service Bus CLI

🚀 Command line software to manage azure service bus service. Made in pyhton for cross-platform compatibility.

Table of contents

• Usage examples
• Root options
• Environment variables
• Important
• Author

Roadmap to v1 🏃

• Send messages to a service bus queue
• Send messages to a service bus subscription
• Peek messages from queue
• Peek messages from subscription
• Purge all messages from queue
• Purge all messages from subscription
• Search engine and sorting
• Topic, subscription and queue management
• Rescheduling messages
• Receive messages from queue
• Receive messages from subscription
• Refator session to use NEXT_AVAILABLE_SESSION
• Connection string parser

Usage examples

Help command

Commands and options available.

python service_bus.py --help  
python service_bus.py peek_queue --help 

Peek queue command

Check messages in the queue without receiving messages.

python service_bus.py peek_queue

peek_queue - Options

--pretty: Make pretty JSON in the console ✨

python service_bus.py peek_queue --pretty

dl or --dead_letter: Peek messages from the dead letter 👻
-s or --session: Session name to be used
-ds or --default_session': When a queue session is used, the session name by default is called SESSION_ID

Peek subscription command

Check messages in the subscription without receiving messages.

python service_bus.py peek_sub

peek_sub - Options

--pretty: Make pretty JSON in the console ✨
dl or --dead_letter: Peek messages from the dead letter 👻
-s or --session: Session name to be used
-ds or --default_session': When a queue session is used, the session name by default is called SESSION_ID

Purge queue command

Purge all messages from the queue.

python service_bus.py purge_queue

purge_queue - Options

dl or --dead_letter: from the dead letter 👻
-s or --session: Session name to be used
-ds or --default_session': When a queue session is used, the session name by default is called SESSION_ID

Purge subscription command

Purge all messages from the subscription.

python service_bus.py purge_sub

purge_sub - Options

dl or --dead_letter: from the dead letter 👻
-s or --session: Session name to be used
-ds or --default_session': When a queue session is used, the session name by default is called SESSION_ID

Send messages command

Send messages to a service bus queue or topic using a json template. The model file is at the root of the project

python service_bus.py message_queue -i file

python service_bus.py message_topic -i file

message - Options

-s or --session: Session name to be used
-ds or --default_session': When a queue session is used, the session name by default is called SESSION_ID

Root options

• --queue_name or, -qn: Name of the message bus queue (optional)
• --topic_name or -tn: Name of the message bus topic (optional)
• --subscription_name or -sn: Name of the message bus subscription (optional)
• --log_path or -l: Path to generate file log console outputs (optional)

python service_bus.py -l system_path peek_sub

There is a configuration file at the root of the project where it is possible to add the service bus settings more easily.

It is loaded by default at the root of the main file folder. It can also be configured via environment.

Environment variables

• SERVICE_BUS_CONNECTION_STR
• SERVICE_BUS_QUEUE_NAME
• SERVICE_BUS_TOPIC_NAME
• SERVICE_BUS_SUBSCRIPTION_NAME
• SERVICEBUS_CONF (Path of config file)

Important ❗

There is a variety of options see use --help to view other.

Author

Made with ❤️ by Leonardo Viana Silva