sync_groups

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

Overview

Name	sync_groups
Type	Resource
Id	azure.sql.sync_groups

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified sync group.

Name	Datatype	Description
properties	object	Resource properties.
sku	object	An ARM Resource SKU.

list_by_database

Successfully retrieved the list of sync groups.

Name	Datatype	Description
properties	object	Resource properties.
sku	object	An ARM Resource SKU.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, syncGroupName, subscriptionId		Gets a sync group.
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		Lists sync groups under a hub database.
create_or_update	insert	resourceGroupName, serverName, databaseName, syncGroupName, subscriptionId		Creates or updates a sync group.
update	update	resourceGroupName, serverName, databaseName, syncGroupName, subscriptionId		Updates a sync group.
delete	delete	resourceGroupName, serverName, databaseName, syncGroupName, subscriptionId		Deletes a sync group.
refresh_hub_schema	exec	resourceGroupName, serverName, databaseName, syncGroupName, subscriptionId		Refreshes a hub database schema.
cancel_sync	exec	resourceGroupName, serverName, databaseName, syncGroupName, subscriptionId		Cancels a sync group synchronization.
trigger_sync	exec	resourceGroupName, serverName, databaseName, syncGroupName, subscriptionId		Triggers a sync group synchronization.

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
databaseName	string	The name of the database on which the sync group is hosted.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
syncGroupName	string	The name of the sync group.

SELECT examples

get

Gets a sync group.

SELECT
properties,
sku
FROM azure.sql.sync_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND syncGroupName = '{{ syncGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

Lists sync groups under a hub database.

SELECT
properties,
sku
FROM azure.sql.sync_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a sync group.

INSERT INTO azure.sql.sync_groups (
data__sku,
data__properties,
resourceGroupName,
serverName,
databaseName,
syncGroupName,
subscriptionId
)
SELECT 
'{{ sku }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ syncGroupName }}',
'{{ subscriptionId }}'
RETURNING
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: sync_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sync_groups resource.
    - name: serverName
      value: string
      description: Required parameter for the sync_groups resource.
    - name: databaseName
      value: string
      description: Required parameter for the sync_groups resource.
    - name: syncGroupName
      value: string
      description: Required parameter for the sync_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the sync_groups resource.
    - name: sku
      value: object
      description: |
        An ARM Resource SKU.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates a sync group.

UPDATE azure.sql.sync_groups
SET 
data__sku = '{{ sku }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND syncGroupName = '{{ syncGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties,
sku;

DELETE examples

delete

Deletes a sync group.

DELETE FROM azure.sql.sync_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND syncGroupName = '{{ syncGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

refresh_hub_schema

Refreshes a hub database schema.

EXEC azure.sql.sync_groups.refresh_hub_schema 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

cancel_sync

Cancels a sync group synchronization.

EXEC azure.sql.sync_groups.cancel_sync 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

trigger_sync

Triggers a sync group synchronization.

EXEC azure.sql.sync_groups.trigger_sync 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;