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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
expiryTime	string (date-time)	Expiration time of the sync agent version.
isUpToDate	boolean	If the sync agent version is up to date.
lastAliveTime	string (date-time)	Last alive time of the sync agent.
state	string	State of the sync agent. Known values are: "Online", "Offline", and "NeverConnected". (Online, Offline, NeverConnected)
syncDatabaseId	string	ARM resource id of the sync database in the sync agent.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the sync agent.

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
expiryTime	string (date-time)	Expiration time of the sync agent version.
isUpToDate	boolean	If the sync agent version is up to date.
lastAliveTime	string (date-time)	Last alive time of the sync agent.
state	string	State of the sync agent. Known values are: "Online", "Offline", and "NeverConnected". (Online, Offline, NeverConnected)
syncDatabaseId	string	ARM resource id of the sync database in the sync agent.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the sync agent.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, sync_agent_name, subscription_id		Gets a sync agent.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists sync agents in a server.
create_or_update	insert	resource_group_name, server_name, sync_agent_name, subscription_id		Creates or updates a sync agent.
create_or_update	replace	resource_group_name, server_name, sync_agent_name, subscription_id		Creates or updates a sync agent.
delete	delete	resource_group_name, server_name, sync_agent_name, subscription_id		Deletes a sync agent.
list_linked_databases	exec	resource_group_name, server_name, sync_agent_name, subscription_id		Lists databases linked to a sync agent.
generate_key	exec	resource_group_name, server_name, sync_agent_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string
sync_agent_name	string	The name of the sync agent. Required.

SELECT examples

get

Gets a sync agent.

SELECT
id,
name,
expiryTime,
isUpToDate,
lastAliveTime,
state,
syncDatabaseId,
systemData,
type,
version
FROM azure.sql.sync_agents
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND sync_agent_name = '{{ sync_agent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists sync agents in a server.

SELECT
id,
name,
expiryTime,
isUpToDate,
lastAliveTime,
state,
syncDatabaseId,
systemData,
type,
version
FROM azure.sql.sync_agents
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a sync agent.

INSERT INTO azure.sql.sync_agents (
properties,
resource_group_name,
server_name,
sync_agent_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ sync_agent_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sync_agents
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sync_agents resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the sync_agents resource.
  - name: sync_agent_name
    value: "{{ sync_agent_name }}"
    description: Required parameter for the sync_agents resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sync_agents resource.
  - name: properties
    description: |
      Resource properties.
    value:
      name: "{{ name }}"
      syncDatabaseId: "{{ syncDatabaseId }}"
      lastAliveTime: "{{ lastAliveTime }}"
      state: "{{ state }}"
      isUpToDate: {{ isUpToDate }}
      expiryTime: "{{ expiryTime }}"
      version: "{{ version }}"

REPLACE examples

create_or_update

Creates or updates a sync agent.

REPLACE azure.sql.sync_agents
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND sync_agent_name = '{{ sync_agent_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a sync agent.

DELETE FROM azure.sql.sync_agents
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND sync_agent_name = '{{ sync_agent_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_linked_databases

Lists databases linked to a sync agent.

EXEC azure.sql.sync_agents.list_linked_databases 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@sync_agent_name='{{ sync_agent_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

generate_key

Generates a sync agent key.

EXEC azure.sql.sync_agents.generate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@sync_agent_name='{{ sync_agent_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;