Disaster Recovery Configs - Fail Over

服務:

Service Bus

API 版本:

2024-01-01

叫用 GEO DR 故障轉移並重新設定別名以指向次要命名空間

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

URI 參數

名稱	位於	必要	類型	Description
alias	path	True	string minLength: 1 maxLength: 50	災害復原組態名稱
namespaceName	path	True	string minLength: 6 maxLength: 50	命名空間名稱
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
parameters	FailoverProperties	建立別名所需的參數（災害復原設定）

回應

名稱	類型	Description
200 OK		故障轉移作業成功。
Other Status Codes	ErrorResponse	描述作業失敗原因的 ServiceBus 錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

SBAliasFailOver

範例要求

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/disasterRecoveryConfigs/SBAliasFailOver.json
// this example is just showing the usage of "DisasterRecoveryConfigs_FailOver" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceBusDisasterRecoveryResource created on azure
// for more information of creating ServiceBusDisasterRecoveryResource, please refer to the document of ServiceBusDisasterRecoveryResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ardsouzatestRG";
string namespaceName = "sdk-Namespace-8860";
string @alias = "sdk-DisasterRecovery-3814";
ResourceIdentifier serviceBusDisasterRecoveryResourceId = ServiceBusDisasterRecoveryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, @alias);
ServiceBusDisasterRecoveryResource serviceBusDisasterRecovery = client.GetServiceBusDisasterRecoveryResource(serviceBusDisasterRecoveryResourceId);

// invoke the operation
await serviceBusDisasterRecovery.FailOverAsync();

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

200

定義

名稱	Description
Error	error 物件。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	資源管理錯誤回應。
FailoverProperties	建立別名所需的參數（災害復原設定）

Error

Object

error 物件。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

Object

資源管理錯誤回應。

名稱	類型	Description
error	Error	error 物件。

FailoverProperties

Object

建立別名所需的參數（災害復原設定）

名稱	類型	Description
properties.IsSafeFailover	boolean	安全故障轉移是表示服務應該等候暫止複寫完成，再切換至次要複寫。