linked_services

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

Overview

Name	linked_services
Type	Resource
Id	azure.data_factory.linked_services

Fields

vw_linked_services

Name	Datatype	Description
id	text	The resource identifier.
name	text	The resource name.
description	text	field from the properties object
annotations	text	field from the properties object
connect_via	text	field from the properties object
etag	text	Etag identifies change in the resource.
factoryName	text	field from the properties object
linkedServiceName	text	field from the properties object
parameters	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The resource type.
version	text	field from the properties object

linked_services

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	The nested object which contains the information and credential which can be used to connect with related store or compute resource.
type	string	The resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	factoryName, linkedServiceName, resourceGroupName, subscriptionId	Gets a linked service.
list_by_factory	SELECT	factoryName, resourceGroupName, subscriptionId	Lists linked services.
create_or_update	INSERT	factoryName, linkedServiceName, resourceGroupName, subscriptionId, data__properties	Creates or updates a linked service.
delete	DELETE	factoryName, linkedServiceName, resourceGroupName, subscriptionId	Deletes a linked service.

SELECT examples

Lists linked services.

vw_linked_services

SELECT
id,
name,
description,
annotations,
connect_via,
etag,
factoryName,
linkedServiceName,
parameters,
resourceGroupName,
subscriptionId,
type,
version
FROM azure.data_factory.vw_linked_services
WHERE factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

linked_services

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.linked_services
WHERE factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new linked_services resource.

All Properties

/*+ create */
INSERT INTO azure.data_factory.linked_services (
factoryName,
linkedServiceName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ factoryName }}',
'{{ linkedServiceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: etag
      value: string
    - name: properties
      value:
        - name: type
          value: string
        - name: version
          value: string
        - name: connectVia
          value:
            - name: type
              value: string
            - name: referenceName
              value: string
            - name: parameters
              value: []
        - name: description
          value: string
        - name: parameters
          value: []
        - name: annotations
          value:
            - object

DELETE example

Deletes the specified linked_services resource.

/*+ delete */
DELETE FROM azure.data_factory.linked_services
WHERE factoryName = '{{ factoryName }}'
AND linkedServiceName = '{{ linkedServiceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';