sync_members

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

Overview

Name	sync_members
Type	Resource
Id	azure.sql.sync_members

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified sync member.

Name	Datatype	Description
properties	object	Resource properties.

list_by_sync_group

Successfully retrieved the list of sync members.

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, databaseName, syncGroupName, syncMemberName, subscriptionId		Gets a sync member.
list_by_sync_group	select	resourceGroupName, serverName, databaseName, syncGroupName, subscriptionId		Lists sync members in the given sync group.
create_or_update	insert	resourceGroupName, serverName, databaseName, syncGroupName, syncMemberName, subscriptionId		Creates or updates a sync member.
update	update	resourceGroupName, serverName, databaseName, syncGroupName, syncMemberName, subscriptionId		Updates an existing sync member.
delete	delete	resourceGroupName, serverName, databaseName, syncGroupName, syncMemberName, subscriptionId		Deletes a sync member.
refresh_member_schema	exec	resourceGroupName, serverName, databaseName, syncGroupName, syncMemberName, subscriptionId		Refreshes a sync member database schema.

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 on which the sync member is hosted.
syncMemberName	string	The name of the sync member.

SELECT examples

get

Gets a sync member.

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

list_by_sync_group

Lists sync members in the given sync group.

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

INSERT examples

create_or_update

Creates or updates a sync member.

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

Manifest

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

UPDATE examples

update

Updates an existing sync member.

UPDATE azure.sql.sync_members
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND syncGroupName = '{{ syncGroupName }}' --required
AND syncMemberName = '{{ syncMemberName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes a sync member.

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

Lifecycle Methods

refresh_member_schema

Refreshes a sync member database schema.

EXEC azure.sql.sync_members.refresh_member_schema 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@syncMemberName='{{ syncMemberName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;