azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations
name: ConsumerGroupsOperations
fullName: azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations
module: azure.mgmt.eventhub.v2018_01_01_preview.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.eventhub.v2018_01_01_preview.EventHubManagementClient>'s\n\
  >\n> <xref:consumer_groups> attribute.\n>"
constructor:
  syntax: ConsumerGroupsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations.create_or_update
  name: create_or_update
  summary: Creates or updates an Event Hubs consumer group as a nested resource within
    a Namespace.
  signature: 'create_or_update(resource_group_name: str, namespace_name: str, event_hub_name:
    str, consumer_group_name: str, parameters: _models.ConsumerGroup, *, content_type:
    str = ''application/json'', **kwargs: Any) -> _models.ConsumerGroup'
  parameters:
  - name: resource_group_name
    description: Name of the resource group within the azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The Namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: event_hub_name
    description: The Event Hub name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: consumer_group_name
    description: The consumer group name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to create or update a consumer group resource.
      Is either

      a ConsumerGroup type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.ConsumerGroup>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ConsumerGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.ConsumerGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations.delete
  name: delete
  summary: Deletes a consumer group from the specified Event Hub and resource group.
  signature: 'delete(resource_group_name: str, namespace_name: str, event_hub_name:
    str, consumer_group_name: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the resource group within the azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The Namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: event_hub_name
    description: The Event Hub name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: consumer_group_name
    description: The consumer group name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations.get
  name: get
  summary: Gets a description for the specified consumer group.
  signature: 'get(resource_group_name: str, namespace_name: str, event_hub_name: str,
    consumer_group_name: str, **kwargs: Any) -> ConsumerGroup'
  parameters:
  - name: resource_group_name
    description: Name of the resource group within the azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The Namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: event_hub_name
    description: The Event Hub name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: consumer_group_name
    description: The consumer group name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: ConsumerGroup or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.ConsumerGroup>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations.list_by_event_hub
  name: list_by_event_hub
  summary: 'Gets all the consumer groups in a Namespace. An empty feed is returned
    if no consumer group

    exists in the Namespace.'
  signature: 'list_by_event_hub(resource_group_name: str, namespace_name: str, event_hub_name:
    str, skip: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ConsumerGroup]'
  parameters:
  - name: resource_group_name
    description: Name of the resource group within the azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The Namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: event_hub_name
    description: The Event Hub name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: skip
    description: 'Skip is only used if a previous operation returned a partial result.
      If a previous

      response contains a nextLink element, the value of the nextLink element will
      include a skip

      parameter that specifies a starting point to use for subsequent calls. Default
      value is None.'
    isRequired: true
    types:
    - <xref:int>
  - name: top
    description: 'May be used to limit the number of results to the most recent N
      usageDetails.

      Default value is None.'
    isRequired: true
    types:
    - <xref:int>
  return:
    description: An iterator like instance of either ConsumerGroup or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.eventhub.v2018_01_01_preview.models.ConsumerGroup>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.eventhub.v2018_01_01_preview.operations.ConsumerGroupsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.eventhub.v2018_01_01_preview.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2018_01_01_preview\\models\\__init__.py'>