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

Distributed Availability Groups - Create Or Update

在 SQL On-Prem 和 SQL 托管实例 之间创建分布式可用性组。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}?api-version=2025-01-01

URI 参数

名称 在 必需 类型 说明
distributedAvailabilityGroupName
path True

string

分布式可用性组名称。

managedInstanceName
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.databases

DistributedAvailabilityGroupDatabase[]

分布式可用性组中的数据库

properties.failoverMode

FailoverModeType

链路故障切换模式——如果设计用于支持的SQL Server的双向故障切换,可以选择手动模式;也可以选择无模式,用于单向切换到Azure。

properties.instanceAvailabilityGroupName

string

托管实例端可用性组名称

properties.instanceLinkRole

LinkRole

托管实例端链接角色

properties.partnerAvailabilityGroupName

string

SQL 服务器端可用性组名称

properties.partnerEndpoint

string

SQL 服务器端终结点 - IP 或 DNS 可解析名称

properties.replicationMode

ReplicationModeType

链接的复制模式

properties.seedingMode

SeedingModeType

数据库种子设定模式 – 可以是“自动”(默认值),也可以是“手动”(对于受支持的方案)。

响应

名称 类型 说明
200 OK

DistributedAvailabilityGroup

资源“DistributedAvailabilityGroup”更新操作成功

201 Created

DistributedAvailabilityGroup

资源“DistributedAvailabilityGroup”创建操作成功

标头

  • 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 a distributed availability group with all properties.
Create a distributed availability group with minimal properties.

Create a distributed availability group with all properties.

示例请求

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag?api-version=2025-01-01

{
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

示例响应

{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}
{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Primary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

Create a distributed availability group with minimal properties.

示例请求

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag?api-version=2025-01-01

{
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "instanceAvailabilityGroupName": "testcl",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022"
  }
}

示例响应

{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Secondary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}
{
  "name": "dag",
  "type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
  "properties": {
    "databases": [
      {
        "databaseName": "testdb"
      }
    ],
    "distributedAvailabilityGroupName": "dag",
    "failoverMode": "None",
    "instanceAvailabilityGroupName": "testcl",
    "instanceLinkRole": "Secondary",
    "partnerAvailabilityGroupName": "BoxLocalAg1",
    "partnerEndpoint": "TCP://SERVER:7022",
    "seedingMode": "Automatic"
  }
}

定义

名称 说明
CertificateInfo

证书信息

createdByType

创建资源的标识的类型。

DistributedAvailabilityGroup

Box 和 SQL 托管实例 之间的分布式可用性组。

DistributedAvailabilityGroupDatabase

数据库特定信息

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

FailoverModeType

链路故障切换模式——如果设计用于支持的SQL Server的双向故障切换,可以选择手动模式;也可以选择无模式,用于单向切换到Azure。

LinkRole

SQL 服务器端链接角色

ReplicaConnectedState

链接连接状态

ReplicaSynchronizationHealth

链接运行状况状态

ReplicationModeType

链接的复制模式

SeedingModeType

数据库种子设定模式 – 可以是“自动”(默认值),也可以是“手动”(对于受支持的方案)。

systemData

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

CertificateInfo

证书信息

名称 类型 说明
certificateName

string

证书名称

expiryDate

string (date-time)

证书到期日期

createdByType

创建资源的标识的类型。

值 说明
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

Box 和 SQL 托管实例 之间的分布式可用性组。

名称 类型 说明
id

string (arm-id)

资源的完全限定资源 ID。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

name

string

资源的名称

properties.databases

DistributedAvailabilityGroupDatabase[]

分布式可用性组中的数据库

properties.distributedAvailabilityGroupId

string (uuid)

分布式可用性组的 ID

properties.distributedAvailabilityGroupName

string

分布式可用性组的名称

properties.failoverMode

FailoverModeType

链路故障切换模式——如果设计用于支持的SQL Server的双向故障切换,可以选择手动模式;也可以选择无模式,用于单向切换到Azure。

properties.instanceAvailabilityGroupName

string

托管实例端可用性组名称

properties.instanceLinkRole

LinkRole

托管实例端链接角色

properties.partnerAvailabilityGroupName

string

SQL 服务器端可用性组名称

properties.partnerEndpoint

string

SQL 服务器端终结点 - IP 或 DNS 可解析名称

properties.partnerLinkRole

LinkRole

SQL 服务器端链接角色

properties.replicationMode

ReplicationModeType

链接的复制模式

properties.seedingMode

SeedingModeType

数据库种子设定模式 – 可以是“自动”(默认值),也可以是“手动”(对于受支持的方案)。

systemData

systemData

Azure 资源管理器 包含 createdBy 和 modifiedBy 信息的元数据。

type

string

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

DistributedAvailabilityGroupDatabase

数据库特定信息

名称 类型 说明
connectedState

ReplicaConnectedState

链接连接状态

databaseName

string

链接中数据库的名称

instanceRedoReplicationLagSeconds

integer (int32)

当托管实例链路端是主时,重做延迟

instanceReplicaId

string (uuid)

托管实例副本 ID

instanceSendReplicationLagSeconds

integer (int32)

当托管实例链路端为主节点时,复制延迟

lastBackupLsn

string

上次备份 LSN

lastBackupTime

string (date-time)

上次备份 LSN 时间

lastCommitLsn

string

上次提交 LSN

lastCommitTime

string (date-time)

上次提交 LSN 时间

lastHardenedLsn

string

上次强化的 LSN

lastHardenedTime

string (date-time)

上次强化的 LSN 时间

lastReceivedLsn

string

上次收到的 LSN

lastReceivedTime

string (date-time)

上次收到的 LSN 时间

lastSentLsn

string

上次发送的 LSN

lastSentTime

string (date-time)

上次发送的 LSN 时间

mostRecentLinkError

string

最新链接连接错误说明

partnerAuthCertValidity

CertificateInfo

SQL Server 证书有效性

partnerReplicaId

string (uuid)

SQL Server 副本 ID

replicaState

string

当前链接状态

seedingProgress

string

种子设定进度

synchronizationHealth

ReplicaSynchronizationHealth

链接运行状况状态

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

附加信息。

type

string

附加信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

FailoverModeType

链路故障切换模式——如果设计用于支持的SQL Server的双向故障切换,可以选择手动模式;也可以选择无模式,用于单向切换到Azure。

值 说明
None

没有

Manual

手动

LinkRole

SQL 服务器端链接角色

值 说明
Primary

主要

Secondary

次级

ReplicaConnectedState

链接连接状态

值 说明
DISCONNECTED

断开

CONNECTED

CONNECTED

ReplicaSynchronizationHealth

链接运行状况状态

值 说明
NOT_HEALTHY

NOT_HEALTHY

PARTIALLY_HEALTHY

PARTIALLY_HEALTHY

HEALTHY

健康

ReplicationModeType

链接的复制模式

值 说明
Async

异步

Sync

同步

SeedingModeType

数据库种子设定模式 – 可以是“自动”(默认值),也可以是“手动”(对于受支持的方案)。

值 说明
Automatic

自动

Manual

手动

systemData

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

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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