sql_pool_replication_links

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

Overview

Name	sql_pool_replication_links
Type	Resource
Id	azure.synapse.sql_pool_replication_links

Fields

The following fields are returned by SELECT queries:

get_by_name

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.
isTerminationAllowed	boolean	Legacy value indicating whether termination is allowed. Currently always returns true.
location	string	Location of the workspace that contains this firewall rule.
partnerDatabase	string	The name of the partner Sql pool.
partnerLocation	string	The Azure Region of the partner Sql pool.
partnerRole	string	The role of the partner Sql pool in the replication link. Known values are: "Primary", "Secondary", "NonReadableSecondary", "Source", and "Copy".
partnerServer	string	The name of the workspace hosting the partner Sql pool.
percentComplete	integer	The percentage of seeding complete for the replication link.
replicationMode	string	Replication mode of this replication link.
replicationState	string	The replication state for the replication link. Known values are: "PENDING", "SEEDING", "CATCH_UP", and "SUSPENDED".
role	string	The role of the Sql pool in the replication link. Known values are: "Primary", "Secondary", "NonReadableSecondary", "Source", and "Copy".
startTime	string (date-time)	The start time for the replication link.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
isTerminationAllowed	boolean	Legacy value indicating whether termination is allowed. Currently always returns true.
location	string	Location of the workspace that contains this firewall rule.
partnerDatabase	string	The name of the partner Sql pool.
partnerLocation	string	The Azure Region of the partner Sql pool.
partnerRole	string	The role of the partner Sql pool in the replication link. Known values are: "Primary", "Secondary", "NonReadableSecondary", "Source", and "Copy".
partnerServer	string	The name of the workspace hosting the partner Sql pool.
percentComplete	integer	The percentage of seeding complete for the replication link.
replicationMode	string	Replication mode of this replication link.
replicationState	string	The replication state for the replication link. Known values are: "PENDING", "SEEDING", "CATCH_UP", and "SUSPENDED".
role	string	The role of the Sql pool in the replication link. Known values are: "Primary", "Secondary", "NonReadableSecondary", "Source", and "Copy".
startTime	string (date-time)	The start time for the replication link.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_name	select	resource_group_name, workspace_name, sql_pool_name, link_id, subscription_id		Get SQL pool replication link by name. Get SQL pool replication link by name.
list	select	resource_group_name, workspace_name, sql_pool_name, subscription_id		Get SQL pool replication links. Lists a Sql pool's replication links.

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
link_id	string	The ID of the replication link. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get_by_name

Get SQL pool replication link by name. Get SQL pool replication link by name.

SELECT
id,
name,
isTerminationAllowed,
location,
partnerDatabase,
partnerLocation,
partnerRole,
partnerServer,
percentComplete,
replicationMode,
replicationState,
role,
startTime,
type
FROM azure.synapse.sql_pool_replication_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND link_id = '{{ link_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get SQL pool replication links. Lists a Sql pool's replication links.

SELECT
id,
name,
isTerminationAllowed,
location,
partnerDatabase,
partnerLocation,
partnerRole,
partnerServer,
percentComplete,
replicationMode,
replicationState,
role,
startTime,
type
FROM azure.synapse.sql_pool_replication_links
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;