Share via

az iot hub consumer-group

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage the event hub consumer groups of an IoT hub.

Commands

Name Description Type Status
az iot hub consumer-group create

Create an event hub consumer group.

 Core GA
az iot hub consumer-group create (azure-iot extension)

Create an event hub consumer group.

 Extension GA
az iot hub consumer-group delete

Delete an event hub consumer group.

 Core GA
az iot hub consumer-group delete (azure-iot extension)

Delete an event hub consumer group.

 Extension GA
az iot hub consumer-group list

List event hub consumer groups.

 Core GA
az iot hub consumer-group list (azure-iot extension)

List event hub consumer groups.

 Extension GA
az iot hub consumer-group show

Get the details for an event hub consumer group.

 Core GA
az iot hub consumer-group show (azure-iot extension)

Get the details for an event hub consumer group.

 Extension GA

az iot hub consumer-group create

Edit

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.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

Event hub endpoint name.

Property Value
Default value: events
--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot hub consumer-group create (azure-iot extension)

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.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

Event hub endpoint name.

Property Value
Default value: events
--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot hub consumer-group delete

Edit

Delete an event hub consumer group.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

Event hub endpoint name.

Property Value
Parameter group: Resource Id Arguments
Default value: events
--hub-name

IoT Hub name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Event hub consumer group name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot hub consumer-group delete (azure-iot extension)

Delete an event hub consumer group.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

Event hub endpoint name.

Property Value
Parameter group: Resource Id Arguments
Default value: events
--hub-name

IoT Hub name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Event hub consumer group name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot hub consumer-group list

Edit

List event hub consumer groups.

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

Examples

List event hub consumer groups. (autogenerated)

az iot hub consumer-group list --hub-name MyHub

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

Event hub endpoint name.

Property Value
Parameter group: Resource Id Arguments
Default value: events
--hub-name

IoT Hub name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot hub consumer-group list (azure-iot extension)

List event hub consumer groups.

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

Examples

List event hub consumer groups. (autogenerated)

az iot hub consumer-group list --hub-name MyHub

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

Event hub endpoint name.

Property Value
Parameter group: Resource Id Arguments
Default value: events
--hub-name

IoT Hub name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot hub consumer-group show

Edit

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]

Examples

Get the details for an event hub consumer group. (autogenerated)

az iot hub consumer-group show --hub-name MyHub --name MyEventHubConsumerGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

Event hub endpoint name.

Property Value
Parameter group: Resource Id Arguments
Default value: events
--hub-name

IoT Hub name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Event hub consumer group name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az iot hub consumer-group show (azure-iot extension)

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]

Examples

Get the details for an event hub consumer group. (autogenerated)

az iot hub consumer-group show --hub-name MyHub --name MyEventHubConsumerGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

Event hub endpoint name.

Property Value
Parameter group: Resource Id Arguments
Default value: events
--hub-name

IoT Hub name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Event hub consumer group name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False