Sync Agents - List Linked Databases

同期エージェントにリンクされているデータベースを一覧表示します。

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

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
200 OK

サーバー データベースにリンクされた同期エージェントSQL正常に取得されました。

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 SyncOperation_GenericFailure - データ同期操作を実行できませんでした。

  • 400 SyncOperation_WrongSyncDatabase - 指定された同期データベースが既存のデータベースと一致しません。

  • 400 SyncOperation_DwInSyncGroup - データ同期で datawarehouse エディションを使用できません。

  • 400 SyncOperation_MasterDbInSyncGroup - データ同期で論理マスターを使用できません。

  • 400 CannotDeleteInUseSyncAgent - 同期メンバーによって使用されるため、同期エージェントを削除できません。

  • 400 InvalidSyncAgent - 同期エージェントが無効です。

  • 400 InvalidSyncMetadataDatabase - 同期メタデータ データベースが無効です。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。

  • 409 SyncOperation_AgentAlreadyExists - 同じ名前の同期エージェントが既に存在します。

  • 409 SyncOperation_AgentIdAlreadyExists - 同じ ID を持つ同期エージェントが既に存在します。

Get sync agent linked databases

Sample Request

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

Sample Response

{
  "value": [
    {
      "properties": {
        "databaseType": "SqlServerDatabase",
        "databaseId": "55555555-6666-7777-8888-999999999999",
        "description": "",
        "serverName": "DummySqlServer",
        "databaseName": "DummySqlServerDb",
        "userName": "DummyUser"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187/linkedDatabases/55555555-6666-7777-8888-999999999999"
    }
  ]
}

定義

SyncAgentLinkedDatabase

Azure SQL Database同期エージェントのリンク されたデータベース。

SyncAgentLinkedDatabaseListResult

同期エージェントのリンクされたデータベースの一覧。

SyncMemberDbType

同期エージェントのリンク されたデータベースの種類。

SyncAgentLinkedDatabase

Azure SQL Database同期エージェントのリンク されたデータベース。

Name Type Description
id
  • string

リソースの ID

name
  • string

リソース名。

properties.databaseId
  • string

同期エージェントのリンク されたデータベースの ID。

properties.databaseName
  • string

同期エージェントのリンク されたデータベースのデータベース名。

properties.databaseType

同期エージェントのリンク されたデータベースの種類。

properties.description
  • string

同期エージェントのリンク されたデータベースの説明。

properties.serverName
  • string

同期エージェントのリンク データベースのサーバー名。

properties.userName
  • string

同期エージェントのリンク されたデータベースのユーザー名。

type
  • string

リソースの種類。

SyncAgentLinkedDatabaseListResult

同期エージェントのリンクされたデータベースの一覧。

Name Type Description
nextLink
  • string

結果の次のページを取得するためのリンク。

value

結果の配列。

SyncMemberDbType

同期エージェントのリンク されたデータベースの種類。

Name Type Description
AzureSqlDatabase
  • string
SqlServerDatabase
  • string