Skip to main content

sql_pool_replication_links

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

Overview

Namesql_pool_replication_links
TypeResource
Idazure.synapse.sql_pool_replication_links

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
locationstringLocation of the workspace that contains this firewall rule.
propertiesobjectThe properties representing the resource.
typestringType of resource this is.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_by_nameselectsubscriptionId, resourceGroupName, workspaceName, sqlPoolName, linkIdGet SQL pool replication link by name.
listselectsubscriptionId, resourceGroupName, workspaceName, sqlPoolNameLists 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.

NameDatatypeDescription
linkIdstringThe ID of the replication link.
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
sqlPoolNamestringSQL pool name
subscriptionIdstringThe ID of the target subscription.
workspaceNamestringThe name of the workspace.

SELECT examples

Get SQL pool replication link by name.

SELECT
location,
properties,
type
FROM azure.synapse.sql_pool_replication_links
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND linkId = '{{ linkId }}' -- required
;