Disaster Recovery Configs - List
Gets all Alias(Disaster Recovery configurations)
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs?api-version=2021-11-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
namespace
|
path | True |
string |
The namespace name |
resource
|
path | True |
string |
Name of the Resource group within the Azure subscription. |
subscription
|
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 |
Client API version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully retrieved the list of Alias(Disaster Recovery configurations) for servicebus namespace |
|
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
SBAliasList
Sample request
GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfigs?api-version=2021-11-01
Sample response
{
"value": [
{
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ardsouzatestRG/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-8860/disasterRecoveryConfig/sdk-DisasterRecovery-3814",
"name": "sdk-DisasterRecovery-3814",
"type": "Microsoft.ServiceBus/Namespaces/DisasterRecoveryConfig",
"properties": {
"provisioningState": "Accepted",
"partnerNamespace": "sdk-Namespace-37",
"role": "Primary"
}
}
]
}
Definitions
Name | Description |
---|---|
Arm |
List of Alias(Disaster Recovery configurations) |
Arm |
The result of the List Alias(Disaster Recovery configuration) operation. |
created |
The type of identity that created the resource. |
Error |
The error object. |
Error |
The resource management error additional info. |
Error |
The resource management error response. |
Provisioning |
Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed' |
Role |
role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary' |
system |
The system meta data relating to this resource. |
ArmDisasterRecovery
List of Alias(Disaster Recovery configurations)
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 |
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' |
|
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" |
ArmDisasterRecoveryListResult
The result of the List Alias(Disaster Recovery configuration) operation.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration) |
value |
List of Alias(Disaster Recovery configurations) |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Error
The error object.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorResponse
The resource management error response.
Name | Type | Description |
---|---|---|
error |
The error object. |
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 |
systemData
The system meta data relating to this resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The type of identity that last modified the resource. |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |