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

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

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

SELECT examples

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 eventHubEndpointName = '{{ eventHubEndpointName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new resource_event_hub_consumer_groups resource.

All Properties

/*+ create */
INSERT INTO azure.iot_hub.resource_event_hub_consumer_groups (
eventHubEndpointName,
name,
resourceGroupName,
resourceName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ eventHubEndpointName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: name
          value: string

DELETE example

Deletes the specified resource_event_hub_consumer_groups resource.

/*+ delete */
DELETE FROM azure.iot_hub.resource_event_hub_consumer_groups
WHERE eventHubEndpointName = '{{ eventHubEndpointName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';