DisasterRecoveryConfigsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ServiceBusManagementClient'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 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

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.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
None

None or the result of cls(response)

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

Name of the Resource group within the Azure subscription. Required.
namespace_name
Required
str

The namespace name. Required.
parameters
Required
CheckNameAvailability or IO

Parameters to check availability of the given namespace name. Is either a CheckNameAvailability type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

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

Returns

Type Description
CheckNameAvailabilityResult

CheckNameAvailabilityResult or the result of cls(response)

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 | 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
ArmDisasterRecovery or IO

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

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

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

Returns

Type Description
ArmDisasterRecovery,
None

ArmDisasterRecovery or None or the result of cls(response)

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

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.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
None

None or the result of cls(response)

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.FailoverProperties | None = None, *, content_type: str = 'application/json', **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.
parameters
Required
FailoverProperties or IO

Parameters required to create an Alias(Disaster Recovery configuration). Is either a FailoverProperties type or a IO type. Default value is None.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

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

Returns

Type Description
None

None or the result of cls(response)

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

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.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ArmDisasterRecovery

ArmDisasterRecovery or the result of cls(response)

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

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.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
SBAuthorizationRule

SBAuthorizationRule or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

list

Gets all Alias(Disaster Recovery configurations).

list(resource_group_name: str, namespace_name: str, **kwargs: Any) -> Iterable[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.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ArmDisasterRecovery]

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

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) -> Iterable[SBAuthorizationRule]

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.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[SBAuthorizationRule]

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

Exceptions

Type Description
HttpResponseError
See also

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

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.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
AccessKeys

AccessKeys or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

Attributes

models 

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