Failover Groups - Update

服務:

SQL Database

API 版本:

2025-01-01

更新故障轉移群組。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}?api-version=2025-01-01

URI 參數

名稱	位於	必要	類型	Description
failoverGroupName	path	True	string	故障轉移群組的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	類型	Description
properties.databases	string[] (arm-id)	故障轉移群組中的資料庫清單。
properties.partnerServers	PartnerInfo[]	故障轉移群組的合作夥伴伺服器資訊清單。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
properties.secondaryType	FailoverGroupDatabasesSecondaryType	夥伴伺服器上的資料庫次要類型。
tags	object	資源標籤。

回應

名稱	類型	Description
200 OK	FailoverGroup	Azure 運作順利完成。
202 Accepted		已接受資源更新要求。 標題 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

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

範圍

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

範例

Add database to failover group with standby secondary on partner server.

Update failover group

Add database to failover group with standby secondary on partner server.

範例要求

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-1?api-version=2025-01-01

{
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ],
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "secondaryType": "Standby"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
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/FailoverGroupUpdateStandbySecondary.json
// this example is just showing the usage of "FailoverGroups_Update" 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 FailoverGroupResource created on azure
// for more information of creating FailoverGroupResource, please refer to the document of FailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "failover-group-primary-server";
string failoverGroupName = "failover-group-test-1";
ResourceIdentifier failoverGroupResourceId = FailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, failoverGroupName);
FailoverGroupResource failoverGroup = client.GetFailoverGroupResource(failoverGroupResourceId);

// invoke the operation
FailoverGroupPatch patch = new FailoverGroupPatch
{
    ReadWriteEndpoint = new FailoverGroupReadWriteEndpoint(ReadWriteEndpointFailoverPolicy.Automatic)
    {
        FailoverWithDataLossGracePeriodMinutes = 120,
    },
    FailoverDatabases = { new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1") },
    SecondaryType = FailoverGroupDatabasesSecondaryType.Standby,
};
ArmOperation<FailoverGroupResource> lro = await failoverGroup.UpdateAsync(WaitUntil.Completed, patch);
FailoverGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
FailoverGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

範例回覆

狀態碼:

200

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

狀態碼:

202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

Update failover group

範例要求

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-1?api-version=2025-01-01

{
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ],
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    }
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
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/FailoverGroupUpdate.json
// this example is just showing the usage of "FailoverGroups_Update" 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 FailoverGroupResource created on azure
// for more information of creating FailoverGroupResource, please refer to the document of FailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "failover-group-primary-server";
string failoverGroupName = "failover-group-test-1";
ResourceIdentifier failoverGroupResourceId = FailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, failoverGroupName);
FailoverGroupResource failoverGroup = client.GetFailoverGroupResource(failoverGroupResourceId);

// invoke the operation
FailoverGroupPatch patch = new FailoverGroupPatch
{
    ReadWriteEndpoint = new FailoverGroupReadWriteEndpoint(ReadWriteEndpointFailoverPolicy.Automatic)
    {
        FailoverWithDataLossGracePeriodMinutes = 120,
    },
    FailoverDatabases = { new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1") },
};
ArmOperation<FailoverGroupResource> lro = await failoverGroup.UpdateAsync(WaitUntil.Completed, patch);
FailoverGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
FailoverGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

範例回覆

狀態碼:

200

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

狀態碼:

202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
FailoverGroup	故障轉移群組。
FailoverGroupDatabasesSecondaryType	夥伴伺服器上的資料庫次要類型。
FailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
FailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
FailoverGroupReplicationRole	故障轉移群組實例的本機複寫角色。
FailoverGroupUpdate	故障轉移群組更新要求。
PartnerInfo	故障轉移群組的合作夥伴伺服器資訊。
ReadOnlyEndpointFailoverPolicy	故障轉移群組只讀端點的故障轉移原則。
ReadWriteEndpointFailoverPolicy	故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。
systemData	與建立和上次修改資源相關的元數據。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

FailoverGroup

Object

故障轉移群組。

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	資源位置。
name	string	資源的名稱
properties.databases	string[] (arm-id)	故障轉移群組中的資料庫清單。
properties.partnerServers	PartnerInfo[]	故障轉移群組的合作夥伴伺服器資訊清單。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
properties.replicationRole	FailoverGroupReplicationRole	故障轉移群組實例的本機複寫角色。
properties.replicationState	string	故障轉移群組實例的復寫狀態。
properties.secondaryType	FailoverGroupDatabasesSecondaryType	夥伴伺服器上的資料庫次要類型。
systemData	systemData	Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。
tags	object	資源標籤。
type	string	資源的類型。 例如：「Microsoft。運算/虛擬機器」或「Microsoft」。儲存/儲存帳號」

FailoverGroupDatabasesSecondaryType

列舉型別

夥伴伺服器上的資料庫次要類型。

值	Description
Geo	地理位置
Standby	待命中

FailoverGroupReadOnlyEndpoint

Object

故障轉移群組實例的唯讀端點。

名稱	類型	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	故障轉移群組只讀端點的故障轉移原則。
targetServer	string (arm-id)	唯讀端點指向的目標夥伴伺服器。

FailoverGroupReadWriteEndpoint

Object

故障轉移群組實例的讀寫端點。

名稱	類型	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。
failoverWithDataLossGracePeriodMinutes	integer (int32)	嘗試讀取寫入端點的數據遺失故障轉移之前的寬限期。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。

FailoverGroupReplicationRole

列舉型別

故障轉移群組實例的本機複寫角色。

值	Description
Primary	主要
Secondary	Secondary

FailoverGroupUpdate

Object

故障轉移群組更新要求。

名稱	類型	Description
properties.databases	string[] (arm-id)	故障轉移群組中的資料庫清單。
properties.partnerServers	PartnerInfo[]	故障轉移群組的合作夥伴伺服器資訊清單。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
properties.secondaryType	FailoverGroupDatabasesSecondaryType	夥伴伺服器上的資料庫次要類型。
tags	object	資源標籤。

PartnerInfo

Object

故障轉移群組的合作夥伴伺服器資訊。

名稱	類型	Description
id	string (arm-id)	夥伴伺服器的資源識別碼。
location	string	合作夥伴伺服器的地理位置。
replicationRole	FailoverGroupReplicationRole	夥伴伺服器的復寫角色。

ReadOnlyEndpointFailoverPolicy

列舉型別

故障轉移群組只讀端點的故障轉移原則。

值	Description
Disabled	Disabled
Enabled	已啟用

ReadWriteEndpointFailoverPolicy

列舉型別

故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。

值	Description
Manual	說明書
Automatic	自動

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	資源上次修改的時間戳記 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。