Sync Members - Create Or Update

參考

服務:: SQL Database

API 版本:: 2021-11-01

建立或更新同步成員。

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

URI 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	裝載同步群組的資料庫名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
syncGroupName	path	True	string	同步成員裝載所在的同步群組名稱。
syncMemberName	path	True	string	同步成員的名稱。
api-version	query	True	string	要用於要求的 API 版本。

要求本文

名稱	類型	Description
properties.databaseName	string	同步成員中成員資料庫的資料庫名稱。
properties.databaseType	SyncMemberDbType	同步成員的資料庫類型。
properties.password	string	同步成員中成員資料庫的密碼。
properties.serverName	string	同步成員中成員資料庫的伺服器名稱
properties.sqlServerDatabaseId	string	SQL Server 同步成員的資料庫標識碼。
properties.syncAgentId	string	同步成員中同步代理程式的 ARM 資源識別碼。
properties.syncDirection	SyncDirection	同步成員的同步方向。
properties.syncMemberAzureDatabaseResourceId	string	同步成員邏輯資料庫的 ARM 資源識別碼，適用於 Azure 中的同步成員。
properties.usePrivateLinkConnection	boolean	是否要使用私人連結連線。
properties.userName	string	同步成員中成員資料庫的用戶名稱。

回應

名稱	類型	Description
200 OK	SyncMember	已成功更新同步成員。
201 Created	SyncMember	已成功建立同步成員。
202 Accepted		正在建立或更新同步成員。
Other Status Codes		錯誤回應： ≦ 400 InvalidSyncGroupCreateOrUpdateRequest - 建立或更新同步群組要求本文是空的。 400 InvalidSyncMemberCreateOrUpdateRequest - 建立或更新同步成員要求本文是空的。 400 InvalidSyncAgentCreateOrUpdateRequest - 建立或更新同步代理程式要求本文是空的。 400 InvalidDatabaseResourceId - 無效的資料庫資源標識符。 400 MatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 URL 中的訂用帳戶。 400 InvalidSyncAgentResourceId - 無效的同步代理程序資源標識符。 400 MatchingResourceGroupNameWithUrl - 提供的資源組名與 URL 中的名稱不符。 400 不相符ServerNameWithUrl - 提供的伺服器名稱與 URL 中的名稱不符。 400 InvalidParameterValue - 已將無效的值提供給參數。 400 MissingServerName - 伺服器名稱遺失 400 MissingDatabaseName - 遺漏資料庫名稱 400 MissingSyncGroupName - 同步組名遺失 400 MissingConflictResolutionPolicy - 衝突解決原則遺失 400 MissingSyncAgentName - 同步代理程式名稱遺失 400 SyncOperation_GenericFailure - 無法執行資料同步作業。 400 InvalidSyncGroup - 同步群組無效。 400 InvalidSyncMember - 同步成員無效。 400 InvalidSyncAgent - 同步代理程序無效。 400 CannotCreateSyncMemberDueToQuotaExceeded - 因為超過配額而無法建立同步成員。 400 SyncOperation_DuplicateSyncMemberDrop - 同步成員已卸除。 400 SyncOperation_WrongSyncDatabase - 指定的同步資料庫不符合現有的資料庫。 400 SyncOperation_DwInSyncGroup - 無法在數據同步中使用 Datawarehouse 版本。 400 SyncOperation_MasterDbInSyncGroup - 無法在資料同步中使用邏輯主機。 400 SyncOperation_InvalidCredential - 資料庫的認證無效。 400 InvalidSyncMetadataDatabase - 同步元數據資料庫無效。 404 ResourceNotFound - 找不到所要求的資源。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 DatabaseDoesNotExist - 使用者已指定不存在於此伺服器實例上的資料庫名稱。 404 SyncOperation_HubServerNotFound - 中樞邏輯伺服器不存在。 404 SyncOperation_InvalidHubDatabase - 中樞資料庫無效。 404 OperationIdNotFound - 標識符為的作業不存在。 409 SyncOperation_DuplicateSyncMemberName - 無法建立同步成員，因為具有相同名稱的同步成員已經存在。 409 OperationCancelled - 使用者已取消作業。 409 OperationInterrupted - 無法完成資源上的作業，因為它被相同資源上的另一個作業中斷。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。 500 OperationTimedOut - 作業逾時並自動回復。請重試該作業。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

範例

Create a new sync member

Update a sync member

Create a new sync member

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=2021-11-01

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


import com.azure.resourcemanager.sql.fluent.models.SyncMemberInner;
import com.azure.resourcemanager.sql.models.SyncDirection;
import com.azure.resourcemanager.sql.models.SyncMemberDbType;

