Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DisasterRecoveryConfigs

Package version

Class representing a DisasterRecoveryConfigs.

Hierarchy

  • DisasterRecoveryConfigs

Index

Constructors

Methods

Constructors

constructor

Methods

breakPairing

  • breakPairing(resourceGroupName: string, namespaceName: string, alias: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • breakPairing(resourceGroupName: string, namespaceName: string, alias: string, callback: msRest.ServiceCallback<void>): void
  • breakPairing(resourceGroupName: string, namespaceName: string, alias: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

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

    Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

checkNameAvailability

  • Check the give Namespace name availability.

    Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • parameters: CheckNameAvailabilityParameter

      Parameters to check availability of the given Alias name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsCheckNameAvailabilityResponse>

    Promise<Models.DisasterRecoveryConfigsCheckNameAvailabilityResponse>

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • parameters: CheckNameAvailabilityParameter

      Parameters to check availability of the given Alias name

    • callback: msRest.ServiceCallback<CheckNameAvailabilityResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • parameters: CheckNameAvailabilityParameter

      Parameters to check availability of the given Alias name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<CheckNameAvailabilityResult>

      The callback

    Returns void

createOrUpdate

  • createOrUpdate(resourceGroupName: string, namespaceName: string, alias: string, parameters: ArmDisasterRecovery, options?: msRest.RequestOptionsBase): Promise<Models.DisasterRecoveryConfigsCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, namespaceName: string, alias: string, parameters: ArmDisasterRecovery, callback: msRest.ServiceCallback<ArmDisasterRecovery>): void
  • createOrUpdate(resourceGroupName: string, namespaceName: string, alias: string, parameters: ArmDisasterRecovery, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ArmDisasterRecovery>): void

  • Creates or updates a new Alias(Disaster Recovery configuration)

    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)

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsCreateOrUpdateResponse>

    Promise<Models.DisasterRecoveryConfigsCreateOrUpdateResponse>

  • 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)

    • callback: msRest.ServiceCallback<ArmDisasterRecovery>

      The callback

    Returns 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

    • parameters: ArmDisasterRecovery

      Parameters required to create an Alias(Disaster Recovery configuration)

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ArmDisasterRecovery>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, namespaceName: string, alias: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, namespaceName: string, alias: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, namespaceName: string, alias: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes an Alias(Disaster Recovery configuration)

    Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

failOver

  • failOver(resourceGroupName: string, namespaceName: string, alias: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • failOver(resourceGroupName: string, namespaceName: string, alias: string, callback: msRest.ServiceCallback<void>): void
  • failOver(resourceGroupName: string, namespaceName: string, alias: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

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

    Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, namespaceName: string, alias: string, options?: msRest.RequestOptionsBase): Promise<Models.DisasterRecoveryConfigsGetResponse>
  • get(resourceGroupName: string, namespaceName: string, alias: string, callback: msRest.ServiceCallback<ArmDisasterRecovery>): void
  • get(resourceGroupName: string, namespaceName: string, alias: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ArmDisasterRecovery>): void

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

    Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsGetResponse>

    Promise<Models.DisasterRecoveryConfigsGetResponse>

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • callback: msRest.ServiceCallback<ArmDisasterRecovery>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ArmDisasterRecovery>

      The callback

    Returns void

getAuthorizationRule

  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<Models.DisasterRecoveryConfigsGetAuthorizationRuleResponse>
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, callback: msRest.ServiceCallback<AuthorizationRule>): void
  • getAuthorizationRule(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRule>): void

  • Gets an AuthorizationRule for a Namespace by rule name.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsGetAuthorizationRuleResponse>

    Promise<Models.DisasterRecoveryConfigsGetAuthorizationRuleResponse>

  • 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.

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns 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

    • authorizationRuleName: string

      The authorization rule name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRule>

      The callback

    Returns void

list

  • list(resourceGroupName: string, namespaceName: string, options?: msRest.RequestOptionsBase): Promise<Models.DisasterRecoveryConfigsListResponse>
  • list(resourceGroupName: string, namespaceName: string, callback: msRest.ServiceCallback<ArmDisasterRecoveryListResult>): void
  • list(resourceGroupName: string, namespaceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ArmDisasterRecoveryListResult>): void

  • Gets all Alias(Disaster Recovery configurations)

    Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsListResponse>

    Promise<Models.DisasterRecoveryConfigsListResponse>

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • callback: msRest.ServiceCallback<ArmDisasterRecoveryListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ArmDisasterRecoveryListResult>

      The callback

    Returns void

listAuthorizationRules

  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, alias: string, options?: msRest.RequestOptionsBase): Promise<Models.DisasterRecoveryConfigsListAuthorizationRulesResponse>
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, alias: string, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void
  • listAuthorizationRules(resourceGroupName: string, namespaceName: string, alias: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void

  • Gets a list of authorization rules for a Namespace.

    Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsListAuthorizationRulesResponse>

    Promise<Models.DisasterRecoveryConfigsListAuthorizationRulesResponse>

  • Parameters

    • resourceGroupName: string

      Name of the resource group within the azure subscription.

    • namespaceName: string

      The Namespace name

    • alias: string

      The Disaster Recovery configuration name

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

listAuthorizationRulesNext

  • listAuthorizationRulesNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.DisasterRecoveryConfigsListAuthorizationRulesNextResponse>
  • listAuthorizationRulesNext(nextPageLink: string, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void
  • listAuthorizationRulesNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AuthorizationRuleListResult>): void

  • Gets a list of authorization rules for a Namespace.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsListAuthorizationRulesNextResponse>

    Promise<Models.DisasterRecoveryConfigsListAuthorizationRulesNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AuthorizationRuleListResult>

      The callback

    Returns void

listKeys

  • listKeys(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, options?: msRest.RequestOptionsBase): Promise<Models.DisasterRecoveryConfigsListKeysResponse>
  • listKeys(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, callback: msRest.ServiceCallback<AccessKeys>): void
  • listKeys(resourceGroupName: string, namespaceName: string, alias: string, authorizationRuleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AccessKeys>): void

  • Gets the primary and secondary connection strings for the Namespace.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsListKeysResponse>

    Promise<Models.DisasterRecoveryConfigsListKeysResponse>

  • 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.

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns 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

    • authorizationRuleName: string

      The authorization rule name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AccessKeys>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.DisasterRecoveryConfigsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<ArmDisasterRecoveryListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ArmDisasterRecoveryListResult>): void

  • Gets all Alias(Disaster Recovery configurations)

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.DisasterRecoveryConfigsListNextResponse>

    Promise<Models.DisasterRecoveryConfigsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ArmDisasterRecoveryListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ArmDisasterRecoveryListResult>

      The callback

    Returns void

Generated using TypeDoc