ConsumerGroupsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:consumer_groups> attribute.
- Inheritance
-
builtins.objectConsumerGroupsOperations
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.
async 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.ConsumerGroupResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
consumer_group_name
Required
|
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 |
|---|---|
delete
Deletes a consumer group from the specified Event Hub and resource group.
async delete(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
consumer_group_name
Required
|
The consumer group name. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a description for the specified consumer group.
async get(resource_group_name: str, namespace_name: str, event_hub_name: str, consumer_group_name: str, **kwargs: Any) -> ConsumerGroupResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
|
consumer_group_name
Required
|
The consumer group name. Required. |
Returns
| Type | Description |
|---|---|
|
ConsumerGroupResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncIterable[ConsumerGroupResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group within the azure subscription. Required. |
|
namespace_name
Required
|
The Namespace name. Required. |
|
event_hub_name
Required
|
The Event Hub name. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ConsumerGroupResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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'>
Azure SDK for Python