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 매개 변수

Name	In(다음 안에)	필수	형식	Description
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 버전입니다.

요청 본문

Name	형식	Description
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의 이름 및 용량입니다.

응답

Name	형식	Description
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
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
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
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/SyncGroupCreate.json
// this example is just showing the usage of "SyncGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SyncGroupResource
SyncGroupCollection collection = sqlDatabase.GetSyncGroups();

// invoke the operation
string syncGroupName = "syncgroupcrud-3187";
SyncGroupData data = new SyncGroupData
{
    Interval = -1,
    ConflictResolutionPolicy = SyncConflictResolutionPolicy.HubWin,
    SyncDatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    HubDatabaseUserName = "hubUser",
    UsePrivateLinkConnection = true,
};
ArmOperation<SyncGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncGroupName, data);
SyncGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SyncGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:

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
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/SyncGroupUpdate.json
// this example is just showing the usage of "SyncGroups_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SyncGroupResource
SyncGroupCollection collection = sqlDatabase.GetSyncGroups();

// invoke the operation
string syncGroupName = "syncgroupcrud-3187";
SyncGroupData data = new SyncGroupData
{
    Interval = -1,
    ConflictResolutionPolicy = SyncConflictResolutionPolicy.HubWin,
    SyncDatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    HubDatabaseUserName = "hubUser",
    UsePrivateLinkConnection = true,
};
ArmOperation<SyncGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncGroupName, data);
SyncGroupResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SyncGroupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:

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

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
Sku	ARM 리소스 SKU입니다.
SyncConflictResolutionPolicy	동기화 그룹의 충돌 해결 정책입니다.
SyncGroup	Azure SQL Database 동기화 그룹입니다.
SyncGroupSchema	동기화 그룹 스키마의 속성입니다.
SyncGroupSchemaTable	동기화 그룹 스키마의 테이블 속성입니다.
SyncGroupSchemaTableColumn	동기화 그룹 테이블의 열 속성입니다.
SyncGroupState	동기화 그룹의 동기화 상태입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

Sku

Object

ARM 리소스 SKU입니다.

Name	형식	Description
capacity	integer (int32)	특정 SKU의 용량입니다.
family	string	서비스에 여러 세대의 하드웨어가 있는 경우 동일한 SKU에 대해 여기에서 캡처할 수 있습니다.
name	string	SKU의 이름(일반적으로 문자 + 숫자 코드(예: P3)입니다.
size	string	특정 SKU의 크기
tier	string	특정 SKU의 계층 또는 버전(예: Basic, Premium)입니다.

SyncConflictResolutionPolicy

열거형

동기화 그룹의 충돌 해결 정책입니다.

값	Description
HubWin	허브윈
MemberWin	멤버윈

SyncGroup

Object

Azure SQL Database 동기화 그룹입니다.

Name	형식	Description
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	Azure Resource Manager 메타데이터에 createdBy 및 modifiedBy 정보가 포함되어 있습니다.
type	string	리소스의 형식입니다. 예를 들어, "Microsoft. 컴퓨트/가상 머신" 또는 "Microsoft." 저장소/저장소 계정"

SyncGroupSchema

Object

동기화 그룹 스키마의 속성입니다.

Name	형식	Description
masterSyncMemberName	string	스키마가 있는 마스터 동기화 멤버의 이름입니다.
tables	SyncGroupSchemaTable[]	동기화 그룹 스키마의 테이블 목록입니다.

SyncGroupSchemaTable

Object

동기화 그룹 스키마의 테이블 속성입니다.

Name	형식	Description
columns	SyncGroupSchemaTableColumn[]	동기화 그룹 스키마의 열 목록입니다.
quotedName	string	동기화 그룹 스키마 테이블의 따옴표로 묶인 이름입니다.

SyncGroupSchemaTableColumn

Object

동기화 그룹 테이블의 열 속성입니다.

Name	형식	Description
dataSize	string	열의 데이터 크기입니다.
dataType	string	열의 데이터 형식입니다.
quotedName	string	동기화 그룹 테이블 열의 따옴표로 묶인 이름입니다.

SyncGroupState

열거형

동기화 그룹의 동기화 상태입니다.

값	Description
NotReady	NotReady
Error	오류
Warning	경고
Progressing	진행
Good	좋음

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.