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

Instance Failover Groups - Create Or Update

服务:: SQL Database

API 版本:: 2025-01-01

创建或更新故障转移组。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}?api-version=2025-01-01

URI 参数

名称	在	必需	类型	说明
failoverGroupName	path	True	string	故障转移组的名称。
locationName	path	True	string	资源所在的区域的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
properties.managedInstancePairs	True	ManagedInstancePairInfo[]	故障转移组中托管实例对的列表。
properties.partnerRegions	True	PartnerRegionInfo[]	故障转移组的合作伙伴区域信息。
properties.readWriteEndpoint	True	InstanceFailoverGroupReadWriteEndpoint	故障转移组实例的读写终结点。
properties.readOnlyEndpoint		InstanceFailoverGroupReadOnlyEndpoint	故障转移组实例的只读终结点。
properties.secondaryType		SecondaryInstanceType	异地辅助实例的类型。仅当实例用作 DR 选项时，请设置“备用”。

响应

名称	类型	说明
200 OK	InstanceFailoverGroup	资源“InstanceFailoverGroup”更新操作成功
201 Created	InstanceFailoverGroup	资源“InstanceFailoverGroup”创建操作成功标头 Location: string Retry-After: integer
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	模拟用户帐户

示例

Create failover group

示例请求

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups/failover-group-test-3?api-version=2025-01-01

{
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "secondaryType": "Geo"
  }
}

示例响应

状态代码:: 200

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

状态代码:: 201

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

状态代码:: 202

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
InstanceFailoverGroup	实例故障转移组。
InstanceFailoverGroupReadOnlyEndpoint	故障转移组实例的只读终结点。
InstanceFailoverGroupReadWriteEndpoint	故障转移组实例的读写终结点。
InstanceFailoverGroupReplicationRole	故障转移组实例的本地复制角色。
ManagedInstancePairInfo	故障转移组中的托管实例对。
PartnerRegionInfo	故障转移组的合作伙伴区域信息。
ReadOnlyEndpointFailoverPolicy	故障转移组只读终结点的故障转移策略。
ReadWriteEndpointFailoverPolicy	故障转移组的读写终结点的故障转移策略。如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。
SecondaryInstanceType	异地辅助实例的类型。仅当实例用作 DR 选项时，请设置“备用”。
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	错误对象。

InstanceFailoverGroup

对象

实例故障转移组。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.managedInstancePairs	ManagedInstancePairInfo[]	故障转移组中托管实例对的列表。
properties.partnerRegions	PartnerRegionInfo[]	故障转移组的合作伙伴区域信息。
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	故障转移组实例的只读终结点。
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	故障转移组实例的读写终结点。
properties.replicationRole	InstanceFailoverGroupReplicationRole	故障转移组实例的本地复制角色。
properties.replicationState	string	故障转移组实例的复制状态。
properties.secondaryType	SecondaryInstanceType	异地辅助实例的类型。仅当实例用作 DR 选项时，请设置“备用”。
systemData	systemData	Azure 资源管理器包含 createdBy 和 modifiedBy 信息的元数据。
type	string	资源类型。例如，“Microsoft。计算/虚拟机“或”Microsoft“。存储/存储账户”

InstanceFailoverGroupReadOnlyEndpoint

对象

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

名称	类型	说明
failoverPolicy	ReadOnlyEndpointFailoverPolicy	故障转移组只读终结点的故障转移策略。

InstanceFailoverGroupReadWriteEndpoint

对象

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

名称	类型	说明
failoverPolicy	ReadWriteEndpointFailoverPolicy	故障转移组的读写终结点的故障转移策略。如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。
failoverWithDataLossGracePeriodMinutes	integer (int32)	尝试对读写终结点执行故障转移前的宽限期，并丢失数据。如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。

InstanceFailoverGroupReplicationRole

枚举

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

值	说明
Primary	主要
Secondary	次级

ManagedInstancePairInfo

对象

故障转移组中的托管实例对。

名称	类型	说明
partnerManagedInstanceId	string	Partner 托管实例 in pair 的 ID
primaryManagedInstanceId	string	Primary 托管实例的 id in pair。

PartnerRegionInfo

对象

故障转移组的合作伙伴区域信息。

名称	类型	说明
location	string	合作伙伴托管实例的地理位置。
replicationRole	InstanceFailoverGroupReplicationRole	合作伙伴托管实例的复制角色。

ReadOnlyEndpointFailoverPolicy

枚举

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

值	说明
Disabled	已禁用
Enabled	已启用

ReadWriteEndpointFailoverPolicy

枚举

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

值	说明
Manual	手动
Automatic	自动

SecondaryInstanceType

枚举

异地辅助实例的类型。仅当实例用作 DR 选项时，请设置“备用”。

值	说明
Geo	地理位置
Standby	备用

systemData

对象

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过