sync_agents

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

Overview

Name	sync_agents
Type	Resource
Id	azure.sql.sync_agents

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified sync agent.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of sync agents.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, syncAgentName, subscriptionId		Gets a sync agent.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Lists sync agents in a server.
create_or_update	insert	resourceGroupName, serverName, syncAgentName, subscriptionId		Creates or updates a sync agent.
delete	delete	resourceGroupName, serverName, syncAgentName, subscriptionId		Deletes a sync agent.
generate_key	exec	resourceGroupName, serverName, syncAgentName, subscriptionId		Generates a sync agent key.

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

get

Gets a sync agent.

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

list_by_server

Lists sync agents in a server.

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

INSERT examples

create_or_update

Creates or updates a sync agent.

INSERT INTO azure.sql.sync_agents (
data__properties,
resourceGroupName,
serverName,
syncAgentName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ syncAgentName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sync_agents
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sync_agents resource.
    - name: serverName
      value: string
      description: Required parameter for the sync_agents resource.
    - name: syncAgentName
      value: string
      description: Required parameter for the sync_agents resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the sync_agents resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a sync agent.

DELETE FROM azure.sql.sync_agents
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND syncAgentName = '{{ syncAgentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

generate_key

Generates a sync agent key.

EXEC azure.sql.sync_agents.generate_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@syncAgentName='{{ syncAgentName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;