Microsoft.Devices IotHubs/eventHubEndpoints/ConsumerGroups

ARM template resource definition

The IotHubs/eventHubEndpoints/ConsumerGroups resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups",
  "apiVersion": "2023-06-30",
  "name": "string",
  "properties": {
    "name": "string"
  }
}

Property values

IotHubs/eventHubEndpoints/ConsumerGroups

Name Description Value
type The resource type 'Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups'
apiVersion The resource api version '2023-06-30'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)

Character limit: 1-50

Valid characters:
Alphanumerics, hyphens, periods, and underscores.
properties The EventHub consumer group name. EventHubConsumerGroupNameOrEventHubConsumerGroupInfo... (required)

EventHubConsumerGroupNameOrEventHubConsumerGroupInfo...

Name Description Value
name EventHub consumer group name string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an IoT Hub and a Device to Cloud Consumer Group

Deploy to Azure
This template enables you to deploy an IoT Hub instance with device to cloud and cloud to device messaging configurations and a device to cloud consumer group.
Create Device Update for IoT Hub account, instance, IoT Hub

Deploy to Azure
This template creates an account, and an instance and a hub to link the instance with. It configures the hub with the necessary access polices, routes, and consumer group.
Create a Pay As You Go (PAYG) Environment with an IoT Hub

Deploy to Azure
This template enables you to deploy a Pay As You Go (PAYG) Time Series Insights environment that is configured to consume events from an IoT Hub.