azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations
name: EventHubsOperations
fullName: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations
module: azure.mgmt.eventhub.v2018_01_01_preview.aio.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.aio.EventHubManagementClient>'s\n\
  >\n> <xref:event_hubs> attribute.\n>"
constructor:
  syntax: EventHubsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.create_or_update
  name: create_or_update
  summary: Creates or updates a new Event Hub as a nested resource within a Namespace.
  signature: 'async create_or_update(resource_group_name: str, namespace_name: str,
    event_hub_name: str, parameters: _models.Eventhub, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.Eventhub'
  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: parameters
    description: 'Parameters supplied to create an Event Hub resource. Is either a
      Eventhub

      type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.Eventhub>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Eventhub or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.Eventhub>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.create_or_update_authorization_rule
  name: create_or_update_authorization_rule
  summary: 'Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update
    of the

    AuthorizationRule will take a few seconds to take effect.'
  signature: 'async create_or_update_authorization_rule(resource_group_name: str,
    namespace_name: str, event_hub_name: str, authorization_rule_name: str, parameters:
    _models.AuthorizationRule, *, content_type: str = ''application/json'', **kwargs:
    Any) -> _models.AuthorizationRule'
  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: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The shared access AuthorizationRule. Is either a AuthorizationRule
      type or a

      IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.AuthorizationRule>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: AuthorizationRule or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.AuthorizationRule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.delete
  name: delete
  summary: Deletes an Event Hub from the specified Namespace and resource group.
  signature: 'async delete(resource_group_name: str, namespace_name: str, event_hub_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>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  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.aio.operations.EventHubsOperations.delete_authorization_rule
  name: delete_authorization_rule
  summary: Deletes an Event Hub AuthorizationRule.
  signature: 'async delete_authorization_rule(resource_group_name: str, namespace_name:
    str, event_hub_name: str, authorization_rule_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: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  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.aio.operations.EventHubsOperations.get
  name: get
  summary: Gets an Event Hubs description for the specified Event Hub.
  signature: 'async get(resource_group_name: str, namespace_name: str, event_hub_name:
    str, **kwargs: Any) -> Eventhub'
  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>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Eventhub or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.Eventhub>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.get_authorization_rule
  name: get_authorization_rule
  summary: Gets an AuthorizationRule for an Event Hub by rule name.
  signature: 'async get_authorization_rule(resource_group_name: str, namespace_name:
    str, event_hub_name: str, authorization_rule_name: str, **kwargs: Any) -> AuthorizationRule'
  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: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: AuthorizationRule or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.AuthorizationRule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.list_authorization_rules
  name: list_authorization_rules
  summary: Gets the authorization rules for an Event Hub.
  signature: 'list_authorization_rules(resource_group_name: str, namespace_name: str,
    event_hub_name: str, **kwargs: Any) -> AsyncIterable[AuthorizationRule]'
  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>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either AuthorizationRule or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.eventhub.v2018_01_01_preview.models.AuthorizationRule>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.list_by_namespace
  name: list_by_namespace
  summary: Gets all the Event Hubs in a Namespace.
  signature: 'list_by_namespace(resource_group_name: str, namespace_name: str, skip:
    int | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[Eventhub]'
  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: 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>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either Eventhub or the result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.eventhub.v2018_01_01_preview.models.Eventhub>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.list_keys
  name: list_keys
  summary: Gets the ACS and SAS connection strings for the Event Hub.
  signature: 'async list_keys(resource_group_name: str, namespace_name: str, event_hub_name:
    str, authorization_rule_name: str, **kwargs: Any) -> AccessKeys'
  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: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: AccessKeys or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.AccessKeys>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.regenerate_keys
  name: regenerate_keys
  summary: Regenerates the ACS and SAS connection strings for the Event Hub.
  signature: 'async regenerate_keys(resource_group_name: str, namespace_name: str,
    event_hub_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.AccessKeys'
  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: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to regenerate the AuthorizationRule Keys

      (PrimaryKey/SecondaryKey). Is either a RegenerateAccessKeyParameters type or
      a IO type.

      Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.RegenerateAccessKeyParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: AccessKeys or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2018_01_01_preview.models.AccessKeys>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.eventhub.v2018_01_01_preview.aio.operations.EventHubsOperations.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'>