link_connection

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

Overview

Name	link_connection
Type	Resource
Id	azure.synapse_artifacts.link_connection

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Link connection id.
name	string	Link connection name.
compute	object	Properties of link connection's compute.
description	string	Link connection description.
landingZone	object	Properties of link connection's landing zone.
sourceDatabase	object	Properties of link connection's source database.
targetDatabase	object	Properties of link connection's target database.
type	string	Link connection type.

list_by_workspace

Name	Datatype	Description
id	string	Link connection id.
name	string	Link connection name.
compute	object	Properties of link connection's compute.
description	string	Link connection description.
landingZone	object	Properties of link connection's landing zone.
sourceDatabase	object	Properties of link connection's source database.
targetDatabase	object	Properties of link connection's target database.
type	string	Link connection type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	link_connection_name, endpoint		Get a link connection.
list_by_workspace	select	endpoint		List link connections.
create_or_update	insert	link_connection_name, endpoint, properties		Creates or updates a link connection.
create_or_update	replace	link_connection_name, endpoint, properties		Creates or updates a link connection.
delete	delete	link_connection_name, endpoint		Delete a link connection.
list_link_tables	exec	link_connection_name, endpoint		List the link tables of a link connection.
get_detailed_status	exec	link_connection_name, endpoint		Get the detailed status of a link connection.
edit_tables	exec	link_connection_name, endpoint		Edit tables for a link connection.
start	exec	link_connection_name, endpoint		Start a link connection. It may take a few minutes from Starting to Running, monitor the status with LinkConnection_GetDetailedStatus.
stop	exec	link_connection_name, endpoint		Stop a link connection. It may take a few minutes from Stopping to stopped, monitor the status with LinkConnection_GetDetailedStatus.
query_table_status	exec	link_connection_name, endpoint		Query the link table status of a link connection.
update_landing_zone_credential	exec	link_connection_name, endpoint, type, value		Update landing zone credential of a link connection.
pause	exec	link_connection_name, endpoint		Pause a link connection. It may take a few minutes from Pausing to Paused, monitor the status with LinkConnection_GetDetailedStatus.
resume	exec	link_connection_name, endpoint		Resume a link connection. It may take a few minutes from Resuming to Running, monitor the status with LinkConnection_GetDetailedStatus.

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
endpoint	string	The service endpoint host (no scheme). (default: )
link_connection_name	string	The link connection name. Required.

SELECT examples

get

Get a link connection.

SELECT
id,
name,
compute,
description,
landingZone,
sourceDatabase,
targetDatabase,
type
FROM azure.synapse_artifacts.link_connection
WHERE link_connection_name = '{{ link_connection_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_by_workspace

List link connections.

SELECT
id,
name,
compute,
description,
landingZone,
sourceDatabase,
targetDatabase,
type
FROM azure.synapse_artifacts.link_connection
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update

Creates or updates a link connection.

INSERT INTO azure.synapse_artifacts.link_connection (
id,
name,
type,
properties,
description,
link_connection_name,
endpoint
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ type }}',
'{{ properties }}' /* required */,
'{{ description }}',
'{{ link_connection_name }}',
'{{ endpoint }}'
RETURNING
id,
name,
description,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: link_connection
props:
  - name: link_connection_name
    value: "{{ link_connection_name }}"
    description: Required parameter for the link_connection resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the link_connection resource.
  - name: id
    value: "{{ id }}"
    description: |
      Link connection id.
  - name: name
    value: "{{ name }}"
    description: |
      Link connection name.
  - name: type
    value: "{{ type }}"
    description: |
      Link connection type.
  - name: properties
    description: |
      Properties of link connection. Required.
    value:
      sourceDatabase:
        linkedService:
          type: "{{ type }}"
          referenceName: "{{ referenceName }}"
          parameters: "{{ parameters }}"
        typeProperties:
          resourceId: "{{ resourceId }}"
          principalId: "{{ principalId }}"
      targetDatabase:
        linkedService:
          type: "{{ type }}"
          referenceName: "{{ referenceName }}"
          parameters: "{{ parameters }}"
        typeProperties:
          crossTableTransaction: {{ crossTableTransaction }}
          dropExistingTargetTableOnStart: {{ dropExistingTargetTableOnStart }}
          actionOnExistingTargetTable: "{{ actionOnExistingTargetTable }}"
      landingZone:
        linkedService:
          type: "{{ type }}"
          referenceName: "{{ referenceName }}"
          parameters: "{{ parameters }}"
        fileSystem: "{{ fileSystem }}"
        folderPath: "{{ folderPath }}"
        sasToken:
          type: "{{ type }}"
          value: "{{ value }}"
      compute:
        coreCount: {{ coreCount }}
        computeType: "{{ computeType }}"
        dataProcessIntervalMinutes: {{ dataProcessIntervalMinutes }}
  - name: description
    value: "{{ description }}"
    description: |
      Link connection description.

REPLACE examples

create_or_update

Creates or updates a link connection.

REPLACE azure.synapse_artifacts.link_connection
SET 
id = '{{ id }}',
name = '{{ name }}',
type = '{{ type }}',
properties = '{{ properties }}',
description = '{{ description }}'
WHERE 
link_connection_name = '{{ link_connection_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
description,
properties,
type;

DELETE examples

delete

Delete a link connection.

DELETE FROM azure.synapse_artifacts.link_connection
WHERE link_connection_name = '{{ link_connection_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

list_link_tables

List the link tables of a link connection.

EXEC azure.synapse_artifacts.link_connection.list_link_tables 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_detailed_status

Get the detailed status of a link connection.

EXEC azure.synapse_artifacts.link_connection.get_detailed_status 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

edit_tables

Edit tables for a link connection.

EXEC azure.synapse_artifacts.link_connection.edit_tables 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"id": "{{ id }}", 
"source": "{{ source }}", 
"target": "{{ target }}", 
"operationType": "{{ operationType }}"
}'
;

start

Start a link connection. It may take a few minutes from Starting to Running, monitor the status with LinkConnection_GetDetailedStatus.

EXEC azure.synapse_artifacts.link_connection.start 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

stop

Stop a link connection. It may take a few minutes from Stopping to stopped, monitor the status with LinkConnection_GetDetailedStatus.

EXEC azure.synapse_artifacts.link_connection.stop 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

query_table_status

Query the link table status of a link connection.

EXEC azure.synapse_artifacts.link_connection.query_table_status 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"maxSegmentCount": {{ maxSegmentCount }}, 
"continuationToken": "{{ continuationToken }}"
}'
;

update_landing_zone_credential

Update landing zone credential of a link connection.

EXEC azure.synapse_artifacts.link_connection.update_landing_zone_credential 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"type": "{{ type }}", 
"value": "{{ value }}"
}'
;

pause

Pause a link connection. It may take a few minutes from Pausing to Paused, monitor the status with LinkConnection_GetDetailedStatus.

EXEC azure.synapse_artifacts.link_connection.pause 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

resume

Resume a link connection. It may take a few minutes from Resuming to Running, monitor the status with LinkConnection_GetDetailedStatus.

EXEC azure.synapse_artifacts.link_connection.resume 
@link_connection_name='{{ link_connection_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;