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 パラメーター

名前 / 必須 型 説明
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 バージョン。

要求本文

名前 必須 型 説明
instanceRole True

InstanceRole

分散型可用性グループ内のマネージド インスタンスの新しいロールは、プライマリまたはセカンダリにすることができます。

roleChangeType True

RoleChangeType

ロールの変更の種類は、[計画済み] または [強制] です。

応答

名前 型 説明
200 OK

DistributedAvailabilityGroup

Azureの運用は無事に完了しました。

202 Accepted

リソース操作が受け入れられます。

ヘッダー

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 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

定義

名前 説明
CertificateInfo

証明書情報

createdByType

リソースを作成した ID の種類。

DistributedAvailabilityGroup

BoxとSQL Managed Instance間の分散可用性グループ。

DistributedAvailabilityGroupDatabase

データベース固有の情報

DistributedAvailabilityGroupSetRole

分散型可用性グループのフェールオーバー要求。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

FailoverModeType

リンクフェイルオーバーモードは、サポートされたSQL Serverとの双方向フェイルオーバーに手動で使う場合、またはAzureへの一方方向フェイルオーバー用に「Any」にできます。

InstanceRole

分散型可用性グループ内のマネージド インスタンスの新しいロールは、プライマリまたはセカンダリにすることができます。

LinkRole

SQL サーバー側のリンクの役割

ReplicaConnectedState

リンク接続状態

ReplicaSynchronizationHealth

リンクの正常性状態

ReplicationModeType

リンクのレプリケーション モード

RoleChangeType

ロールの変更の種類は、[計画済み] または [強制] です。

SeedingModeType

データベース シードモード – サポートされているシナリオでは、自動 (既定)、または手動にすることができます。

systemData

リソースの作成と最後の変更に関連するメタデータ。

CertificateInfo

証明書情報

名前 型 説明
certificateName

string

証明書名

expiryDate

string (date-time)

証明書の有効期限

createdByType

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

DistributedAvailabilityGroup

BoxとSQL Managed Instance間の分散可用性グループ。

名前 型 説明
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への一方方向フェイルオーバー用に「Any」にできます。

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

create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。

type

string

リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

DistributedAvailabilityGroupDatabase

データベース固有の情報

名前 型 説明
connectedState

ReplicaConnectedState

リンク接続状態

databaseName

string

リンク内のデータベースの名前

instanceRedoReplicationLagSeconds

integer (int32)

Managed Instanceリンク側がプライマリの場合、遅延を再実行してください

instanceReplicaId

string (uuid)

マネージド インスタンスのレプリカ ID

instanceSendReplicationLagSeconds

integer (int32)

Managed Instanceリンク側がプライマリの場合のレプリケーション遅延

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

リンクの正常性状態

DistributedAvailabilityGroupSetRole

分散型可用性グループのフェールオーバー要求。

名前 型 説明
instanceRole

InstanceRole

分散型可用性グループ内のマネージド インスタンスの新しいロールは、プライマリまたはセカンダリにすることができます。

roleChangeType

RoleChangeType

ロールの変更の種類は、[計画済み] または [強制] です。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

FailoverModeType

リンクフェイルオーバーモードは、サポートされたSQL Serverとの双方向フェイルオーバーに手動で使う場合、またはAzureへの一方方向フェイルオーバー用に「Any」にできます。

値 説明
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

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。