Sync Agents - List Linked Databases

サービス:

SQL Database

API バージョン:

2021-11-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/linkedDatabases?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 のバージョン。

応答

名前	型	説明
200 OK	SyncAgentLinkedDatabaseListResult	同期エージェントのリンクされた SQL Server データベースが正常に取得されました。
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 - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。 409 SyncOperation_AgentAlreadyExists - 同じ名前の同期エージェントが既に存在します。 409 SyncOperation_AgentIdAlreadyExists - 同じ ID の同期エージェントが既に存在します。

例

Get sync agent linked databases

要求のサンプル

HTTP

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

Java

/**
 * Samples for SyncAgents ListLinkedDatabases.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SyncAgentGetLinkedDatabases.json
     */
    /**
     * Sample code: Get sync agent linked databases.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getSyncAgentLinkedDatabases(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSyncAgents().listLinkedDatabases("syncagentcrud-65440",
            "syncagentcrud-8475", "syncagentcrud-3187", 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

{
  "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 データベース同期エージェントのリンクされたデータベース。
SyncAgentLinkedDatabaseListResult	同期エージェントのリンクされたデータベースの一覧。
SyncMemberDbType	同期エージェントのリンクされたデータベースの種類。

SyncAgentLinkedDatabase

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

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.databaseId	string	同期エージェントのリンクされたデータベースの ID。
properties.databaseName	string	同期エージェントのリンクされたデータベースのデータベース名。
properties.databaseType	SyncMemberDbType	同期エージェントのリンクされたデータベースの種類。
properties.description	string	同期エージェントのリンクされたデータベースの説明。
properties.serverName	string	同期エージェントのリンク されたデータベースのサーバー名。
properties.userName	string	同期エージェントのリンクされたデータベースのユーザー名。
type	string	リソースの種類。

SyncAgentLinkedDatabaseListResult

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

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	SyncAgentLinkedDatabase[]	結果の配列。

SyncMemberDbType

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

名前	型	説明
AzureSqlDatabase	string
SqlServerDatabase	string