Operational Scripting

Component: Azure Service Bus Transport

Operational Scripting

In order to provision or de-provision the resources required by an endpoint, the asb-transport command line (CLI) tool can be used.

The tool can be obtained from NuGet and installed using the following command:

dotnet tool install -g NServiceBus.Transport.AzureServiceBus.CommandLine

Once installed, the asb-transport command line tool will be available for use.

asb-transport <command> [options]

Available commands

  • endpoint create
  • endpoint subscribe
  • endpoint unsubscribe
  • queue create
  • queue delete

asb-transport endpoint create

Create a new endpoint using:

asb-transport endpoint create name
                              [--size]
                              [--partitioned]
                              [--topic]
                              [--subscription]

options

-c | --connection-string : Overrides the environment variable 'AzureServiceBus_ConnectionString'

-s | --size : Queue size in GB (defaults to 5)

-p | --partitioned: Enable partitioning

-t | --topic: Topic name (defaults to 'bundle-1')

-b | --subscription: Subscription name (defaults to endpoint name)

asb-transport endpoint subscribe

Create a new subscription for an endpoint using:

asb-transport endpoint subscribe name event-type
                              [--topic]
                              [--subscription]                                                       
                              [--rule-name]

Options

-c | --connection-string : Overrides the environment variable 'AzureServiceBus_ConnectionString'

-t | --topic: Topic name (defaults to 'bundle-1')

-b | --subscription: Subscription name (defaults to endpoint name)

-r | --rule-name: Rule name (defaults to event type)

asb-transport endpoint unsubscribe

Delete a subscription for an endpoint using:

asb-transport endpoint unsubscribe name event-type
                              [--topic]
                              [--subscription]                                                       
                              [--rule-name]

Options

-c | --connection-string : Overrides the environment variable 'AzureServiceBus_ConnectionString'

-t | --topic: Topic name (defaults to 'bundle-1')

-b | --subscription: Subscription name (defaults to endpoint name)

-r | --rule-name: Rule name (defaults to event type)

asb-transport queue create

Create a queue using:

asb-transport queue create [--size]
                           [--partitioned]

options

-c | --connection-string : Overrides the environment variable 'AzureServiceBus_ConnectionString'

-s | --size: Queue size in GB (defaults to 5)

-p | --partitioned: Enable partitioning

asb-transport queue delete

Delete a queue using:

asb-transport queue delete

options

-c | --connection-string : Overrides the environment variable 'AzureServiceBus_ConnectionString'


Last modified