Microsoft.Devices IotHubs/eventHubEndpoints/ConsumerGroups 2021-03-31
Bicep resource definition
The IotHubs/eventHubEndpoints/ConsumerGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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 Bicep to your template.
resource symbolicname 'Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-03-31' = {
name: 'string'
parent: resourceSymbolicName
properties: {
name: 'string'
}
}
Property values
IotHubs/eventHubEndpoints/ConsumerGroups
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-50 Valid characters: Alphanumerics, hyphens, periods, and underscores. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: eventHubEndpoints |
| 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 |
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 |
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 |
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. |
ARM template resource definition
The IotHubs/eventHubEndpoints/ConsumerGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2021-03-31",
"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 | '2021-03-31' |
| 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 |
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 |
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 |
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. |
Terraform (AzAPI provider) resource definition
The IotHubs/eventHubEndpoints/ConsumerGroups resource type can be deployed with operations that target:
- Resource groups
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 Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-03-31"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
name = "string"
}
})
}
Property values
IotHubs/eventHubEndpoints/ConsumerGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Devices/IotHubs/eventHubEndpoints/ConsumerGroups@2021-03-31" |
| name | The resource name | string (required) Character limit: 1-50 Valid characters: Alphanumerics, hyphens, periods, and underscores. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: eventHubEndpoints |
| properties | The EventHub consumer group name. | EventHubConsumerGroupNameOrEventHubConsumerGroupInfo... (required) |
EventHubConsumerGroupNameOrEventHubConsumerGroupInfo...
| Name | Description | Value |
|---|---|---|
| name | EventHub consumer group name | string (required) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for