你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称 在 必需 类型 说明
failoverGroupName
 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 版本。

请求正文

名称 类型 说明
properties.databases

string[] (arm-id)

故障转移组中的数据库列表。
properties.partnerServers

PartnerInfo[]

故障转移组的合作伙伴服务器信息列表。
properties.readOnlyEndpoint

FailoverGroupReadOnlyEndpoint

故障转移组实例的只读终结点。
properties.readWriteEndpoint

FailoverGroupReadWriteEndpoint

故障转移组实例的读写终结点。
properties.secondaryType

FailoverGroupDatabasesSecondaryType

合作伙伴服务器上的数据库辅助类型。
tags

object

资源标记。

响应

名称 类型 说明
200 OK

FailoverGroup

Azure 运营顺利完成。
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 模拟用户帐户

示例

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.

示例请求

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"
  }
}

示例响应

状态代码:
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

示例请求

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
    }
  }
}

示例响应

状态代码:
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

定义

名称 说明
createdByType

创建资源的标识的类型。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
FailoverGroup

故障转移组。
FailoverGroupDatabasesSecondaryType

合作伙伴服务器上的数据库辅助类型。
FailoverGroupReadOnlyEndpoint

故障转移组实例的只读终结点。
FailoverGroupReadWriteEndpoint

故障转移组实例的读写终结点。
FailoverGroupReplicationRole

故障转移组实例的本地复制角色。
FailoverGroupUpdate

故障转移组更新请求。
PartnerInfo

故障转移组的合作伙伴服务器信息。
ReadOnlyEndpointFailoverPolicy

故障转移组只读终结点的故障转移策略。
ReadWriteEndpointFailoverPolicy

故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。
systemData

与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值 说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称 类型 说明
info

object

附加信息。
type

string

附加信息类型。

ErrorDetail

对象

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

对象

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

FailoverGroup

对象

故障转移组。

名称 类型 说明
id

string (arm-id)

资源的完全限定资源 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 资源管理器 包含 createdBy 和 modifiedBy 信息的元数据。
tags

object

资源标记。
type

string

资源类型。 例如，“Microsoft。计算/虚拟机“或”Microsoft“。存储/存储账户”

FailoverGroupDatabasesSecondaryType

枚举

合作伙伴服务器上的数据库辅助类型。

值 说明
Geo

地理位置
Standby

备用

FailoverGroupReadOnlyEndpoint

对象

故障转移组实例的只读终结点。

名称 类型 说明
failoverPolicy

ReadOnlyEndpointFailoverPolicy

故障转移组只读终结点的故障转移策略。
targetServer

string (arm-id)

只读终结点指向的目标伙伴服务器。

FailoverGroupReadWriteEndpoint

对象

故障转移组实例的读写终结点。

名称 类型 说明
failoverPolicy

ReadWriteEndpointFailoverPolicy

故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。
failoverWithDataLossGracePeriodMinutes

integer (int32)

尝试对读写终结点执行故障转移前的宽限期，并丢失数据。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。

FailoverGroupReplicationRole

枚举

故障转移组实例的本地复制角色。

值 说明
Primary

主要
Secondary

次级

FailoverGroupUpdate

对象

故障转移组更新请求。

名称 类型 说明
properties.databases

string[] (arm-id)

故障转移组中的数据库列表。
properties.partnerServers

PartnerInfo[]

故障转移组的合作伙伴服务器信息列表。
properties.readOnlyEndpoint

FailoverGroupReadOnlyEndpoint

故障转移组实例的只读终结点。
properties.readWriteEndpoint

FailoverGroupReadWriteEndpoint

故障转移组实例的读写终结点。
properties.secondaryType

FailoverGroupDatabasesSecondaryType

合作伙伴服务器上的数据库辅助类型。
tags

object

资源标记。

PartnerInfo

对象

故障转移组的合作伙伴服务器信息。

名称 类型 说明
id

string (arm-id)

合作伙伴服务器的资源标识符。
location

string

合作伙伴服务器的地理位置。
replicationRole

FailoverGroupReplicationRole

合作伙伴服务器的复制角色。

ReadOnlyEndpointFailoverPolicy

枚举

故障转移组只读终结点的故障转移策略。

值 说明
Disabled

已禁用
Enabled

已启用

ReadWriteEndpointFailoverPolicy

枚举

故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。

值 说明
Manual

手动
Automatic

自动

systemData

对象

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string (date-time)

资源上次修改的时间戳 （UTC）
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

上次修改资源的标识的类型。