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

The following fields are returned by SELECT queries:

get

Successfully retrieved the consumer group description.

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	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

list_by_event_hub

Successfully retrieved the list of consumer groups.

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	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, eventHubName, consumerGroupName, subscriptionId		Gets a description for the specified consumer group.
list_by_event_hub	select	resourceGroupName, namespaceName, eventHubName, subscriptionId	$skip, $top	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	resourceGroupName, namespaceName, eventHubName, consumerGroupName, subscriptionId		Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
delete	delete	resourceGroupName, namespaceName, eventHubName, consumerGroupName, subscriptionId		Deletes a consumer group from the specified Event Hub and resource group.

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
consumerGroupName	string	The consumer group name
eventHubName	string	The Event Hub name
namespaceName	string	The Namespace name
resourceGroupName	string	Name of the resource group within the azure subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$skip	integer	Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
$top	integer	May be used to limit the number of results to the most recent N usageDetails.

SELECT examples

get

Gets a description for the specified consumer group.

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

list_by_event_hub

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 resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND eventHubName = '{{ eventHubName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.

INSERT INTO azure.event_hubs.consumer_groups (
data__properties,
resourceGroupName,
namespaceName,
eventHubName,
consumerGroupName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ eventHubName }}',
'{{ consumerGroupName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: consumer_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the consumer_groups resource.
    - name: namespaceName
      value: string
      description: Required parameter for the consumer_groups resource.
    - name: eventHubName
      value: string
      description: Required parameter for the consumer_groups resource.
    - name: consumerGroupName
      value: string
      description: Required parameter for the consumer_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the consumer_groups resource.
    - name: properties
      value: string
      description: |
        Single item in List or Get Consumer group operation

DELETE examples

delete

Deletes a consumer group from the specified Event Hub and resource group.

DELETE FROM azure.event_hubs.consumer_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND eventHubName = '{{ eventHubName }}' --required
AND consumerGroupName = '{{ consumerGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;