linked_service

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

Overview

Name	linked_service
Type	Resource
Id	azure.synapse_artifacts.linked_service

Fields

The following fields are returned by SELECT queries:

get_linked_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
	object	Unmatched properties from the message are deserialized to this collection.
annotations	array	List of tags that can be used for describing the linked service.
connectVia	object	The integration runtime reference.
description	string	Linked service description.
etag	string	Resource Etag.
parameters	object	Parameters for linked service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the linked service.

get_linked_services_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
	object	Unmatched properties from the message are deserialized to this collection.
annotations	array	List of tags that can be used for describing the linked service.
connectVia	object	The integration runtime reference.
description	string	Linked service description.
etag	string	Resource Etag.
parameters	object	Parameters for linked service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the linked service.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_linked_service	select	linked_service_name, endpoint	If-None-Match	Gets a linked service.
get_linked_services_by_workspace	select	endpoint		Lists linked services.
create_or_update_linked_service	insert	linked_service_name, endpoint, type	If-Match	Creates or updates a linked service.
create_or_update_linked_service	replace	linked_service_name, endpoint, type	If-Match	Creates or updates a linked service.
delete_linked_service	delete	linked_service_name, endpoint		Deletes a linked service.
rename_linked_service	exec	linked_service_name, endpoint		Renames a linked service.

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: )
linked_service_name	string	The linked service name. Required.
If-Match	string	ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.
If-None-Match	string	ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

SELECT examples

get_linked_service

Gets a linked service.

SELECT
id,
name,
,
annotations,
connectVia,
description,
etag,
parameters,
type,
version
FROM azure.synapse_artifacts.linked_service
WHERE linked_service_name = '{{ linked_service_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
;

get_linked_services_by_workspace

Lists linked services.

SELECT
id,
name,
,
annotations,
connectVia,
description,
etag,
parameters,
type,
version
FROM azure.synapse_artifacts.linked_service
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_linked_service

Creates or updates a linked service.

INSERT INTO azure.synapse_artifacts.linked_service (
,
type,
version,
connectVia,
description,
parameters,
annotations,
linked_service_name,
endpoint,
If-Match
)
SELECT 
'{{  }}',
'{{ type }}' /* required */,
'{{ version }}',
'{{ connectVia }}',
'{{ description }}',
'{{ parameters }}',
'{{ annotations }}',
'{{ linked_service_name }}',
'{{ endpoint }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: linked_service
props:
  - name: linked_service_name
    value: "{{ linked_service_name }}"
    description: Required parameter for the linked_service resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the linked_service resource.
  - name: 
    value: "{{  }}"
    description: |
      Unmatched properties from the message are deserialized to this collection.
  - name: type
    value: "{{ type }}"
    description: |
      Type of linked service. Required.
  - name: version
    value: "{{ version }}"
    description: |
      Version of the linked service.
  - name: connectVia
    description: |
      The integration runtime reference.
    value:
      type: "{{ type }}"
      referenceName: "{{ referenceName }}"
      parameters: "{{ parameters }}"
  - name: description
    value: "{{ description }}"
    description: |
      Linked service description.
  - name: parameters
    value: "{{ parameters }}"
    description: |
      Parameters for linked service.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      List of tags that can be used for describing the linked service.
  - name: If-Match
    value: "{{ If-Match }}"
    description: ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.
    description: ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

REPLACE examples

create_or_update_linked_service

Creates or updates a linked service.

REPLACE azure.synapse_artifacts.linked_service
SET 
 = '{{  }}',
type = '{{ type }}',
version = '{{ version }}',
connectVia = '{{ connectVia }}',
description = '{{ description }}',
parameters = '{{ parameters }}',
annotations = '{{ annotations }}'
WHERE 
linked_service_name = '{{ linked_service_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND type = '{{ type }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete_linked_service

Deletes a linked service.

DELETE FROM azure.synapse_artifacts.linked_service
WHERE linked_service_name = '{{ linked_service_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

rename_linked_service

Renames a linked service.

EXEC azure.synapse_artifacts.linked_service.rename_linked_service 
@linked_service_name='{{ linked_service_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;