ConsumerGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventHubManagementClient's

<xref:consumer_groups> attribute.

Inheritance
builtins.object
ConsumerGroupsOperations

Constructor

ConsumerGroupsOperations(*args, **kwargs)

Methods

create_or_update

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.

list_all

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

create_or_update

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

create_or_update(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, parameters: _models.ConsumerGroupCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ConsumerGroupResource

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

event_hub_name
Required
str

The Event Hub name. Required.

consumer_group_name
Required
str

The consumer group name. Required.

parameters
Required

Parameters supplied to create or update a consumer group resource. Is either a ConsumerGroupCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description

ConsumerGroupResource or the result of cls(response)

Exceptions

Type Description
See also

delete

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

delete(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

event_hub_name
Required
str

The Event Hub name. Required.

consumer_group_name
Required
str

The consumer group name. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

get

Gets a description for the specified consumer group.

get(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) -> ConsumerGroupResource

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

event_hub_name
Required
str

The Event Hub name. Required.

consumer_group_name
Required
str

The consumer group name. Required.

Returns

Type Description

ConsumerGroupResource or the result of cls(response)

Exceptions

Type Description
See also

list_all

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

list_all(resource_group_name: str, namespace_name: str, event_hub_name: str, **kwargs: Any) -> Iterable[ConsumerGroupResource]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

event_hub_name
Required
str

The Event Hub name. Required.

Returns

Type Description

An iterator like instance of either ConsumerGroupResource or the result of cls(response)

Exceptions

Type Description
See also

Attributes

models

models = <module 'azure.mgmt.eventhub.v2015_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2015_08_01\\models\\__init__.py'>