Sync Members - 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}/syncMembers/{syncMemberName}?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	동기화 그룹의 이름입니다.
syncMemberName	path	True	string	동기화 멤버의 이름입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
properties.databaseName	string	동기화 멤버에 있는 멤버 데이터베이스의 데이터베이스 이름입니다.
properties.databaseType	SyncMemberDbType	동기화 멤버의 데이터베이스 형식입니다.
properties.password	string	동기화 멤버에 있는 멤버 데이터베이스의 암호입니다.
properties.serverName	string	동기화 멤버에 있는 멤버 데이터베이스의 서버 이름
properties.sqlServerDatabaseId	string (uuid)	SQL Server 데이터베이스 ID는 동기화 멤버의 것입니다.
properties.syncAgentId	string	동기화 멤버에 있는 동기화 에이전트의 ARM 리소스 ID입니다.
properties.syncDirection	SyncDirection	동기화 멤버의 동기화 방향입니다.
properties.syncMemberAzureDatabaseResourceId	string	Azure의 동기화 멤버를 위한 동기화 멤버 논리 데이터베이스의 ARM 리소스 ID.
properties.usePrivateLinkConnection	boolean	프라이빗 링크 연결을 사용할지 여부입니다.
properties.userName	string	동기화 멤버에 있는 멤버 데이터베이스의 사용자 이름입니다.

응답

Name	형식	Description
200 OK	SyncMember	리소스 'SyncMember' 업데이트 작업이 성공했습니다
201 Created	SyncMember	리소스 'SyncMember' 생성 작업 성공 헤더 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 new sync member

Update a sync member

Create a new sync member

샘플 요청

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/syncMembers/syncmembercrud-4879?api-version=2025-01-01

{
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

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/SyncMemberCreate.json
// this example is just showing the usage of "SyncMembers_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 SyncGroupResource created on azure
// for more information of creating SyncGroupResource, please refer to the document of SyncGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
ResourceIdentifier syncGroupResourceId = SyncGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName);
SyncGroupResource syncGroup = client.GetSyncGroupResource(syncGroupResourceId);

// get the collection of this SyncMemberResource
SyncMemberCollection collection = syncGroup.GetSyncMembers();

// invoke the operation
string syncMemberName = "syncmembercrud-4879";
SyncMemberData data = new SyncMemberData
{
    DatabaseType = SyncMemberDbType.AzureSqlDatabase,
    SyncMemberAzureDatabaseResourceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    UsePrivateLinkConnection = true,
    ServerName = "syncgroupcrud-3379.database.windows.net",
    DatabaseName = "syncgroupcrud-7421",
    UserName = "myUser",
    SyncDirection = SyncDirection.Bidirectional,
};
ArmOperation<SyncMemberResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncMemberName, data);
SyncMemberResource 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
SyncMemberData 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": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

상태 코드:

201

{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

상태 코드:

202

Update a sync member

샘플 요청

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/syncMembers/syncmembercrud-4879?api-version=2025-01-01

{
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

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/SyncMemberUpdate.json
// this example is just showing the usage of "SyncMembers_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 SyncGroupResource created on azure
// for more information of creating SyncGroupResource, please refer to the document of SyncGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "syncgroupcrud-65440";
string serverName = "syncgroupcrud-8475";
string databaseName = "syncgroupcrud-4328";
string syncGroupName = "syncgroupcrud-3187";
ResourceIdentifier syncGroupResourceId = SyncGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, syncGroupName);
SyncGroupResource syncGroup = client.GetSyncGroupResource(syncGroupResourceId);

// get the collection of this SyncMemberResource
SyncMemberCollection collection = syncGroup.GetSyncMembers();

// invoke the operation
string syncMemberName = "syncmembercrud-4879";
SyncMemberData data = new SyncMemberData
{
    DatabaseType = SyncMemberDbType.AzureSqlDatabase,
    SyncMemberAzureDatabaseResourceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328"),
    UsePrivateLinkConnection = true,
    ServerName = "syncgroupcrud-3379.database.windows.net",
    DatabaseName = "syncgroupcrud-7421",
    UserName = "myUser",
    SyncDirection = SyncDirection.Bidirectional,
};
ArmOperation<SyncMemberResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, syncMemberName, data);
SyncMemberResource 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
SyncMemberData 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": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

