Databases - Failover

服务:

SQL Database

API 版本:

2025-01-01

故障转移数据库。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover?api-version=2025-01-01

具有可选参数:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover?api-version=2025-01-01&replicaType={replicaType}

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。
replicaType	query		ReplicaType	要故障转移的副本的类型。

响应

名称	类型	说明
200 OK		请求已成功。
202 Accepted		已接受资源作。 标头 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Failover an database

示例请求

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/testServer/databases/testDatabase/failover?api-version=2025-01-01&replicaType=Primary

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/FailoverDatabase.json
// this example is just showing the usage of "Databases_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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "testServer";
string databaseName = "testDatabase";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation
ReplicaType? replicaType = ReplicaType.Primary;
await sqlDatabase.FailoverAsync(WaitUntil.Completed, replicaType: replicaType);

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

状态代码:

202

Location: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Sql/locations/japaneast/databaseOperationResults/00000000-0000-0000-0000-000000000000

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ReplicaType

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ReplicaType

枚举

值	说明
Primary	主要
ReadableSecondary	可读次级