ConsumerGroupsOperations Class

ConsumerGroupsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
ConsumerGroupsOperations

Constructor

ConsumerGroupsOperations(client, config, serializer, deserializer) -> None

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.eventhub.v2015_08_01.models._models_py3.ConsumerGroupCreateOrUpdateParameters, **kwargs: typing.Any) -> azure.mgmt.eventhub.v2015_08_01.models._models_py3.ConsumerGroupResource

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

event_hub_name
str
Required

The Event Hub name.

consumer_group_name
str
Required

The consumer group name.

parameters
ConsumerGroupCreateOrUpdateParameters
Required

Parameters supplied to create or update a consumer group resource.

cls
callable

A custom type or function that will be passed the direct response

Returns

ConsumerGroupResource, or the result of cls(response)

Return type

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: typing.Any) -> None

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

event_hub_name
str
Required

The Event Hub name.

consumer_group_name
str
Required

The consumer group name.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

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: typing.Any) -> azure.mgmt.eventhub.v2015_08_01.models._models_py3.ConsumerGroupResource

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

event_hub_name
str
Required

The Event Hub name.

consumer_group_name
str
Required

The consumer group name.

cls
callable

A custom type or function that will be passed the direct response

Returns

ConsumerGroupResource, or the result of cls(response)

Return type

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: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.ConsumerGroupListResult')]

Parameters

resource_group_name
str
Required

Name of the resource group within the azure subscription.

namespace_name
str
Required

The Namespace name.

event_hub_name
str
Required

The Event Hub name.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Attributes

models

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