az iot hub consumer-group

Manage the event hub consumer groups of an IoT hub.

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 event hub consumer groups.
az iot hub consumer-group show Get the details for 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]
[--subscription]

Examples

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

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=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az iot hub consumer-group delete

Delete an event hub consumer group.

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

Optional Parameters

--event-hub-name

Event hub endpoint name.

default value: events
--hub-name

IoT Hub name.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Event hub consumer group name.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az iot hub consumer-group list

List event hub consumer groups.

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

Optional Parameters

--event-hub-name

Event hub endpoint name.

default value: events
--hub-name

IoT Hub name.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az iot hub consumer-group show

Get the details for an event hub consumer group.

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

Optional Parameters

--event-hub-name

Event hub endpoint name.

default value: events
--hub-name

IoT Hub name.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Event hub consumer group name.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.