consumer_groups

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

Overview

Name	consumer_groups
Type	Resource
Id	azure.event_hubs.consumer_groups

Fields

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
location	string	The geo-location where the resource lives
properties	``	Single item in List or Get Consumer group operation
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	consumerGroupName, eventHubName, namespaceName, resourceGroupName, subscriptionId	Gets a description for the specified consumer group.
list_by_event_hub	SELECT	eventHubName, namespaceName, resourceGroupName, subscriptionId	Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.
create_or_update	INSERT	consumerGroupName, eventHubName, namespaceName, resourceGroupName, subscriptionId	Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
delete	DELETE	consumerGroupName, eventHubName, namespaceName, resourceGroupName, subscriptionId	Deletes a consumer group from the specified Event Hub and resource group.

SELECT examples

Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.event_hubs.consumer_groups
WHERE eventHubName = '{{ eventHubName }}'
AND namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.event_hubs.consumer_groups (
consumerGroupName,
eventHubName,
namespaceName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ consumerGroupName }}',
'{{ eventHubName }}',
'{{ namespaceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string

DELETE example

Deletes the specified consumer_groups resource.

/*+ delete */
DELETE FROM azure.event_hubs.consumer_groups
WHERE consumerGroupName = '{{ consumerGroupName }}'
AND eventHubName = '{{ eventHubName }}'
AND namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';