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

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.
databaseName	string	Database name of the member database in the sync member.
databaseType	string	Database type of the sync member. Known values are: "AzureSqlDatabase" and "SqlServerDatabase". (AzureSqlDatabase, SqlServerDatabase)
password	string	Password of the member database in the sync member.
privateEndpointName	string	Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
serverName	string	Server name of the member database in the sync member.
sqlServerDatabaseId	string	SQL Server database id of the sync member.
syncAgentId	string	ARM resource id of the sync agent in the sync member.
syncDirection	string	Sync direction of the sync member. Known values are: "Bidirectional", "OneWayMemberToHub", and "OneWayHubToMember". (Bidirectional, OneWayMemberToHub, OneWayHubToMember)
syncMemberAzureDatabaseResourceId	string	ARM resource id of the sync member logical database, for sync members in Azure.
syncState	string	Sync state of the sync member. Known values are: "SyncInProgress", "SyncSucceeded", "SyncFailed", "DisabledTombstoneCleanup", "DisabledBackupRestore", "SyncSucceededWithWarnings", "SyncCancelling", "SyncCancelled", "UnProvisioned", "Provisioning", "Provisioned", "ProvisionFailed", "DeProvisioning", "DeProvisioned", "DeProvisionFailed", "Reprovisioning", "ReprovisionFailed", and "UnReprovisioned". (SyncInProgress, SyncSucceeded, SyncFailed, DisabledTombstoneCleanup, DisabledBackupRestore, SyncSucceededWithWarnings, SyncCancelling, SyncCancelled, UnProvisioned, Provisioning, Provisioned, ProvisionFailed, DeProvisioning, DeProvisioned, DeProvisionFailed, Reprovisioning, ReprovisionFailed, UnReprovisioned)
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".
usePrivateLinkConnection	boolean	Whether to use private link connection.
userName	string	User name of the member database in the sync member.

list_by_sync_group

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.
databaseName	string	Database name of the member database in the sync member.
databaseType	string	Database type of the sync member. Known values are: "AzureSqlDatabase" and "SqlServerDatabase". (AzureSqlDatabase, SqlServerDatabase)
password	string	Password of the member database in the sync member.
privateEndpointName	string	Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
serverName	string	Server name of the member database in the sync member.
sqlServerDatabaseId	string	SQL Server database id of the sync member.
syncAgentId	string	ARM resource id of the sync agent in the sync member.
syncDirection	string	Sync direction of the sync member. Known values are: "Bidirectional", "OneWayMemberToHub", and "OneWayHubToMember". (Bidirectional, OneWayMemberToHub, OneWayHubToMember)
syncMemberAzureDatabaseResourceId	string	ARM resource id of the sync member logical database, for sync members in Azure.
syncState	string	Sync state of the sync member. Known values are: "SyncInProgress", "SyncSucceeded", "SyncFailed", "DisabledTombstoneCleanup", "DisabledBackupRestore", "SyncSucceededWithWarnings", "SyncCancelling", "SyncCancelled", "UnProvisioned", "Provisioning", "Provisioned", "ProvisionFailed", "DeProvisioning", "DeProvisioned", "DeProvisionFailed", "Reprovisioning", "ReprovisionFailed", and "UnReprovisioned". (SyncInProgress, SyncSucceeded, SyncFailed, DisabledTombstoneCleanup, DisabledBackupRestore, SyncSucceededWithWarnings, SyncCancelling, SyncCancelled, UnProvisioned, Provisioning, Provisioned, ProvisionFailed, DeProvisioning, DeProvisioned, DeProvisionFailed, Reprovisioning, ReprovisionFailed, UnReprovisioned)
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".
usePrivateLinkConnection	boolean	Whether to use private link connection.
userName	string	User name of the member database in the sync member.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, database_name, sync_group_name, sync_member_name, subscription_id		Gets a sync member.
list_by_sync_group	select	resource_group_name, server_name, database_name, sync_group_name, subscription_id		Lists sync members in the given sync group.
create_or_update	insert	resource_group_name, server_name, database_name, sync_group_name, sync_member_name, subscription_id		Creates or updates a sync member.
update	update	resource_group_name, server_name, database_name, sync_group_name, sync_member_name, subscription_id		Updates an existing sync member.
create_or_update	replace	resource_group_name, server_name, database_name, sync_group_name, sync_member_name, subscription_id		Creates or updates a sync member.
delete	delete	resource_group_name, server_name, database_name, sync_group_name, sync_member_name, subscription_id		Deletes a sync member.
list_member_schemas	exec	resource_group_name, server_name, database_name, sync_group_name, sync_member_name, subscription_id		Gets a sync member database schema.
refresh_member_schema	exec	resource_group_name, server_name, database_name, sync_group_name, sync_member_name, subscription_id		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
database_name	string	The name of the database. Required.
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_group_name	string	The name of the sync group. Required.
sync_member_name	string	The name of the sync member. Required.

