Sync Groups - Create Or Update

サービス:: SQL Database

API バージョン:: 2025-01-01

同期グループを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/syncGroups/{syncGroupName}?api-version=2025-01-01

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前の大文字と小文字は区別されません。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
syncGroupName	path	True	string	同期グループの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.conflictLoggingRetentionInDays	integer (int32)	競合ログの保持期間。
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	同期グループの競合解決ポリシー。
properties.enableConflictLogging	boolean	競合ログが有効になっている場合。
properties.hubDatabasePassword	string (password)	同期グループハブデータベース資格情報のパスワード。
properties.hubDatabaseUserName	string	同期グループハブデータベース資格情報のユーザー名。
properties.interval	integer (int32)	同期グループの同期間隔。
properties.schema	SyncGroupSchema	同期グループの同期スキーマ。
properties.syncDatabaseId	string	同期グループ内の同期データベースの ARM リソース ID。
properties.usePrivateLinkConnection	boolean	プライベートリンク接続の使用が有効になっている場合。
sku	Sku	SKU の名前と容量。

応答

名前	型	説明
200 OK	SyncGroup	リソース「SyncGroup」更新操作が成功しました
201 Created	SyncGroup	リソース「SyncGroup」作成操作は成功しましたヘッダー 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
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Create a sync group

Update a sync group

Create a sync group

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187?api-version=2025-01-01

{
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-8475",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true
  }
}

状態コード:: 201

{
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-8475",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true
  }
}

状態コード:: 202

Update a sync group

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187?api-version=2025-01-01

{
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true
  }
}

応答のサンプル

状態コード:: 200

{
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true
  }
}

状態コード:: 201

{
  "name": "syncgroupcrud-3187",
  "type": "Microsoft.Sql/servers/databases/syncGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187",
  "properties": {
    "conflictResolutionPolicy": "HubWin",
    "hubDatabaseUserName": "hubUser",
    "interval": -1,
    "lastSyncTime": "0001-01-01T08:00:00Z",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187",
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "NotReady",
    "usePrivateLinkConnection": true
  }
}

状態コード:: 202

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Sku	ARM リソース SKU。
SyncConflictResolutionPolicy	同期グループの競合解決ポリシー。
SyncGroup	Azure SQL Databaseの同期グループです。
SyncGroupSchema	同期グループスキーマのプロパティ。
SyncGroupSchemaTable	同期グループスキーマ内のテーブルのプロパティ。
SyncGroupSchemaTableColumn	同期グループテーブル内の列のプロパティ。
SyncGroupState	同期グループの同期状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

Sku

Object

ARM リソース SKU。

名前	型	説明
capacity	integer (int32)	特定の SKU の容量。
family	string	同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name	string	SKU の名前。通常は、文字 + 番号コード (P3 など)。
size	string	特定の SKU のサイズ
tier	string	特定の SKU のレベルまたはエディション (Basic、Premium など)。

SyncConflictResolutionPolicy

列挙

同期グループの競合解決ポリシー。

値	説明
HubWin	ハブウィン
MemberWin	メンバーウィン

SyncGroup

Object

Azure SQL Databaseの同期グループです。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.conflictLoggingRetentionInDays	integer (int32)	競合ログの保持期間。
properties.conflictResolutionPolicy	SyncConflictResolutionPolicy	同期グループの競合解決ポリシー。
properties.enableConflictLogging	boolean	競合ログが有効になっている場合。
properties.hubDatabasePassword	string (password)	同期グループハブデータベース資格情報のパスワード。
properties.hubDatabaseUserName	string	同期グループハブデータベース資格情報のユーザー名。
properties.interval	integer (int32)	同期グループの同期間隔。
properties.lastSyncTime	string (date-time)	同期グループの最終同期時刻。
properties.privateEndpointName	string	プライベートリンク接続の使用が有効になっている場合の同期グループのプライベートエンドポイント名。
properties.schema	SyncGroupSchema	同期グループの同期スキーマ。
properties.syncDatabaseId	string	同期グループ内の同期データベースの ARM リソース ID。
properties.syncState	SyncGroupState	同期グループの同期状態。
properties.usePrivateLinkConnection	boolean	プライベートリンク接続の使用が有効になっている場合。
sku	Sku	SKU の名前と容量。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

SyncGroupSchema

Object

同期グループスキーマのプロパティ。

名前	型	説明
masterSyncMemberName	string	スキーマの由来となるマスター同期メンバーの名前。
tables	SyncGroupSchemaTable[]	同期グループスキーマ内のテーブルの一覧。

SyncGroupSchemaTable

Object

同期グループスキーマ内のテーブルのプロパティ。

名前	型	説明
columns	SyncGroupSchemaTableColumn[]	同期グループスキーマ内の列の一覧。
quotedName	string	同期グループスキーマテーブルの引用符で囲まれた名前。

SyncGroupSchemaTableColumn

Object

同期グループテーブル内の列のプロパティ。

名前	型	説明
dataSize	string	列のデータサイズ。
dataType	string	列のデータ型。
quotedName	string	同期グループテーブル列の引用符で囲まれた名前。

SyncGroupState

列挙

同期グループの同期状態。

値	説明
NotReady	NotReady
Error	エラー
Warning	Warnung
Progressing	進展
Good	よし

systemData

Object

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

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Sync Groups - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Create a sync group

要求のサンプル

応答のサンプル

Update a sync group

要求のサンプル

応答のサンプル

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Sku

SyncConflictResolutionPolicy

SyncGroup

SyncGroupSchema

SyncGroupSchemaTable

SyncGroupSchemaTableColumn

SyncGroupState

systemData