Distributed Availability Groups - Set Role
设置分布式可用性组中托管实例的角色。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}/setRole?api-version=2025-01-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
distributed
|
path | True |
string |
分布式可用性组名称。 |
|
managed
|
path | True |
string |
托管实例的名称。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 此名称不区分大小写。 |
|
subscription
|
path | True |
string (uuid) |
目标订阅的 ID。 该值必须是 UUID。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求正文
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| instanceRole | True |
分布式可用性组中托管实例的新角色可以是主实例或辅助实例。 |
|
| roleChangeType | True |
角色更改的类型可以是“计划”或“强制”。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
Azure 运营顺利完成。 |
|
| 202 Accepted |
已接受资源作。 标头
|
|
| Other Status Codes |
意外的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow.
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
Set distributed availability group primary replica to managed instance.
示例请求
POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag/setRole?api-version=2025-01-01
{
"instanceRole": "Primary",
"roleChangeType": "Forced"
}
示例响应
{
"name": "dag",
"type": "Microsoft.Sql/managedInstances/distributedAvailabilityGroups",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/distributedAvailabilityGroups/dag",
"properties": {
"distributedAvailabilityGroupName": "dag",
"instanceLinkRole": "Primary"
}
}
Location: https://management.azure.com/subscriptions/f2669dff-5f08-45dd-b857-b2a60b72cdc9/providers/Microsoft.Sql/locations/westus/distributedAvailabilityGroupsOperationResults/00000000-1111-2222-3333-444444444444?api-version=2021-05-01-preview
定义
| 名称 | 说明 |
|---|---|
|
Certificate |
证书信息 |
|
created |
创建资源的标识的类型。 |
|
Distributed |
Box 和 SQL 托管实例 之间的分布式可用性组。 |
|
Distributed |
数据库特定信息 |
|
Distributed |
分布式可用性组故障转移请求。 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Failover |
链路故障切换模式——如果设计用于支持的SQL Server的双向故障切换,可以选择手动模式;也可以选择无模式,用于单向切换到Azure。 |
|
Instance |
分布式可用性组中托管实例的新角色可以是主实例或辅助实例。 |
|
Link |
SQL 服务器端链接角色 |
|
Replica |
链接连接状态 |
|
Replica |
链接运行状况状态 |
|
Replication |
链接的复制模式 |
|
Role |
角色更改的类型可以是“计划”或“强制”。 |
|
Seeding |
数据库种子设定模式 – 可以是“自动”(默认值),也可以是“手动”(对于受支持的方案)。 |
|
system |
与创建和上次修改资源相关的元数据。 |
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 |
分布式可用性组中的数据库 |
|
| properties.distributedAvailabilityGroupId |
string (uuid) |
分布式可用性组的 ID |
| properties.distributedAvailabilityGroupName |
string |
分布式可用性组的名称 |
| properties.failoverMode |
链路故障切换模式——如果设计用于支持的SQL Server的双向故障切换,可以选择手动模式;也可以选择无模式,用于单向切换到Azure。 |
|
| properties.instanceAvailabilityGroupName |
string |
托管实例端可用性组名称 |
| properties.instanceLinkRole |
托管实例端链接角色 |
|
| properties.partnerAvailabilityGroupName |
string |
SQL 服务器端可用性组名称 |
| properties.partnerEndpoint |
string |
SQL 服务器端终结点 - IP 或 DNS 可解析名称 |
| properties.partnerLinkRole |
SQL 服务器端链接角色 |
|
| properties.replicationMode |
链接的复制模式 |
|
| properties.seedingMode |
数据库种子设定模式 – 可以是“自动”(默认值),也可以是“手动”(对于受支持的方案)。 |
|
| systemData |
Azure 资源管理器 包含 createdBy 和 modifiedBy 信息的元数据。 |
|
| type |
string |
资源类型。 例如,“Microsoft。计算/虚拟机“或”Microsoft“。存储/存储账户” |
DistributedAvailabilityGroupDatabase
数据库特定信息
| 名称 | 类型 | 说明 |
|---|---|---|
| connectedState |
链接连接状态 |
|
| 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 |
SQL Server 证书有效性 |
|
| partnerReplicaId |
string (uuid) |
SQL Server 副本 ID |
| replicaState |
string |
当前链接状态 |
| seedingProgress |
string |
种子设定进度 |
| synchronizationHealth |
链接运行状况状态 |
DistributedAvailabilityGroupSetRole
分布式可用性组故障转移请求。
| 名称 | 类型 | 说明 |
|---|---|---|
| instanceRole |
分布式可用性组中托管实例的新角色可以是主实例或辅助实例。 |
|
| roleChangeType |
角色更改的类型可以是“计划”或“强制”。 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
附加信息。 |
| type |
string |
附加信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
FailoverModeType
链路故障切换模式——如果设计用于支持的SQL Server的双向故障切换,可以选择手动模式;也可以选择无模式,用于单向切换到Azure。
| 值 | 说明 |
|---|---|
| None |
没有 |
| Manual |
手动 |
InstanceRole
分布式可用性组中托管实例的新角色可以是主实例或辅助实例。
| 值 | 说明 |
|---|---|
| Primary |
主要 |
| Secondary |
次级 |
LinkRole
SQL 服务器端链接角色
| 值 | 说明 |
|---|---|
| Primary |
主要 |
| Secondary |
次级 |
ReplicaConnectedState
链接连接状态
| 值 | 说明 |
|---|---|
| DISCONNECTED |
断开 |
| CONNECTED |
CONNECTED |
ReplicaSynchronizationHealth
链接运行状况状态
| 值 | 说明 |
|---|---|
| NOT_HEALTHY |
NOT_HEALTHY |
| PARTIALLY_HEALTHY |
PARTIALLY_HEALTHY |
| HEALTHY |
健康 |
ReplicationModeType
链接的复制模式
| 值 | 说明 |
|---|---|
| Async |
异步 |
| Sync |
同步 |
RoleChangeType
角色更改的类型可以是“计划”或“强制”。
| 值 | 说明 |
|---|---|
| Forced |
强迫 |
| Planned |
已计划的 |
SeedingModeType
数据库种子设定模式 – 可以是“自动”(默认值),也可以是“手动”(对于受支持的方案)。
| 值 | 说明 |
|---|---|
| Automatic |
自动 |
| Manual |
手动 |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建资源的标识。 |
| createdByType |
创建资源的标识的类型。 |
|
| lastModifiedAt |
string (date-time) |
资源上次修改的时间戳 (UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |