DisasterRecoveryConfigsOperations interface

Package:

@azure/arm-eventhub

Interface representing a DisasterRecoveryConfigs operations.

Properties

breakPairing	This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces
checkNameAvailability	Check the give Namespace name availability.
createOrUpdate	Creates or updates a new Alias(Disaster Recovery configuration)
delete	Deletes an Alias(Disaster Recovery configuration)
failOver	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
getAuthorizationRule	Gets an AuthorizationRule for a Namespace by rule name.
list	Gets all Alias(Disaster Recovery configurations)
listAuthorizationRules	Gets a list of authorization rules for a Namespace.
listKeys	Gets the primary and secondary connection strings for the Namespace.

Property Details

breakPairing

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

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

Property Value

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

checkNameAvailability

Check the give Namespace name availability.

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

Property Value

(resourceGroupName: string, namespaceName: string, parameters: CheckNameAvailabilityParameter, options?: DisasterRecoveryConfigsCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResult>

createOrUpdate

Creates or updates a new Alias(Disaster Recovery configuration)

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

Property Value

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

delete

Deletes an Alias(Disaster Recovery configuration)

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

Property Value

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

failOver

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

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

Property Value

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

get

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

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

Property Value

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

getAuthorizationRule

Gets an AuthorizationRule for a Namespace by rule name.

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

Property Value

(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, options?: DisasterRecoveryConfigsGetAuthorizationRuleOptionalParams) => Promise<AuthorizationRule>

list

Gets all Alias(Disaster Recovery configurations)

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

Property Value

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

listAuthorizationRules

Gets a list of authorization rules for a Namespace.

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

Property Value

(resourceGroupName: string, namespaceName: string, alias: string, options?: DisasterRecoveryConfigsListAuthorizationRulesOptionalParams) => PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[], PageSettings>

listKeys

Gets the primary and secondary connection strings for the Namespace.

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

Property Value

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