Sync Agents - Create Or Update

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

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

URI パラメーター

Name In Required Type Description
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 のバージョン。

要求本文

Name Type Description
properties.syncDatabaseId
  • string

同期エージェント内の同期データベースの ARM リソース ID。

応答

Name Type Description
200 OK

同期エージェントを正常に更新しました。

201 Created

同期エージェントが正常に作成されました。

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

Sample Request

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

Sample Response

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

Update a sync agent

Sample Request

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

Sample Response

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

定義

SyncAgent

Azure SQL データベース同期エージェント。

SyncAgentState

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

SyncAgent

Azure SQL データベース同期エージェント。

Name Type Description
id
  • string

リソースの ID

name
  • string

リソース名。

properties.expiryTime
  • string

同期エージェントのバージョンの有効期限。

properties.isUpToDate
  • boolean

同期エージェントのバージョンが最新の場合。

properties.lastAliveTime
  • string

同期エージェントの最後の有効期間。

properties.name
  • string

同期エージェントの名前。

properties.state

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

properties.syncDatabaseId
  • string

同期エージェント内の同期データベースの ARM リソース ID。

properties.version
  • string

同期エージェントのバージョン。

type
  • string

リソースの種類。

SyncAgentState

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

Name Type Description
NeverConnected
  • string
Offline
  • string
Online
  • string