DisasterRecoveryConfigsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventHubManagementClient's

<xref:disaster_recovery_configs> attribute.

Inheritance
builtins.object
DisasterRecoveryConfigsOperations

Constructor

DisasterRecoveryConfigsOperations(*args, **kwargs)

Methods

break_pairing

This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces.

check_name_availability

Check the give Namespace name availability.

create_or_update

Creates or updates a new Alias(Disaster Recovery configuration).

delete

Deletes an Alias(Disaster Recovery configuration).

fail_over

Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace.

get

Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace.

get_authorization_rule

Gets an AuthorizationRule for a Namespace by rule name.

list

Gets all Alias(Disaster Recovery configurations).

list_authorization_rules

Gets a list of authorization rules for a Namespace.

list_keys

Gets the primary and secondary connection strings for the Namespace.

break_pairing

This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces.

async break_pairing(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

alias
Required
str

The Disaster Recovery configuration name. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description

check_name_availability

Check the give Namespace name availability.

async check_name_availability(resource_group_name: str, namespace_name: str, parameters: _models.CheckNameAvailabilityParameter, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityResult

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

parameters
Required

Parameters to check availability of the given Alias name. Is either a CheckNameAvailabilityParameter type or a IO[bytes] type. Required.

Returns

Type Description

CheckNameAvailabilityResult or the result of cls(response)

Exceptions

Type Description

create_or_update

Creates or updates a new Alias(Disaster Recovery configuration).

async create_or_update(resource_group_name: str, namespace_name: str, alias: str, parameters: _models.ArmDisasterRecovery, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ArmDisasterRecovery | None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

alias
Required
str

The Disaster Recovery configuration name. Required.

parameters
Required

Parameters required to create an Alias(Disaster Recovery configuration). Is either a ArmDisasterRecovery type or a IO[bytes] type. Required.

Returns

Type Description

ArmDisasterRecovery or None or the result of cls(response)

Exceptions

Type Description

delete

Deletes an Alias(Disaster Recovery configuration).

async delete(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

alias
Required
str

The Disaster Recovery configuration name. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description

fail_over

Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace.

async fail_over(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

alias
Required
str

The Disaster Recovery configuration name. Required.

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description

get

Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace.

async get(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) -> ArmDisasterRecovery

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

alias
Required
str

The Disaster Recovery configuration name. Required.

Returns

Type Description

ArmDisasterRecovery or the result of cls(response)

Exceptions

Type Description

get_authorization_rule

Gets an AuthorizationRule for a Namespace by rule name.

async get_authorization_rule(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) -> AuthorizationRule

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

alias
Required
str

The Disaster Recovery configuration name. Required.

authorization_rule_name
Required
str

The authorization rule name. Required.

Returns

Type Description

AuthorizationRule or the result of cls(response)

Exceptions

Type Description

list

Gets all Alias(Disaster Recovery configurations).

list(resource_group_name: str, namespace_name: str, **kwargs: Any) -> AsyncIterable[ArmDisasterRecovery]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

Returns

Type Description

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

Exceptions

Type Description

list_authorization_rules

Gets a list of authorization rules for a Namespace.

list_authorization_rules(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) -> AsyncIterable[AuthorizationRule]

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

alias
Required
str

The Disaster Recovery configuration name. Required.

Returns

Type Description

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

Exceptions

Type Description

list_keys

Gets the primary and secondary connection strings for the Namespace.

async list_keys(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) -> AccessKeys

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group within the azure subscription. Required.

namespace_name
Required
str

The Namespace name. Required.

alias
Required
str

The Disaster Recovery configuration name. Required.

authorization_rule_name
Required
str

The authorization rule name. Required.

Returns

Type Description

AccessKeys or the result of cls(response)

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.eventhub.v2017_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2017_04_01\\models\\__init__.py'>