openapi-directory/api/azure.com/sql-syncAgents.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.","title":"SqlManagementClient","version":"2015-05-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-syncAgents","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents":{"get":{"description":"Lists sync agents in a server.","operationId":"SyncAgents_ListByServer","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server on which the sync agent is hosted.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Get sync agents under a server":{"value":"syncagentcrud-8475"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of sync agents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAgentListResult"},"examples":{"Get sync agents under a server":{"$ref":"#/components/examples/Get_sync_agents_under_a_server"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 CannotDeleteInUseSyncAgent - Cannot delete sync agent because it is used by sync member.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."}},"tags":["SyncAgents"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}":{"delete":{"description":"Deletes a sync agent.","operationId":"SyncAgents_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server on which the sync agent is hosted.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Delete a sync agent":{"value":"syncagentcrud-8475"}}},{"description":"The name of the sync agent.","in":"path","name":"syncAgentName","required":true,"schema":{"type":"string"},"examples":{"Delete a sync agent":{"value":"syncagentcrud-3187"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the sync agent."},"202":{"description":"Deleting the sync agent is in progress."},"204":{"description":"The specified sync agent does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 CannotDeleteInUseSyncAgent - Cannot delete sync agent because it is used by sync member.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."}},"tags":["SyncAgents"],"x-ms-long-running-operation":true},"get":{"description":"Gets a sync agent.","operationId":"SyncAgents_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server on which the sync agent is hosted.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Get a sync agent":{"value":"syncagentcrud-8475"}}},{"description":"The name of the sync agent.","in":"path","name":"syncAgentName","required":true,"schema":{"type":"string"},"examples":{"Get a sync agent":{"value":"syncagentcrud-3187"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified sync agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAgent"},"examples":{"Get a sync agent":{"$ref":"#/components/examples/Get_a_sync_agent"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 CannotDeleteInUseSyncAgent - Cannot delete sync agent because it is used by sync member.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."}},"tags":["SyncAgents"]},"put":{"description":"Creates or updates a sync agent.","operationId":"SyncAgents_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server on which the sync agent is hosted.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Create a new sync agent":{"value":"syncagentcrud-8475"},"Update a sync agent":{"value":"syncagentcrud-8475"}}},{"description":"The name of the sync agent.","in":"path","name":"syncAgentName","required":true,"schema":{"type":"string"},"examples":{"Create a new sync agent":{"value":"syncagentcrud-3187"},"Update a sync agent":{"value":"syncagentcrud-3187"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAgent"}}},"description":"The requested sync agent resource state.","required":true},"responses":{"200":{"description":"Successfully updated the sync agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAgent"},"examples":{"Create a new sync agent":{"$ref":"#/components/examples/Create_a_new_sync_agent"},"Update a sync agent":{"$ref":"#/components/examples/Update_a_sync_agent"}}}}},"201":{"description":"Successfully created the sync agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAgent"},"examples":{"Create a new sync agent":{"$ref":"#/components/examples/Create_a_new_sync_agent"},"Update a sync agent":{"$ref":"#/components/examples/Update_a_sync_agent"}}}}},"202":{"description":"Creating or updating the sync agent is in progress."},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 CannotDeleteInUseSyncAgent - Cannot delete sync agent because it is used by sync member.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."}},"tags":["SyncAgents"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/generateKey":{"post":{"description":"Generates a sync agent key.","operationId":"SyncAgents_GenerateKey","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server on which the sync agent is hosted.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Generate a sync agent key":{"value":"syncagentcrud-8475"}}},{"description":"The name of the sync agent.","in":"path","name":"syncAgentName","required":true,"schema":{"type":"string"},"examples":{"Generate a sync agent key":{"value":"syncagentcrud-3187"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully generate a sync agent key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAgentKeyProperties"},"examples":{"Generate a sync agent key":{"$ref":"#/components/examples/Generate_a_sync_agent_key"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 CannotDeleteInUseSyncAgent - Cannot delete sync agent because it is used by sync member.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."}},"tags":["SyncAgents"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/syncAgents/{syncAgentName}/linkedDatabases":{"get":{"description":"Lists databases linked to a sync agent.","operationId":"SyncAgents_ListLinkedDatabases","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server on which the sync agent is hosted.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Get sync agent linked databases":{"value":"syncagentcrud-8475"}}},{"description":"The name of the sync agent.","in":"path","name":"syncAgentName","required":true,"schema":{"type":"string"},"examples":{"Get sync agent linked databases":{"value":"syncagentcrud-3187"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved sync agent linked SQL server databases.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAgentLinkedDatabaseListResult"},"examples":{"Get sync agent linked databases":{"$ref":"#/components/examples/Get_sync_agent_linked_databases"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidSyncGroupCreateOrUpdateRequest - The create or update sync group request body is empty.\n\n * 400 InvalidSyncMemberCreateOrUpdateRequest - The create or update sync member request body is empty.\n\n * 400 InvalidSyncAgentCreateOrUpdateRequest - The create or update sync agent request body is empty.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 InvalidSyncAgentResourceId - Invalid sync agent resource identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidSyncAgent - Sync agent is invalid.\n\n * 400 CannotDeleteInUseSyncAgent - Cannot delete sync agent because it is used by sync member.\n\n * 400 InvalidSyncMetadataDatabase - Sync metadata database is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance."}},"tags":["SyncAgents"],"x-ms-pageable":{"nextLinkName":"nextLink"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_sync_agents_under_a_server":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187","name":"syncagent","properties":{"expiryTime":"9999-12-31T23:59:59.9999999Z","isUpToDate":true,"state":"NeverConnected","syncDatabaseId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync","version":"4.2.0.0"},"type":"Microsoft.Sql/servers/syncAgents"}]}},"Get_a_sync_agent":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187","name":"syncagent","properties":{"expiryTime":"9999-12-31T23:59:59.9999999Z","isUpToDate":true,"state":"NeverConnected","syncDatabaseId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync","version":"4.2.0.0"},"type":"Microsoft.Sql/servers/syncAgents"}},"Create_a_new_sync_agent":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187","name":"syncagent","properties":{"expiryTime":"9999-12-31T23:59:59.9999999Z","isUpToDate":true,"state":"NeverConnected","syncDatabaseId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync","version":"4.2.0.0"},"type":"Microsoft.Sql/servers/syncAgents"}},"Update_a_sync_agent":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/syncAgents/syncagentcrud-3187","name":"syncagent","properties":{"expiryTime":"9999-12-31T23:59:59.9999999Z","isUpToDate":true,"state":"NeverConnected","syncDatabaseId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-Onebox/providers/Microsoft.Sql/servers/syncagentcrud-8475/databases/sync","version":"4.2.0.0"},"type":"Microsoft.Sql/servers/syncAgents"}},"Generate_a_sync_agent_key":{"value":{"syncAgentKey":"865f9998-6dae-4214-bbb1-4796b7c76ca0:0Axt2fR1GSYDQPcSbS72bYH9jzWus2Kbm1phxvCvwpH=:fU5mbtZLp387bUK8z4qOTUewbP7MuFUXoWr09xlbUCwguFCkjWWuXw6yoSCKxWRAKbB="}},"Get_sync_agent_linked_databases":{"value":{"value":[{"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","properties":{"databaseId":"55555555-6666-7777-8888-999999999999","databaseName":"DummySqlServerDb","databaseType":"SqlServerDatabase","description":"","serverName":"DummySqlServer","userName":"DummyUser"}}]}}},"parameters":{"ApiVersionParameter":{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get sync agents under a server":{"value":"2015-05-01-preview"},"Delete a sync agent":{"value":"2015-05-01-preview"},"Get a sync agent":{"value":"2015-05-01-preview"},"Create a new sync agent":{"value":"2015-05-01-preview"},"Update a sync agent":{"value":"2015-05-01-preview"},"Generate a sync agent key":{"value":"2015-05-01-preview"},"Get sync agent linked databases":{"value":"2015-05-01-preview"}}},"DatabaseNameParameter":{"description":"The name of the database.","in":"path","name":"databaseName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ResourceGroupParameter":{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get sync agents under a server":{"value":"syncagentcrud-65440"},"Delete a sync agent":{"value":"syncagentcrud-65440"},"Get a sync agent":{"value":"syncagentcrud-65440"},"Create a new sync agent":{"value":"syncagentcrud-65440"},"Update a sync agent":{"value":"syncagentcrud-65440"},"Generate a sync agent key":{"value":"syncagentcrud-65440"},"Get sync agent linked databases":{"value":"syncagentcrud-65440"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SubscriptionIdParameter":{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get sync agents under a server":{"value":"00000000-1111-2222-3333-444444444444"},"Delete a sync agent":{"value":"00000000-1111-2222-3333-444444444444"},"Get a sync agent":{"value":"00000000-1111-2222-3333-444444444444"},"Create a new sync agent":{"value":"00000000-1111-2222-3333-444444444444"},"Update a sync agent":{"value":"00000000-1111-2222-3333-444444444444"},"Generate a sync agent key":{"value":"00000000-1111-2222-3333-444444444444"},"Get sync agent linked databases":{"value":"00000000-1111-2222-3333-444444444444"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"SyncAgent":{"allOf":[{"allOf":[{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"An Azure SQL Database sync agent.","properties":{"properties":{"$ref":"#/components/schemas/SyncAgentProperties"}},"type":"object"},"SyncAgentKeyProperties":{"description":"Properties of an Azure SQL Database sync agent key.","properties":{"syncAgentKey":{"description":"Key of sync agent.","readOnly":true,"type":"string"}},"type":"object"},"SyncAgentLinkedDatabase":{"allOf":[{"allOf":[{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"An Azure SQL Database sync agent linked database.","properties":{"properties":{"$ref":"#/components/schemas/SyncAgentLinkedDatabaseProperties"}},"type":"object"},"SyncAgentLinkedDatabaseListResult":{"description":"A list of sync agent linked databases.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/SyncAgentLinkedDatabase"},"readOnly":true,"type":"array"}},"type":"object"},"SyncAgentLinkedDatabaseProperties":{"description":"Properties of an Azure SQL Database sync agent linked database.","properties":{"databaseId":{"description":"Id of the sync agent linked database.","readOnly":true,"type":"string"},"databaseName":{"description":"Database name of the sync agent linked database.","readOnly":true,"type":"string"},"databaseType":{"description":"Type of the sync agent linked database.","enum":["AzureSqlDatabase","SqlServerDatabase"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"SyncMemberDbType"}},"description":{"description":"Description of the sync agent linked database.","readOnly":true,"type":"string"},"serverName":{"description":"Server name of the sync agent linked database.","readOnly":true,"type":"string"},"userName":{"description":"User name of the sync agent linked database.","readOnly":true,"type":"string"}},"type":"object"},"SyncAgentListResult":{"description":"A list of sync agents.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/SyncAgent"},"readOnly":true,"type":"array"}},"type":"object"},"SyncAgentProperties":{"description":"Properties of an Azure SQL Database sync agent.","properties":{"expiryTime":{"description":"Expiration time of the sync agent version.","format":"date-time","readOnly":true,"type":"string"},"isUpToDate":{"description":"If the sync agent version is up to date.","readOnly":true,"type":"boolean"},"lastAliveTime":{"description":"Last alive time of the sync agent.","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"Name of the sync agent.","readOnly":true,"type":"string"},"state":{"description":"State of the sync agent.","enum":["Online","Offline","NeverConnected"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"SyncAgentState"}},"syncDatabaseId":{"description":"ARM resource id of the sync database in the sync agent.","type":"string"},"version":{"description":"Version of the sync agent.","readOnly":true,"type":"string"}},"type":"object"}}}}