Share via

Disaster Recovery Configs - Get

Service:
Service Bus
API Version:
2024-01-01

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=2024-01-01

URI Parameters

Name In Required Type Description
alias
 path True

string

minLength: 1
maxLength: 50

The Disaster Recovery configuration name
namespaceName
 path True

string

minLength: 6
maxLength: 50

The namespace name
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
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.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

ArmDisasterRecovery

Successfully retrieved the Alias(Disaster Recovery configurations)
Other Status Codes

ErrorResponse

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=2024-01-01

Sample response

Status code:
200 
{
  "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

Name Description
ArmDisasterRecovery

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

The type of identity that created the resource.
Error

The error object.
ErrorAdditionalInfo

The resource management error additional info.
ErrorResponse

The resource management error response.
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'
systemData

The system meta data relating to this resource.

ArmDisasterRecovery

Object

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

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

The geo-location where the resource lives
name

string

The name of the resource
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 (int64)

Number of entities pending to be replicated.
properties.provisioningState

ProvisioningStateDR

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

RoleDisasterRecovery

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

systemData

The system meta data relating to this resource.
type

string

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

Error

Object

The error object.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorResponse[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorResponse

Object

The resource management error response.

Name Type Description
error

Error

The error object.

ProvisioningStateDR

Enumeration

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

Value Description
Accepted
Succeeded
Failed

RoleDisasterRecovery

Enumeration

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

Value Description
Primary
PrimaryNotReplicating
Secondary

systemData

Object

The system meta data relating to this resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The type of identity that last modified the resource.
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.