ConsumerGroups interface

Package:

@azure/arm-eventhub

Interface representing a ConsumerGroups.

Methods

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

Method Details

createOrUpdate(string, string, string, string, ConsumerGroup, ConsumerGroupsCreateOrUpdateOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

consumerGroupName

string

The consumer group name

parameters

ConsumerGroup

Parameters supplied to create or update a consumer group resource.

options

ConsumerGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ConsumerGroup>

delete(string, string, string, string, ConsumerGroupsDeleteOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

consumerGroupName

string

The consumer group name

options

ConsumerGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, ConsumerGroupsGetOptionalParams)

Gets a description for the specified consumer group.

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

consumerGroupName

string

The consumer group name

options

ConsumerGroupsGetOptionalParams

The options parameters.

Returns

Promise<ConsumerGroup>

listByEventHub(string, string, string, ConsumerGroupsListByEventHubOptionalParams)

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

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

Parameters

resourceGroupName

string

Name of the resource group within the azure subscription.

namespaceName

string

The Namespace name

eventHubName

string

The Event Hub name

options

ConsumerGroupsListByEventHubOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConsumerGroup, ConsumerGroup[], PageSettings>