Sync Agents - Create Or Update

リファレンス

サービス:: SQL Database

API バージョン:: 2021-11-01

同期エージェントを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}?api-version=2021-11-01

URI パラメーター

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

要求本文

名前	型	説明
properties.syncDatabaseId	string	同期エージェント内の同期データベースの ARM リソース ID。

応答

名前	型	説明
200 OK	SyncAgent	同期エージェントが正常に更新されました。
201 Created	SyncAgent	同期エージェントが正常に作成されました。
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 SyncOperation_WrongSyncDatabase - 指定された同期データベースが既存のデータベースと一致しません。 400 SyncOperation_DwInSyncGroup - データ同期で datawarehouse エディションを使用できません。 400 SyncOperation_MasterDbInSyncGroup - データ同期で論理マスターを使用できません。 400 CannotDeleteInUseSyncAgent - 同期メンバーによって使用されるため、同期エージェントを削除できません。 400 InvalidSyncAgent - 同期エージェントが無効です。 400 InvalidSyncMetadataDatabase - 同期メタデータデータベースが無効です。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 SyncOperation_AgentAlreadyExists - 同じ名前の同期エージェントが既に存在します。 409 SyncOperation_AgentIdAlreadyExists - 同じ ID の同期エージェントが既に存在します。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作をやり直してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

例

Create a new sync agent

Update a sync agent

Create a new sync agent

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187?api-version=2021-11-01

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"
  }
}


import com.azure.resourcemanager.sql.fluent.models.SyncAgentInner;

/**
 * Samples for SyncAgents CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentCreate.json
     */
    /**
     * Sample code: Create a new sync agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createANewSyncAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().createOrUpdate("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187",
            new SyncAgentInner().withSyncDatabaseId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"),
            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": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

状態コード:: 201

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

状態コード:: 202

Update a sync agent

要求のサンプル

HTTP
Java

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncagentcrud-65440/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187?api-version=2021-11-01

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"
  }
}


import com.azure.resourcemanager.sql.fluent.models.SyncAgentInner;

/**
 * Samples for SyncAgents CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentUpdate.json
     */
    /**
     * Sample code: Update a sync agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateASyncAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().createOrUpdate("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187",
            new SyncAgentInner().withSyncDatabaseId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync"),
            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": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

状態コード:: 201

{
  "properties": {
    "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync",
    "state": "NeverConnected",
    "isUpToDate": true,
    "expiryTime": "9999-12-31T23:59:59.9999999Z",
    "version": "4.2.0.0"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187",
  "name": "syncagent",
  "type": "Microsoft.Sql/servers/syncAgents"
}

状態コード:: 202

定義

名前	説明
SyncAgent	Azure SQL Database 同期エージェント。
SyncAgentState	同期エージェントの状態。

SyncAgent

Azure SQL Database 同期エージェント。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.expiryTime	string	同期エージェントのバージョンの有効期限。
properties.isUpToDate	boolean	同期エージェントのバージョンが最新の場合。
properties.lastAliveTime	string	同期エージェントの最後の有効期間。
properties.name	string	同期エージェントの名前。
properties.state	SyncAgentState	同期エージェントの状態。
properties.syncDatabaseId	string	同期エージェント内の同期データベースの ARM リソース ID。
properties.version	string	同期エージェントのバージョン。
type	string	リソースの種類。

SyncAgentState

同期エージェントの状態。

名前	型	説明
NeverConnected	string
Offline	string
Online	string

次の方法で共有

Sync Agents - Create Or Update

URI パラメーター

要求本文

応答

例

Create a new sync agent

要求のサンプル

応答のサンプル

Update a sync agent

要求のサンプル

応答のサンプル

定義

SyncAgent

SyncAgentState

その他のリソース