sync_agents_linked_databases

Creates, updates, deletes, gets or lists a sync_agents_linked_databases resource.

Overview

Name	sync_agents_linked_databases
Type	Resource
Id	azure.sql.sync_agents_linked_databases

Fields

The following fields are returned by SELECT queries:

list

Successfully retrieved sync agent linked SQL server databases.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, serverName, syncAgentName, subscriptionId		Lists databases linked to a sync agent.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server on which the sync agent is hosted.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
syncAgentName	string	The name of the sync agent.

SELECT examples

list

Lists databases linked to a sync agent.

SELECT
properties
FROM azure.sql.sync_agents_linked_databases
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND syncAgentName = '{{ syncAgentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;