DisasterRecoveryConfigs interface

Package:

@azure/arm-servicebus

Interface representing a DisasterRecoveryConfigs.

Methods

breakPairing(string, string, string, DisasterRecoveryConfigsBreakPairingOptionalParams)	This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces
checkNameAvailability(string, string, CheckNameAvailability, DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams)	Check the give namespace name availability.
createOrUpdate(string, string, string, ArmDisasterRecovery, DisasterRecoveryConfigsCreateOrUpdateOptionalParams)	Creates or updates a new Alias(Disaster Recovery configuration)
delete(string, string, string, DisasterRecoveryConfigsDeleteOptionalParams)	Deletes an Alias(Disaster Recovery configuration)
failOver(string, string, string, DisasterRecoveryConfigsFailOverOptionalParams)	Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace
get(string, string, string, DisasterRecoveryConfigsGetOptionalParams)	Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace
getAuthorizationRule(string, string, string, string, DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams)	Gets an authorization rule for a namespace by rule name.
list(string, string, DisasterRecoveryConfigsListOptionalParams)	Gets all Alias(Disaster Recovery configurations)
listAuthorizationRules(string, string, string, DisasterRecoveryConfigsListAuthorizationRulesOptionalParams)	Gets the authorization rules for a namespace.
listKeys(string, string, string, string, DisasterRecoveryConfigsListKeysOptionalParams)	Gets the primary and secondary connection strings for the namespace.

Method Details

breakPairing(string, string, string, DisasterRecoveryConfigsBreakPairingOptionalParams)

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

function breakPairing(resourceGroupName: string, namespaceName: string, alias: string, options?: DisasterRecoveryConfigsBreakPairingOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

alias

string

The Disaster Recovery configuration name

options

DisasterRecoveryConfigsBreakPairingOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(string, string, CheckNameAvailability, DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams)

Check the give namespace name availability.

function checkNameAvailability(resourceGroupName: string, namespaceName: string, parameters: CheckNameAvailability, options?: DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

parameters

CheckNameAvailability

Parameters to check availability of the given namespace name

options

DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResult>

createOrUpdate(string, string, string, ArmDisasterRecovery, DisasterRecoveryConfigsCreateOrUpdateOptionalParams)

Creates or updates a new Alias(Disaster Recovery configuration)

function createOrUpdate(resourceGroupName: string, namespaceName: string, alias: string, parameters: ArmDisasterRecovery, options?: DisasterRecoveryConfigsCreateOrUpdateOptionalParams): Promise<ArmDisasterRecovery>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

alias

string

The Disaster Recovery configuration name

parameters

ArmDisasterRecovery

Parameters required to create an Alias(Disaster Recovery configuration)

options

DisasterRecoveryConfigsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ArmDisasterRecovery>

delete(string, string, string, DisasterRecoveryConfigsDeleteOptionalParams)

Deletes an Alias(Disaster Recovery configuration)

function delete(resourceGroupName: string, namespaceName: string, alias: string, options?: DisasterRecoveryConfigsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

alias

string

The Disaster Recovery configuration name

options

DisasterRecoveryConfigsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

failOver(string, string, string, DisasterRecoveryConfigsFailOverOptionalParams)

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

function failOver(resourceGroupName: string, namespaceName: string, alias: string, options?: DisasterRecoveryConfigsFailOverOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

alias

string

The Disaster Recovery configuration name

options

DisasterRecoveryConfigsFailOverOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, DisasterRecoveryConfigsGetOptionalParams)

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

function get(resourceGroupName: string, namespaceName: string, alias: string, options?: DisasterRecoveryConfigsGetOptionalParams): Promise<ArmDisasterRecovery>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

alias

string

The Disaster Recovery configuration name

options

DisasterRecoveryConfigsGetOptionalParams

The options parameters.

Returns

Promise<ArmDisasterRecovery>

getAuthorizationRule(string, string, string, string, DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams)

Gets an authorization rule for a namespace by rule name.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, options?: DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

alias

string

The Disaster Recovery configuration name

authorizationRuleName

string

The authorization rule name.

options

DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams

The options parameters.

Returns

Promise<SBAuthorizationRule>

list(string, string, DisasterRecoveryConfigsListOptionalParams)

Gets all Alias(Disaster Recovery configurations)

function list(resourceGroupName: string, namespaceName: string, options?: DisasterRecoveryConfigsListOptionalParams): PagedAsyncIterableIterator<ArmDisasterRecovery, ArmDisasterRecovery[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

options

DisasterRecoveryConfigsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ArmDisasterRecovery, ArmDisasterRecovery[], PageSettings>

listAuthorizationRules(string, string, string, DisasterRecoveryConfigsListAuthorizationRulesOptionalParams)

Gets the authorization rules for a namespace.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, alias: string, options?: DisasterRecoveryConfigsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SBAuthorizationRule, SBAuthorizationRule[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

alias

string

The Disaster Recovery configuration name

options

DisasterRecoveryConfigsListAuthorizationRulesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SBAuthorizationRule, SBAuthorizationRule[], PageSettings>

listKeys(string, string, string, string, DisasterRecoveryConfigsListKeysOptionalParams)

Gets the primary and secondary connection strings for the namespace.

function listKeys(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, options?: DisasterRecoveryConfigsListKeysOptionalParams): Promise<AccessKeys>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

namespaceName

string

The namespace name

alias

string

The Disaster Recovery configuration name

authorizationRuleName

string

The authorization rule name.

options

DisasterRecoveryConfigsListKeysOptionalParams

The options parameters.

Returns

Promise<AccessKeys>