DisasterRecoveryConfigsOperations Class

DisasterRecoveryConfigsOperations async 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 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.

async break_pairing(resource_group_name: str, namespace_name: str, alias: str, **kwargs) -> 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.

async check_name_availability(resource_group_name: str, namespace_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.CheckNameAvailability, **kwargs) -> azure.mgmt.servicebus.v2017_04_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

<xref:azure.mgmt.servicebus.models.CheckNameAvailability>

Required

Parameters to check availability of the given namespace 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

<xref:azure.mgmt.servicebus.models.CheckNameAvailabilityResult>

Exceptions

HttpResponseError

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: azure.mgmt.servicebus.v2017_04_01.models._models_py3.ArmDisasterRecovery, **kwargs) -> Optional[azure.mgmt.servicebus.v2017_04_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

<xref:azure.mgmt.servicebus.models.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

<xref:azure.mgmt.servicebus.models.ArmDisasterRecovery>,

None

Exceptions

HttpResponseError

delete

Deletes an Alias(Disaster Recovery configuration).

async delete(resource_group_name: str, namespace_name: str, alias: str, **kwargs) -> 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.

async fail_over(resource_group_name: str, namespace_name: str, alias: str, parameters: Optional[_models.FailoverProperties] = None, **kwargs) -> 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.

parameters

<xref:azure.mgmt.servicebus.models.FailoverProperties>

default value: None

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

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.

async get(resource_group_name: str, namespace_name: str, alias: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_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

<xref:azure.mgmt.servicebus.models.ArmDisasterRecovery>

Exceptions

HttpResponseError

get_authorization_rule

Gets an authorization rule for a namespace by rule name.

async get_authorization_rule(resource_group_name: str, namespace_name: str, alias: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRule

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

SBAuthorizationRule, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.SBAuthorizationRule>

Exceptions

HttpResponseError

list

Gets all Alias(Disaster Recovery configurations).

list(resource_group_name: str, namespace_name: str, **kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_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

AsyncItemPaged[<xref:azure.mgmt.servicebus.models.ArmDisasterRecoveryListResult>]

Exceptions

HttpResponseError

list_authorization_rules

Gets the authorization rules for a namespace.

list_authorization_rules(resource_group_name: str, namespace_name: str, alias: str, **kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRuleListResult]

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 SBAuthorizationRuleListResult or the result of cls(response)

Return type

AsyncItemPaged[<xref:azure.mgmt.servicebus.models.SBAuthorizationRuleListResult>]

Exceptions

HttpResponseError

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) -> azure.mgmt.servicebus.v2017_04_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

<xref:azure.mgmt.servicebus.models.AccessKeys>

Exceptions

HttpResponseError

Attributes

models

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