During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in
locally servicebus
This page is part of the CLI Reference and is generated from the CLI's own help output, so it matches what locally servicebus --help prints.
For more information see Service Bus Emulator.
locally servicebus
Interact with Service Bus Namespaces within Locally.
Usage
locally servicebus [flags] locally servicebus [command]
Flags
-h, --help[=true|false] help for servicebus
Subcommands
- locally servicebus automation - Print a Service Bus Namespace, its queues and its topics as JSON.
- locally servicebus connection-string - Print the primary connection string for a Service Bus Namespace.
- locally servicebus dashboard - Open the Data Plane Emulator UI for a Service Bus Namespace in your browser.
- locally servicebus queue - Manage Queues in a Service Bus Namespace within Locally.
- locally servicebus topic - Manage Topics in a Service Bus Namespace within Locally.
locally servicebus automation
Print a Service Bus Namespace, its queues and its topics as JSON.
Print a Service Bus Namespace, its queues and its topics as JSON. Examples: locally servicebus automation --namespace ns1
Usage
locally servicebus automation [flags]
Flags
-h, --help[=true|false] help for automation
--namespace string Name of the Service Bus namespace
locally servicebus connection-string
Print the primary connection string for a Service Bus Namespace.
Prints the connection string the messaging clients use to send and receive over AMQP.
Pass --management for the string ServiceBusAdministrationClient takes, to create queues, topics, subscriptions and rules from code. It includes the Namespace's port; the messaging string can't, as a port there breaks the Go AMQP client's TLS handshake.
Java's administration client builder drops the port, so in Java use .credential("<namespace>.servicebus.locally:<port>", credential) instead of .connectionString(...).
az servicebus, Terraform and locally servicebus go through ARM and don't need either string.
Examples:
locally servicebus connection-string --namespace ns1
locally servicebus connection-string --namespace ns1 --management
Usage
locally servicebus connection-string [flags]
Flags
-h, --help[=true|false] help for connection-string
--management[=true|false] Print the management connection string, for the administration clients
--namespace string Name of the Service Bus namespace
locally servicebus dashboard
Open the Data Plane Emulator UI for a Service Bus Namespace in your browser.
Open the Data Plane Emulator UI for a Service Bus Namespace in your browser. Examples: locally servicebus dashboard --namespace ns1
Usage
locally servicebus dashboard [flags]
Flags
-h, --help[=true|false] help for dashboard
--namespace string Name of the Service Bus namespace
locally servicebus queue
Manage Queues in a Service Bus Namespace within Locally.
Usage
locally servicebus queue [flags] locally servicebus queue [command]
Flags
-h, --help[=true|false] help for queue
Subcommands
- locally servicebus queue create - Create a Queue in a Service Bus Namespace.
- locally servicebus queue delete - Delete a Queue from a Service Bus Namespace.
- locally servicebus queue list - List Queues in a Service Bus Namespace.
- locally servicebus queue peek - Peek at messages in a Queue without consuming them.
- locally servicebus queue send - Send a message to a Queue.
- locally servicebus queue show - Show details for a Queue in a Service Bus Namespace.
locally servicebus queue create
Create a Queue in a Service Bus Namespace.
Create a Queue in a Service Bus Namespace. Examples: locally servicebus queue create --namespace ns1 --name orders --max-delivery-count 5 --lock-duration 30s
Usage
locally servicebus queue create [flags]
Flags
--dead-letter-on-expiry[=true|false] Dead-letter messages when they expire
--default-message-ttl duration Default message time-to-live (defaults to unlimited, as in Azure)
-h, --help[=true|false] help for create
--lock-duration duration Message lock duration (default 1m0s)
--max-delivery-count int Maximum delivery count before dead-lettering (default 10)
--max-size-mb int Maximum queue size in megabytes (default 1024)
--name string Name of the queue
--namespace string Name of the Service Bus namespace
locally servicebus queue delete
Delete a Queue from a Service Bus Namespace.
Delete a Queue from a Service Bus Namespace. Examples: locally servicebus queue delete --namespace ns1 --name orders
Usage
locally servicebus queue delete [flags]
Flags
-h, --help[=true|false] help for delete
--name string Name of the queue
--namespace string Name of the Service Bus namespace
locally servicebus queue list
List Queues in a Service Bus Namespace.
List Queues in a Service Bus Namespace. Examples: locally servicebus queue list --namespace ns1
Usage
locally servicebus queue list [flags]
Flags
-h, --help[=true|false] help for list
--namespace string Name of the Service Bus namespace
locally servicebus queue peek
Peek at messages in a Queue without consuming them.
Peek at messages in a Queue without consuming them. Examples: locally servicebus queue peek --namespace ns1 --name orders --limit 5 locally servicebus queue peek --namespace ns1 --name orders --dead-letter
Usage
locally servicebus queue peek [flags]
Flags
--dead-letter[=true|false] Peek dead-lettered messages instead of active ones
-h, --help[=true|false] help for peek
--limit int Maximum number of messages to peek (max 100) (default 10)
--name string Name of the queue
--namespace string Name of the Service Bus namespace
locally servicebus queue send
Send a message to a Queue.
Send a message to a Queue.
Examples:
locally servicebus queue send --namespace ns1 --name orders --body '{"id": 1}' --content-type application/json
locally servicebus queue send --namespace ns1 --name orders --body-file ./msg.json --dead-letter --dead-letter-reason Poison
Usage
locally servicebus queue send [flags]
Flags
--body string Inline message body
--body-file string Path to a file containing the message body
--content-type string Content-Type of the message body
--count int Number of copies of the message to send (default 1)
--dead-letter[=true|false] Seed the message directly into the dead-letter sub-queue
--dead-letter-description string Dead-letter description (requires --dead-letter)
--dead-letter-reason string Dead-letter reason (requires --dead-letter)
-h, --help[=true|false] help for send
--name string Name of the queue
--namespace string Name of the Service Bus namespace
--property stringArray Custom message property as key=value (repeatable)
--session-id string Session ID for session-enabled entities
locally servicebus queue show
Show details for a Queue in a Service Bus Namespace.
Show details for a Queue in a Service Bus Namespace. Examples: locally servicebus queue show --namespace ns1 --name orders
Usage
locally servicebus queue show [flags]
Flags
-h, --help[=true|false] help for show
--name string Name of the queue
--namespace string Name of the Service Bus namespace
locally servicebus topic
Manage Topics in a Service Bus Namespace within Locally.
Usage
locally servicebus topic [flags] locally servicebus topic [command]
Flags
-h, --help[=true|false] help for topic
Subcommands
- locally servicebus topic create - Create a Topic in a Service Bus Namespace.
- locally servicebus topic delete - Delete a Topic from a Service Bus Namespace.
- locally servicebus topic list - List Topics in a Service Bus Namespace.
- locally servicebus topic peek - Peek at messages in a Topic subscription without consuming them.
- locally servicebus topic send - Send a message to a Topic.
- locally servicebus topic show - Show details for a Topic in a Service Bus Namespace.
locally servicebus topic create
Create a Topic in a Service Bus Namespace.
Create a Topic in a Service Bus Namespace. Examples: locally servicebus topic create --namespace ns1 --name events --max-size-mb 2048
Usage
locally servicebus topic create [flags]
Flags
--default-message-ttl duration Default message time-to-live (defaults to unlimited, as in Azure)
-h, --help[=true|false] help for create
--max-size-mb int Maximum topic size in megabytes (default 1024)
--name string Name of the topic
--namespace string Name of the Service Bus namespace
locally servicebus topic delete
Delete a Topic from a Service Bus Namespace.
Delete a Topic from a Service Bus Namespace. Examples: locally servicebus topic delete --namespace ns1 --name events
Usage
locally servicebus topic delete [flags]
Flags
-h, --help[=true|false] help for delete
--name string Name of the topic
--namespace string Name of the Service Bus namespace
locally servicebus topic list
List Topics in a Service Bus Namespace.
List Topics in a Service Bus Namespace. Examples: locally servicebus topic list --namespace ns1
Usage
locally servicebus topic list [flags]
Flags
-h, --help[=true|false] help for list
--namespace string Name of the Service Bus namespace
locally servicebus topic peek
Peek at messages in a Topic subscription without consuming them.
Peek at messages in a Topic subscription without consuming them. Examples: locally servicebus topic peek --namespace ns1 --name events --subscription audit --limit 5
Usage
locally servicebus topic peek [flags]
Flags
--dead-letter[=true|false] Peek dead-lettered messages instead of active ones
-h, --help[=true|false] help for peek
--limit int Maximum number of messages to peek (max 100) (default 10)
--name string Name of the topic
--namespace string Name of the Service Bus namespace
--subscription string Name of the subscription to peek
locally servicebus topic send
Send a message to a Topic.
Send a message to a Topic.
Examples:
locally servicebus topic send --namespace ns1 --name events --body '{"id": 1}' --session-id customer-42
Usage
locally servicebus topic send [flags]
Flags
--body string Inline message body
--body-file string Path to a file containing the message body
--content-type string Content-Type of the message body
--count int Number of copies of the message to send (default 1)
-h, --help[=true|false] help for send
--name string Name of the topic
--namespace string Name of the Service Bus namespace
--property stringArray Custom message property as key=value (repeatable)
--session-id string Session ID for session-enabled entities
locally servicebus topic show
Show details for a Topic in a Service Bus Namespace.
Show details for a Topic in a Service Bus Namespace. Examples: locally servicebus topic show --namespace ns1 --name events
Usage
locally servicebus topic show [flags]
Flags
-h, --help[=true|false] help for show
--name string Name of the topic
--namespace string Name of the Service Bus namespace
During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in