DisasterRecoveryConfigsOperations Class

DisasterRecoveryConfigsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

DisasterRecoveryConfigsOperations

Constructor

DisasterRecoveryConfigsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

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

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

alias

str

Required

The Disaster Recovery configuration name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

check_name_availability

Check the give Namespace name availability.

check_name_availability(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.eventhub.v2021_11_01.models._models_py3.CheckNameAvailabilityParameter, **kwargs: Any) -> azure.mgmt.eventhub.v2021_11_01.models._models_py3.CheckNameAvailabilityResult

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

parameters

CheckNameAvailabilityParameter

Required

Parameters to check availability of the given Alias name.

cls

callable

A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityResult, or the result of cls(response)

Return type

CheckNameAvailabilityResult

Exceptions

HttpResponseError

create_or_update

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

create_or_update(resource_group_name: str, namespace_name: str, alias: str, parameters: azure.mgmt.eventhub.v2021_11_01.models._models_py3.ArmDisasterRecovery, **kwargs: Any) -> Optional[azure.mgmt.eventhub.v2021_11_01.models._models_py3.ArmDisasterRecovery]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

alias

str

Required

The Disaster Recovery configuration name.

parameters

ArmDisasterRecovery

Required

Parameters required to create an Alias(Disaster Recovery configuration).

cls

callable

A custom type or function that will be passed the direct response

Returns

ArmDisasterRecovery, or the result of cls(response)

Return type

ArmDisasterRecovery,

None

Exceptions

HttpResponseError

delete

Deletes an Alias(Disaster Recovery configuration).

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

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

alias

str

Required

The Disaster Recovery configuration name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

fail_over

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

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

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

alias

str

Required

The Disaster Recovery configuration name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

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

get(resource_group_name: str, namespace_name: str, alias: str, **kwargs: Any) -> azure.mgmt.eventhub.v2021_11_01.models._models_py3.ArmDisasterRecovery

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

alias

str

Required

The Disaster Recovery configuration name.

cls

callable

A custom type or function that will be passed the direct response

Returns

ArmDisasterRecovery, or the result of cls(response)

Return type

ArmDisasterRecovery

Exceptions

HttpResponseError

get_authorization_rule

Gets an AuthorizationRule for a Namespace by rule name.

get_authorization_rule(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2021_11_01.models._models_py3.AuthorizationRule

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

alias

str

Required

The Disaster Recovery configuration name.

authorization_rule_name

str

Required

The authorization rule name.

cls

callable

A custom type or function that will be passed the direct response

Returns

AuthorizationRule, or the result of cls(response)

Return type

AuthorizationRule

Exceptions

HttpResponseError

list

Gets all Alias(Disaster Recovery configurations).

list(resource_group_name: str, namespace_name: str, **kwargs: Any) -> Iterable[azure.mgmt.eventhub.v2021_11_01.models._models_py3.ArmDisasterRecoveryListResult]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ArmDisasterRecoveryListResult]

Exceptions

HttpResponseError

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) -> Iterable[azure.mgmt.eventhub.v2021_11_01.models._models_py3.AuthorizationRuleListResult]

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

alias

str

Required

The Disaster Recovery configuration name.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AuthorizationRuleListResult]

Exceptions

HttpResponseError

list_keys

Gets the primary and secondary connection strings for the Namespace.

list_keys(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs: Any) -> azure.mgmt.eventhub.v2021_11_01.models._models_py3.AccessKeys

Parameters

resource_group_name

str

Required

Name of the resource group within the azure subscription.

namespace_name

str

Required

The Namespace name.

alias

str

Required

The Disaster Recovery configuration name.

authorization_rule_name

str

Required

The authorization rule name.

cls

callable

A custom type or function that will be passed the direct response

Returns

AccessKeys, or the result of cls(response)

Return type

AccessKeys

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.eventhub.v2021_11_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\eventhub\\v2021_11_01\\models\\__init__.py'>