azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations
name: DisasterRecoveryConfigsOperations
fullName: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations
module: azure.mgmt.eventhub.v2022_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.v2022_01_01_preview.EventHubManagementClient>'s\n\
  >\n> <xref:disaster_recovery_configs> attribute.\n>"
constructor:
  syntax: DisasterRecoveryConfigsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.break_pairing
  name: break_pairing
  summary: 'This operation disables the Disaster Recovery and stops replicating changes
    from primary to

    secondary namespaces.'
  signature: 'break_pairing(resource_group_name: str, namespace_name: str, alias:
    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: alias
    description: The Disaster Recovery configuration 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.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.check_name_availability
  name: check_name_availability
  summary: Check the give Namespace name availability.
  signature: 'check_name_availability(resource_group_name: str, namespace_name: str,
    parameters: _models.CheckNameAvailabilityParameter, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.CheckNameAvailabilityResult'
  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: parameters
    description: 'Parameters to check availability of the given Alias name. Is either
      a

      CheckNameAvailabilityParameter type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.CheckNameAvailabilityParameter>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: CheckNameAvailabilityResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.CheckNameAvailabilityResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.create_or_update
  name: create_or_update
  summary: Creates or updates a new Alias(Disaster Recovery configuration).
  signature: 'create_or_update(resource_group_name: str, namespace_name: str, alias:
    str, parameters: _models.ArmDisasterRecovery, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.ArmDisasterRecovery'
  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: alias
    description: The Disaster Recovery configuration name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters required to create an Alias(Disaster Recovery configuration).
      Is

      either a ArmDisasterRecovery type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.ArmDisasterRecovery>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: ArmDisasterRecovery or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.ArmDisasterRecovery>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.delete
  name: delete
  summary: Deletes an Alias(Disaster Recovery configuration).
  signature: 'delete(resource_group_name: str, namespace_name: str, alias: 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: alias
    description: The Disaster Recovery configuration 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.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.fail_over
  name: fail_over
  summary: Invokes GEO DR failover and reconfigure the alias to point to the secondary
    namespace.
  signature: 'fail_over(resource_group_name: str, namespace_name: str, alias: 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: alias
    description: The Disaster Recovery configuration 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.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.get
  name: get
  summary: Retrieves Alias(Disaster Recovery configuration) for primary or secondary
    namespace.
  signature: 'get(resource_group_name: str, namespace_name: str, alias: str, **kwargs:
    Any) -> ArmDisasterRecovery'
  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: alias
    description: The Disaster Recovery configuration name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: ArmDisasterRecovery or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.ArmDisasterRecovery>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.get_authorization_rule
  name: get_authorization_rule
  summary: Gets an AuthorizationRule for a Namespace by rule name.
  signature: 'get_authorization_rule(resource_group_name: str, namespace_name: str,
    alias: 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: alias
    description: The Disaster Recovery configuration name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: AuthorizationRule or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.AuthorizationRule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.list
  name: list
  summary: Gets all Alias(Disaster Recovery configurations).
  signature: 'list(resource_group_name: str, namespace_name: str, **kwargs: Any) ->
    Iterable[ArmDisasterRecovery]'
  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>
  return:
    description: An iterator like instance of either ArmDisasterRecovery or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.eventhub.v2022_01_01_preview.models.ArmDisasterRecovery>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.list_authorization_rules
  name: list_authorization_rules
  summary: Gets a list of authorization rules for a Namespace.
  signature: 'list_authorization_rules(resource_group_name: str, namespace_name: str,
    alias: str, **kwargs: Any) -> Iterable[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: alias
    description: The Disaster Recovery configuration name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either AuthorizationRule or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.eventhub.v2022_01_01_preview.models.AuthorizationRule>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.list_keys
  name: list_keys
  summary: Gets the primary and secondary connection strings for the Namespace.
  signature: 'list_keys(resource_group_name: str, namespace_name: str, alias: 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: alias
    description: The Disaster Recovery configuration name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: AccessKeys or the result of cls(response)
    types:
    - <xref:azure.mgmt.eventhub.v2022_01_01_preview.models.AccessKeys>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.eventhub.v2022_01_01_preview.operations.DisasterRecoveryConfigsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.eventhub.v2022_01_01_preview.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2022_01_01_preview\\models\\__init__.py'>