resource_event_hub_consumer_groups

Creates, updates, deletes, gets or lists a resource_event_hub_consumer_groups resource.

Overview

Name	resource_event_hub_consumer_groups
Type	Resource
Id	azure.iot_hub.resource_event_hub_consumer_groups

Fields

The following fields are returned by SELECT queries:

get

This is a synchronous operation. The body contains a JSON-serialized consumer group.

Name	Datatype	Description
id	string	The Event Hub-compatible consumer group identifier.
name	string	The Event Hub-compatible consumer group name.
etag	string	The etag.
properties	object	The tags.
type	string	the resource type.

list

This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the Event Hub-compatible endpoint in this IoT hub

Name	Datatype	Description
id	string	The Event Hub-compatible consumer group identifier.
name	string	The Event Hub-compatible consumer group name.
etag	string	The etag.
properties	object	The tags.
type	string	the resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, eventHubEndpointName, name	api-version	Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.
list	select	subscriptionId, resourceGroupName, resourceName, eventHubEndpointName	api-version	Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.
create	insert	subscriptionId, resourceGroupName, resourceName, eventHubEndpointName, name, data__properties	api-version	Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.
delete	delete	subscriptionId, resourceGroupName, resourceName, eventHubEndpointName, name	api-version	Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
eventHubEndpointName	string	The name of the Event Hub-compatible endpoint in the IoT hub.
name	string	The name of the consumer group to delete.
resourceGroupName	string	The name of the resource group that contains the IoT hub.
resourceName	string	The name of the IoT hub.
subscriptionId	string	The subscription identifier.
api-version	string	The version of the API.

SELECT examples

get

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

SELECT
id,
name,
etag,
properties,
type
FROM azure.iot_hub.resource_event_hub_consumer_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND eventHubEndpointName = '{{ eventHubEndpointName }}' -- required
AND name = '{{ name }}' -- required
AND api-version = '{{ api-version }}'
;

list

Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

SELECT
id,
name,
etag,
properties,
type
FROM azure.iot_hub.resource_event_hub_consumer_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND eventHubEndpointName = '{{ eventHubEndpointName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.

INSERT INTO azure.iot_hub.resource_event_hub_consumer_groups (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
eventHubEndpointName,
name,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ eventHubEndpointName }}',
'{{ name }}',
'{{ api-version }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: resource_event_hub_consumer_groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the resource_event_hub_consumer_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the resource_event_hub_consumer_groups resource.
    - name: resourceName
      value: string
      description: Required parameter for the resource_event_hub_consumer_groups resource.
    - name: eventHubEndpointName
      value: string
      description: Required parameter for the resource_event_hub_consumer_groups resource.
    - name: name
      value: string
      description: Required parameter for the resource_event_hub_consumer_groups resource.
    - name: properties
      value: object
      description: |
        The EventHub consumer group name.
    - name: api-version
      value: string
      description: The version of the API.

DELETE examples

delete

Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.

DELETE FROM azure.iot_hub.resource_event_hub_consumer_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND eventHubEndpointName = '{{ eventHubEndpointName }}' --required
AND name = '{{ name }}' --required
AND api-version = '{{ api-version }}'
;