SELECT examples

get

Gets a sync member.

SELECT
id,
name,
databaseName,
databaseType,
password,
privateEndpointName,
serverName,
sqlServerDatabaseId,
syncAgentId,
syncDirection,
syncMemberAzureDatabaseResourceId,
syncState,
systemData,
type,
usePrivateLinkConnection,
userName
FROM azure.sql.sync_members
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND sync_group_name = '{{ sync_group_name }}' -- required
AND sync_member_name = '{{ sync_member_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_sync_group

Lists sync members in the given sync group.

SELECT
id,
name,
databaseName,
databaseType,
password,
privateEndpointName,
serverName,
sqlServerDatabaseId,
syncAgentId,
syncDirection,
syncMemberAzureDatabaseResourceId,
syncState,
systemData,
type,
usePrivateLinkConnection,
userName
FROM azure.sql.sync_members
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND sync_group_name = '{{ sync_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a sync member.

INSERT INTO azure.sql.sync_members (
properties,
resource_group_name,
server_name,
database_name,
sync_group_name,
sync_member_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ sync_group_name }}',
'{{ sync_member_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sync_members
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sync_members resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the sync_members resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the sync_members resource.
  - name: sync_group_name
    value: "{{ sync_group_name }}"
    description: Required parameter for the sync_members resource.
  - name: sync_member_name
    value: "{{ sync_member_name }}"
    description: Required parameter for the sync_members resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sync_members resource.
  - name: properties
    description: |
      Resource properties.
    value:
      databaseType: "{{ databaseType }}"
      syncAgentId: "{{ syncAgentId }}"
      sqlServerDatabaseId: "{{ sqlServerDatabaseId }}"
      syncMemberAzureDatabaseResourceId: "{{ syncMemberAzureDatabaseResourceId }}"
      usePrivateLinkConnection: {{ usePrivateLinkConnection }}
      privateEndpointName: "{{ privateEndpointName }}"
      serverName: "{{ serverName }}"
      databaseName: "{{ databaseName }}"
      userName: "{{ userName }}"
      password: "{{ password }}"
      syncDirection: "{{ syncDirection }}"
      syncState: "{{ syncState }}"

UPDATE examples

update

Updates an existing sync member.

UPDATE azure.sql.sync_members
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND sync_group_name = '{{ sync_group_name }}' --required
AND sync_member_name = '{{ sync_member_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a sync member.

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

DELETE examples

delete

Deletes a sync member.

DELETE FROM azure.sql.sync_members
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND sync_group_name = '{{ sync_group_name }}' --required
AND sync_member_name = '{{ sync_member_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_member_schemas

Gets a sync member database schema.

EXEC azure.sql.sync_members.list_member_schemas 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@sync_member_name='{{ sync_member_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

refresh_member_schema

Refreshes a sync member database schema.

EXEC azure.sql.sync_members.refresh_member_schema 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@sync_member_name='{{ sync_member_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;