ConsumerGroupsOperations interface

Package:

@azure/arm-eventhub

Interface representing a ConsumerGroups operations.

Properties

createOrUpdate	Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.
delete	Deletes a consumer group from the specified Event Hub and resource group.
get	Gets a description for the specified consumer group.
listByEventHub	Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.

Property Details

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, parameters: ConsumerGroup, options?: ConsumerGroupsCreateOrUpdateOptionalParams) => Promise<ConsumerGroup>

Property Value

(resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, parameters: ConsumerGroup, options?: ConsumerGroupsCreateOrUpdateOptionalParams) => Promise<ConsumerGroup>

delete

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

delete: (resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, options?: ConsumerGroupsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, options?: ConsumerGroupsDeleteOptionalParams) => Promise<void>

get

Gets a description for the specified consumer group.

get: (resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, options?: ConsumerGroupsGetOptionalParams) => Promise<ConsumerGroup>

Property Value

(resourceGroupName: string, namespaceName: string, eventHubName: string, consumerGroupName: string, options?: ConsumerGroupsGetOptionalParams) => Promise<ConsumerGroup>

listByEventHub

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

listByEventHub: (resourceGroupName: string, namespaceName: string, eventHubName: string, options?: ConsumerGroupsListByEventHubOptionalParams) => PagedAsyncIterableIterator<ConsumerGroup, ConsumerGroup[], PageSettings>

Property Value

(resourceGroupName: string, namespaceName: string, eventHubName: string, options?: ConsumerGroupsListByEventHubOptionalParams) => PagedAsyncIterableIterator<ConsumerGroup, ConsumerGroup[], PageSettings>