Disaster Recovery Configs - Get

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}?api-version=2017-04-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

Name of the Resource group within the Azure subscription.

namespaceName
path True
  • string

The namespace name

alias
path True
  • string

The Disaster Recovery configuration name

api-version
query True
  • string

Client API version.

Responses

Name Type Description
200 OK

Successfully retrieved the Alias(Disaster Recovery configurations)

Other Status Codes

ServiceBus error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

SBAliasGet

Sample Request

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfigs/sdk-DisasterRecovery-3814?api-version=2017-04-01

Sample Response

{
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-37/disasterRecoveryConfig/sdk-DisasterRecovery-3814",
  "name": "sdk-DisasterRecovery-3814",
  "type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig",
  "properties": {
    "provisioningState": "Accepted",
    "partnerNamespace": "sdk-Namespace-8860",
    "role": "Secondary",
    "pendingReplicationOperationsCount": 0
  }
}

Definitions

ArmDisasterRecovery

Single item in List or Get Alias(Disaster Recovery configuration) operation

ErrorResponse

Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.

ProvisioningStateDR

Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'

RoleDisasterRecovery

role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'

ArmDisasterRecovery

Single item in List or Get Alias(Disaster Recovery configuration) operation

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

properties.alternateName
  • string

Primary/Secondary eventhub namespace name, which is part of GEO DR pairing

properties.partnerNamespace
  • string

ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing

properties.pendingReplicationOperationsCount
  • integer

Number of entities pending to be replicated.

properties.provisioningState

Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'

properties.role

role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'

type
  • string

Resource type

ErrorResponse

Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.

ProvisioningStateDR

Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'

Name Type Description
Accepted
  • string
Failed
  • string
Succeeded
  • string

RoleDisasterRecovery

role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'

Name Type Description
Primary
  • string
PrimaryNotReplicating
  • string
Secondary
  • string