DisasterRecoveryConfigsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:disaster_recovery_configs> attribute.

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 authorization rule for a namespace by rule name.
list	Gets all Alias(Disaster Recovery configurations).
list_authorization_rules	Gets the 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

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
alias Required	str The Disaster Recovery configuration name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

check_name_availability

Check the give namespace name availability.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
parameters Required	CheckNameAvailability or CheckNameAvailability or IO[bytes] Parameters to check availability of the given namespace name. Is either a CheckNameAvailability type or a IO[bytes] type. Required.

Returns

Type	Description
CheckNameAvailabilityResult	CheckNameAvailabilityResult. The CheckNameAvailabilityResult is compatible with MutableMapping

Exceptions

Type	Description
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: _models.ArmDisasterRecovery, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ArmDisasterRecovery

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
alias Required	str The Disaster Recovery configuration name. Required.
parameters Required	ArmDisasterRecovery or ArmDisasterRecovery or IO[bytes] Parameters required to create an Alias(Disaster Recovery configuration). Is either a ArmDisasterRecovery type or a IO[bytes] type. Required.

Returns

Type	Description
ArmDisasterRecovery	ArmDisasterRecovery. The ArmDisasterRecovery is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Deletes an Alias(Disaster Recovery configuration).

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
alias Required	str The Disaster Recovery configuration name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
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, parameters: _models.NamespaceFailoverProperties | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
alias Required	str The Disaster Recovery configuration name. Required.
parameters	NamespaceFailoverProperties or NamespaceFailoverProperties or IO[bytes] Parameters required to create an Alias(Disaster Recovery configuration). Is either a NamespaceFailoverProperties type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

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

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
alias Required	str The Disaster Recovery configuration name. Required.

Returns

Type	Description
ArmDisasterRecovery	ArmDisasterRecovery. The ArmDisasterRecovery is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_authorization_rule

Gets an authorization rule for a namespace by rule name.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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
SBAuthorizationRule	SBAuthorizationRule. The SBAuthorizationRule is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Gets all Alias(Disaster Recovery configurations).

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.

Returns

Type	Description
ItemPaged[ArmDisasterRecovery]	An iterator like instance of ArmDisasterRecovery

Exceptions

Type	Description
HttpResponseError

list_authorization_rules

Gets the authorization rules for a namespace.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
alias Required	str The Disaster Recovery configuration name. Required.

Returns

Type	Description
ItemPaged[SBAuthorizationRule]	An iterator like instance of SBAuthorizationRule

Exceptions

Type	Description
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) -> AccessKeys

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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	AccessKeys. The AccessKeys is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?