IoT hub consumer groups - az iot hub consumer-group

Manage event hub consumer groups of an IoT Hub.

These commands are in preview.

Commands

az iot hub consumer-group create Create an event hub consumer group.
az iot hub consumer-group delete Delete an event hub consumer group.
az iot hub consumer-group list List all event hub consumer groups.
az iot hub consumer-group show Get an event hub consumer group.

az iot hub consumer-group create

Create an event hub consumer group.

az iot hub consumer-group create --hub-name
--name
[--event-hub-name]
[--resource-group]

Examples

Create a consumer group `cg1` in the default event hub endpoint `events`.

az iot hub consumer-group create --hub-name MyIotHub --name cg1

Create a consumer group `cg1` in the operation monitoring event hub endpoint `operationsMonitoringEvents`.

az iot hub consumer-group create --hub-name MyIotHub --event-hub-name operationsMonitoringEvents --name cg1

Required Parameters

--hub-name

IoT Hub name.

--name -n

Event hub consumer group name.

Optional Parameters

--event-hub-name

Event hub endpoint name.

default value: events
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az iot hub consumer-group delete

Delete an event hub consumer group.

az iot hub consumer-group delete --hub-name
--name
[--event-hub-name]
[--resource-group]

Required Parameters

--hub-name

IoT Hub name.

--name -n

Event hub consumer group name.

Optional Parameters

--event-hub-name

Event hub endpoint name.

default value: events
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az iot hub consumer-group list

List all event hub consumer groups.

az iot hub consumer-group list --hub-name
[--event-hub-name]
[--resource-group]

Required Parameters

--hub-name

IoT Hub name.

Optional Parameters

--event-hub-name

Event hub endpoint name.

default value: events
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az iot hub consumer-group show

Get an event hub consumer group.

az iot hub consumer-group show --hub-name
--name
[--event-hub-name]
[--resource-group]

Required Parameters

--hub-name

IoT Hub name.

--name -n

Event hub consumer group name.

Optional Parameters

--event-hub-name

Event hub endpoint name.

default value: events
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.