/**
 * Samples for SyncMembers CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncMemberCreate.json
     */
    /**
     * Sample code: Create a new sync member.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createANewSyncMember(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncMembers().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187", "syncmembercrud-4879",
            new SyncMemberInner().withDatabaseType(SyncMemberDbType.AZURE_SQL_DATABASE)
                .withSyncMemberAzureDatabaseResourceId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withUsePrivateLinkConnection(true).withServerName("syncgroupcrud-3379.database.windows.net")
                .withDatabaseName("syncgroupcrud-7421").withUsername("myUser")
                .withSyncDirection(SyncDirection.BIDIRECTIONAL),
            com.azure.core.util.Context.NONE);
    }
}

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

範例回覆

狀態碼:: 200

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

狀態碼:: 201

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

狀態碼:: 202

Update a sync member

範例要求

HTTP
Java

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=2021-11-01

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


import com.azure.resourcemanager.sql.fluent.models.SyncMemberInner;
import com.azure.resourcemanager.sql.models.SyncDirection;
import com.azure.resourcemanager.sql.models.SyncMemberDbType;

/**
 * Samples for SyncMembers CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncMemberUpdate.json
     */
    /**
     * Sample code: Update a sync member.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASyncMember(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncMembers().createOrUpdate("syncgroupcrud-65440",
            "syncgroupcrud-8475", "syncgroupcrud-4328", "syncgroupcrud-3187", "syncmembercrud-4879",
            new SyncMemberInner().withDatabaseType(SyncMemberDbType.AZURE_SQL_DATABASE)
                .withSyncMemberAzureDatabaseResourceId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328")
                .withUsePrivateLinkConnection(true).withServerName("syncgroupcrud-3379.database.windows.net")
                .withDatabaseName("syncgroupcrud-7421").withUsername("myUser")
                .withSyncDirection(SyncDirection.BIDIRECTIONAL),
            com.azure.core.util.Context.NONE);
    }
}

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

範例回覆

狀態碼:: 200

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

狀態碼:: 201

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

狀態碼:: 202

定義

名稱	Description
SyncDirection	同步成員的同步方向。
SyncMember	Azure SQL 資料庫同步成員。
SyncMemberDbType	同步成員的資料庫類型。
SyncMemberState	同步成員的同步狀態。

SyncDirection

同步成員的同步方向。

名稱	類型	Description
Bidirectional	string
OneWayHubToMember	string
OneWayMemberToHub	string

SyncMember

Azure SQL 資料庫同步成員。

名稱	類型	Description
id	string	資源識別碼。
name	string	資源名稱。
properties.databaseName	string	同步成員中成員資料庫的資料庫名稱。
properties.databaseType	SyncMemberDbType	同步成員的資料庫類型。
properties.password	string	同步成員中成員資料庫的密碼。
properties.privateEndpointName	string	如果已啟用私人連結連線，則同步成員的私人端點名稱，適用於 Azure 中的同步成員。
properties.serverName	string	同步成員中成員資料庫的伺服器名稱
properties.sqlServerDatabaseId	string	SQL Server 同步成員的資料庫標識碼。
properties.syncAgentId	string	同步成員中同步代理程式的 ARM 資源識別碼。
properties.syncDirection	SyncDirection	同步成員的同步方向。
properties.syncMemberAzureDatabaseResourceId	string	同步成員邏輯資料庫的 ARM 資源識別碼，適用於 Azure 中的同步成員。
properties.syncState	SyncMemberState	同步成員的同步狀態。
properties.usePrivateLinkConnection	boolean	是否要使用私人連結連線。
properties.userName	string	同步成員中成員資料庫的用戶名稱。
type	string	資源類型。

SyncMemberDbType

同步成員的資料庫類型。

名稱	類型	Description
AzureSqlDatabase	string
SqlServerDatabase	string

SyncMemberState

同步成員的同步狀態。

名稱	類型	Description
DeProvisionFailed	string
DeProvisioned	string
DeProvisioning	string
DisabledBackupRestore	string
DisabledTombstoneCleanup	string
ProvisionFailed	string
Provisioned	string
Provisioning	string
ReprovisionFailed	string
Reprovisioning	string
SyncCancelled	string
SyncCancelling	string
SyncFailed	string
SyncInProgress	string
SyncSucceeded	string
SyncSucceededWithWarnings	string
UnProvisioned	string
UnReprovisioned	string

共用方式為

Sync Members - Create Or Update

URI 參數

要求本文

回應

範例

Create a new sync member

範例要求

範例回覆

Update a sync member

範例要求

範例回覆

定義

SyncDirection

SyncMember

SyncMemberDbType

SyncMemberState

其他資源