상태 코드:

201

{
  "name": "syncmembercrud-4879",
  "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879",
  "properties": {
    "databaseName": "syncgroupcrud-7421",
    "databaseType": "AzureSqlDatabase",
    "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879",
    "serverName": "syncgroupcrud-3379.database.windows.net",
    "syncDirection": "Bidirectional",
    "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328",
    "syncState": "UnProvisioned",
    "usePrivateLinkConnection": true,
    "userName": "myUser"
  }
}

상태 코드:

202

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
SyncDirection	동기화 멤버의 동기화 방향입니다.
SyncMember	Azure SQL Database 동기화 멤버입니다.
SyncMemberDbType	동기화 에이전트 연결된 데이터베이스의 유형입니다.
SyncMemberState	동기화 멤버의 동기화 상태입니다.
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	오류 개체입니다.

SyncDirection

열거형

동기화 멤버의 동기화 방향입니다.

값	Description
Bidirectional	양방향
OneWayMemberToHub	원웨이 멤버투허브
OneWayHubToMember	원웨이허브 회원

SyncMember

Object

Azure SQL Database 동기화 멤버입니다.

Name	형식	Description
id	string (arm-id)	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	리소스의 이름
properties.databaseName	string	동기화 멤버에 있는 멤버 데이터베이스의 데이터베이스 이름입니다.
properties.databaseType	SyncMemberDbType	동기화 멤버의 데이터베이스 형식입니다.
properties.password	string	동기화 멤버에 있는 멤버 데이터베이스의 암호입니다.
properties.privateEndpointName	string	프라이비럴 링크 연결을 사용하면 동기화 멤버의 개인 엔드포인트 이름을 사용하세요. Azure에서 동기화 멤버의 경우에 대해서요.
properties.serverName	string	동기화 멤버에 있는 멤버 데이터베이스의 서버 이름
properties.sqlServerDatabaseId	string (uuid)	SQL Server 데이터베이스 ID는 동기화 멤버의 것입니다.
properties.syncAgentId	string	동기화 멤버에 있는 동기화 에이전트의 ARM 리소스 ID입니다.
properties.syncDirection	SyncDirection	동기화 멤버의 동기화 방향입니다.
properties.syncMemberAzureDatabaseResourceId	string	Azure의 동기화 멤버를 위한 동기화 멤버 논리 데이터베이스의 ARM 리소스 ID.
properties.syncState	SyncMemberState	동기화 멤버의 동기화 상태입니다.
properties.usePrivateLinkConnection	boolean	프라이빗 링크 연결을 사용할지 여부입니다.
properties.userName	string	동기화 멤버에 있는 멤버 데이터베이스의 사용자 이름입니다.
systemData	systemData	Azure Resource Manager 메타데이터에 createdBy 및 modifiedBy 정보가 포함되어 있습니다.
type	string	리소스의 형식입니다. 예를 들어, "Microsoft. 컴퓨트/가상 머신" 또는 "Microsoft." 저장소/저장소 계정"

SyncMemberDbType

열거형

동기화 에이전트 연결된 데이터베이스의 유형입니다.

값	Description
AzureSqlDatabase	AzureSqlDatabase
SqlServerDatabase	SqlServerDatabase

SyncMemberState

열거형

동기화 멤버의 동기화 상태입니다.

값	Description
SyncInProgress	싱크인프로그스
SyncSucceeded	동기화성공
SyncFailed	동기화 실패
DisabledTombstoneCleanup	장애된 묘비 정리
DisabledBackupRestore	DisabledBackupRestore
SyncSucceededWithWarnings	동기화 성공 경고
SyncCancelling	싱크 캔슬링
SyncCancelled	동기화 취소
UnProvisioned	언브로비네이드
Provisioning	Provisioning
Provisioned	할당됨
ProvisionFailed	제공 실패
DeProvisioning	디프로비저닝
DeProvisioned	디프로비처닝
DeProvisionFailed	디프로비저브 실패
Reprovisioning	다시 프로비저낭
ReprovisionFailed	재준비 실패
UnReprovisioned	재배치 해제

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의 형식입니다.