During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in
locally eventhub
This page is part of the CLI Reference and is generated from the CLI's own help output, so it matches what locally eventhub --help prints.
For more information see Event Hubs Emulator.
locally eventhub
Interact with Event Hubs Namespaces within Locally.
Usage
locally eventhub [flags] locally eventhub [command]
Flags
-h, --help[=true|false] help for eventhub
Subcommands
- locally eventhub connection-string - Print the primary connection string for an Event Hubs Namespace.
- locally eventhub consumer-group - Manage Consumer Groups in an Event Hub within Locally.
- locally eventhub dashboard - Open the Data Plane Emulator UI for an Event Hubs Namespace in your browser.
- locally eventhub hub - Manage Event Hubs in an Event Hubs Namespace within Locally.
locally eventhub connection-string
Print the primary connection string for an Event Hubs Namespace.
Print the primary connection string for an Event Hubs Namespace. Examples: locally eventhub connection-string --namespace ns1
Usage
locally eventhub connection-string [flags]
Flags
-h, --help[=true|false] help for connection-string
--namespace string Name of the Event Hubs namespace
locally eventhub consumer-group
Manage Consumer Groups in an Event Hub within Locally.
Usage
locally eventhub consumer-group [flags] locally eventhub consumer-group [command]
Flags
-h, --help[=true|false] help for consumer-group
Subcommands
- locally eventhub consumer-group create - Create a Consumer Group for an Event Hub.
- locally eventhub consumer-group delete - Delete a Consumer Group from an Event Hub.
- locally eventhub consumer-group list - List Consumer Groups for an Event Hub.
- locally eventhub consumer-group show - Show details for a Consumer Group.
locally eventhub consumer-group create
Create a Consumer Group for an Event Hub.
Create a Consumer Group for an Event Hub. Examples: locally eventhub consumer-group create --namespace ns1 --hub orders --name billing
Usage
locally eventhub consumer-group create [flags]
Flags
-h, --help[=true|false] help for create
--hub string Name of the event hub
--name string Name of the consumer group
--namespace string Name of the Event Hubs namespace
locally eventhub consumer-group delete
Delete a Consumer Group from an Event Hub.
Delete a Consumer Group from an Event Hub. Examples: locally eventhub consumer-group delete --namespace ns1 --hub orders --name billing
Usage
locally eventhub consumer-group delete [flags]
Flags
-h, --help[=true|false] help for delete
--hub string Name of the event hub
--name string Name of the consumer group
--namespace string Name of the Event Hubs namespace
locally eventhub consumer-group list
List Consumer Groups for an Event Hub.
List Consumer Groups for an Event Hub. Examples: locally eventhub consumer-group list --namespace ns1 --hub orders
Usage
locally eventhub consumer-group list [flags]
Flags
-h, --help[=true|false] help for list
--hub string Name of the event hub
--namespace string Name of the Event Hubs namespace
locally eventhub consumer-group show
Show details for a Consumer Group.
Show details for a Consumer Group. Examples: locally eventhub consumer-group show --namespace ns1 --hub orders --name billing
Usage
locally eventhub consumer-group show [flags]
Flags
-h, --help[=true|false] help for show
--hub string Name of the event hub
--name string Name of the consumer group
--namespace string Name of the Event Hubs namespace
locally eventhub dashboard
Open the Data Plane Emulator UI for an Event Hubs Namespace in your browser.
Open the Data Plane Emulator UI for an Event Hubs Namespace in your browser. Examples: locally eventhub dashboard --namespace ns1
Usage
locally eventhub dashboard [flags]
Flags
-h, --help[=true|false] help for dashboard
--namespace string Name of the Event Hubs namespace
locally eventhub hub
Manage Event Hubs in an Event Hubs Namespace within Locally.
Usage
locally eventhub hub [flags] locally eventhub hub [command]
Flags
-h, --help[=true|false] help for hub
Subcommands
- locally eventhub hub create - Create an Event Hub in an Event Hubs Namespace.
- locally eventhub hub delete - Delete an Event Hub from an Event Hubs Namespace.
- locally eventhub hub list - List Event Hubs in an Event Hubs Namespace.
- locally eventhub hub peek - Peek at events in an Event Hub partition.
- locally eventhub hub send - Send an event to an Event Hub.
- locally eventhub hub show - Show details for an Event Hub in an Event Hubs Namespace.
locally eventhub hub create
Create an Event Hub in an Event Hubs Namespace.
Create an Event Hub in an Event Hubs Namespace. Examples: locally eventhub hub create --namespace ns1 --name orders --partition-count 4
Usage
locally eventhub hub create [flags]
Flags
-h, --help[=true|false] help for create
--name string Name of the event hub
--namespace string Name of the Event Hubs namespace
--partition-count int Number of partitions (default 4)
locally eventhub hub delete
Delete an Event Hub from an Event Hubs Namespace.
Delete an Event Hub from an Event Hubs Namespace. Examples: locally eventhub hub delete --namespace ns1 --name orders
Usage
locally eventhub hub delete [flags]
Flags
-h, --help[=true|false] help for delete
--name string Name of the event hub
--namespace string Name of the Event Hubs namespace
locally eventhub hub list
List Event Hubs in an Event Hubs Namespace.
List Event Hubs in an Event Hubs Namespace. Examples: locally eventhub hub list --namespace ns1
Usage
locally eventhub hub list [flags]
Flags
-h, --help[=true|false] help for list
--namespace string Name of the Event Hubs namespace
locally eventhub hub peek
Peek at events in an Event Hub partition.
Peek at events in an Event Hub partition. Examples: locally eventhub hub peek --namespace ns1 --name orders --partition 0 --limit 5
Usage
locally eventhub hub peek [flags]
Flags
-h, --help[=true|false] help for peek
--limit int Maximum number of events to peek (default 10)
--name string Name of the event hub
--namespace string Name of the Event Hubs namespace
--partition string Partition ID to peek
locally eventhub hub send
Send an event to an Event Hub.
Send an event to an Event Hub.
Examples:
locally eventhub hub send --namespace ns1 --name orders --body '{"id": 1}' --content-type application/json
locally eventhub hub send --namespace ns1 --name orders --body-file ./event.json --partition-key customer-42 --count 10
Usage
locally eventhub hub send [flags]
Flags
--body string Inline event body
--body-file string Path to a file containing the event body
--content-type string Content-Type of the event body
--count int Number of copies of the event to send (default 1)
-h, --help[=true|false] help for send
--name string Name of the event hub
--namespace string Name of the Event Hubs namespace
--partition-key string Partition key to route the event by
--property stringArray Custom event property as key=value (repeatable)
locally eventhub hub show
Show details for an Event Hub in an Event Hubs Namespace.
Show details for an Event Hub in an Event Hubs Namespace. Examples: locally eventhub hub show --namespace ns1 --name orders
Usage
locally eventhub hub show [flags]
Flags
-h, --help[=true|false] help for show
--name string Name of the event hub
--namespace string Name of the Event Hubs namespace
During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in