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

名前	/	必須	型	説明
databaseName	path	True	string	同期グループがホストされているデータベースの名前。
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
syncGroupName	path	True	string	同期メンバーがホストされている同期グループの名前。
syncMemberName	path	True	string	同期メンバーの名前。
api-version	query	True	string	要求で使用する API のバージョン。

要求本文

名前	型	説明
properties.databaseName	string	同期メンバー内のメンバーデータベースのデータベース名。
properties.databaseType	SyncMemberDbType	同期メンバーのデータベースの種類。
properties.password	string	同期メンバー内のメンバーデータベースのパスワード。
properties.serverName	string	同期メンバー内のメンバーデータベースのサーバー名
properties.sqlServerDatabaseId	string	同期メンバーのデータベース ID をSQL Serverします。
properties.syncAgentId	string	同期メンバー内の同期エージェントの ARM リソース ID。
properties.syncDirection	SyncDirection	同期メンバーの同期方向。
properties.syncMemberAzureDatabaseResourceId	string	Azure の同期メンバーの同期メンバー論理データベースの ARM リソース ID。
properties.usePrivateLinkConnection	boolean	プライベートリンク接続を使用するかどうか。
properties.userName	string	同期メンバー内のメンバーデータベースのユーザー名。

応答

名前	型	説明
200 OK	SyncMember	同期メンバーが正常に更新されました。
201 Created	SyncMember	同期メンバーが正常に作成されました。
202 Accepted		同期メンバーの作成または更新が進行中です。
Other Status Codes		エラー応答: *** 400 InvalidSyncGroupCreateOrUpdateRequest - 同期グループの作成または更新要求本文が空です。 400 InvalidSyncMemberCreateOrUpdateRequest - 同期メンバーの作成または更新要求本文が空です。 400 InvalidSyncAgentCreateOrUpdateRequest - 同期エージェントの作成または更新要求本文が空です。 400 InvalidDatabaseResourceId - データベースリソース識別子が無効です。 400 MismatchingSubscriptionWithUrl - 指定されたサブスクリプションが URL 内のサブスクリプションと一致しませんでした。 400 InvalidSyncAgentResourceId - 同期エージェントのリソース識別子が無効です。 400 MismatchingResourceGroupNameWithUrl - 指定されたリソースグループ名が URL の名前と一致しませんでした。 400 MismatchingServerNameWithUrl - 指定されたサーバー名が 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 - Id を持つ操作が存在しません。 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

定義

名前	説明
SyncDirection	同期メンバーの同期方向。
SyncMember	Azure SQL Database 同期メンバー。
SyncMemberDbType	同期メンバーのデータベースの種類。
SyncMemberState	同期メンバーの同期状態。

SyncDirection

同期メンバーの同期方向。

名前	型	説明
Bidirectional	string
OneWayHubToMember	string
OneWayMemberToHub	string

SyncMember

Azure SQL Database 同期メンバー。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.databaseName	string	同期メンバー内のメンバーデータベースのデータベース名。
properties.databaseType	SyncMemberDbType	同期メンバーのデータベースの種類。
properties.password	string	同期メンバー内のメンバーデータベースのパスワード。
properties.privateEndpointName	string	Azure の同期メンバーに対して、プライベートリンク接続の使用が有効になっている場合の同期メンバーのプライベートエンドポイント名。
properties.serverName	string	同期メンバー内のメンバーデータベースのサーバー名
properties.sqlServerDatabaseId	string	同期メンバーのデータベース ID をSQL Serverします。
properties.syncAgentId	string	同期メンバー内の同期エージェントの ARM リソース ID。
properties.syncDirection	SyncDirection	同期メンバーの同期方向。
properties.syncMemberAzureDatabaseResourceId	string	Azure の同期メンバーの同期メンバー論理データベースの ARM リソース ID。
properties.syncState	SyncMemberState	同期メンバーの同期状態。
properties.usePrivateLinkConnection	boolean	プライベートリンク接続を使用するかどうか。
properties.userName	string	同期メンバー内のメンバーデータベースのユーザー名。
type	string	リソースの種類。

SyncMemberDbType

同期メンバーのデータベースの種類。

名前	型	説明
AzureSqlDatabase	string
SqlServerDatabase	string

SyncMemberState

同期メンバーの同期状態。

名前	型	説明
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

その他のリソース