次の方法で共有

Disaster Recovery Configs - Fail Over

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

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

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

URI Parameters

Name In Required Type Description
alias
 path True

string

The Disaster Recovery configuration name
namespaceName
 path True

string

The namespace name
resourceGroupName
 path True

string

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

The API version to use for this operation.

Request Body

Name Type Description
parameters

FailoverProperties

Parameters required to create an Alias(Disaster Recovery configuration)

Responses

Name Type Description
200 OK

Failover operation is successful.
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

SBAliasFailOver

Sample request

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

Sample response

Status code:
200

Definitions

Name Description
Error

The error object.
ErrorAdditionalInfo

The resource management error additional info.
ErrorResponse

The resource management error response.
FailoverProperties

Parameters required to create an Alias(Disaster Recovery configuration)

Error

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

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

Error

The error object.

FailoverProperties

Parameters required to create an Alias(Disaster Recovery configuration)

Name Type Description
properties.IsSafeFailover

boolean

Safe failover is to indicate the service should wait for pending replication to finish before switching to the secondary.