Skip to content

README.md

Latest commit

 

History

History
104 lines (89 loc) · 3.6 KB

README.md

File metadata and controls

104 lines (89 loc) · 3.6 KB

servicebus-cli

Green numbers = Messages, Red numbers = Dead letters, Blue numbers = Scheduled messages

📃 About

Servicebus Cli is a command line interface for working with Azure Service Bus.

🚦 Usage

The application syntax is split into subjects and actions. The first parameter is the subject and second parameter is the action. All parameters after that are parameters passed to the action.

To see all available commands simply use subject helpwith no actions or parameters 

servicebus-cli help

The output will be as follows:

Syntax: servicebus-cli <subject> <action> <parameter1> <parameterX> ...

The following subjects and actions are available:
 - deadletter
    - resend
        - <FullyQualifiedNamespace>
        - <EnitityPath>
        - <UseSessions> (Y/N)
    - purge
        - <FullyQualifiedNamespace>
        - <EnitityPath>
 - queue
    - list
        - <FullyQualifiedNamespace>
        - <Filter>
    - peek
        - <FullyQualifiedNamespace>
        - <EntityPath>
    - purge
        - <FullyQualifiedNamespace>
        - <EntityPath>
Example: servicebus-cli deadletter resend <FullyQualifiedNamespace> <EnitityPath>

📌 Examples

List all service bus queues on namespace my-namespace

servicebus-cli queue list "my-namespace.servicebus.windows.net" ""

List all service bus queues on namespace my-namespace with a name containing my-queue

servicebus-cli queue list "my-namespace.servicebus.windows.net" "my-queue"

Show the service bus queue called my-queue on namespace my-namespace

servicebus-cli queue show "my-namespace.servicebus.windows.net" "my-queue"

Peek all messages in namespace my-namespace on queue my-queue

servicebus-cli queue peek "my-namespace.servicebus.windows.net" "my-queue"

Purge all messages in namespace my-namespace on queue my-queue

servicebus-cli queue purge "my-namespace.servicebus.windows.net" "my-queue"

Purge all dead letter messages in namespace my-namespace on queue my-entity-path 

servicebus-cli deadletter purge "my-namespace.servicebus.windows.net" "my-entity-path"

Resend all dead letter messages in namespace my-namespace on queue my-entity-path using Sessions

servicebus-cli deadletter resend "my-namespace.servicebus.windows.net" "my-entity-path" "Y"

Resend all dead letter messages in namespace my-namespace on queue my-entity-path without Sessions

servicebus-cli deadletter resend "my-namespace.servicebus.windows.net" "my-entity-path"