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

The following fields are returned by SELECT queries:

get

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.
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	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
parameters	object	Parameters for linked service.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
version	string	Version of the linked service.

list_by_factory

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.
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	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
parameters	object	Parameters for linked service.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	select	resource_group_name, factory_name, linked_service_name, subscription_id		Gets a linked service.
list_by_factory	select	resource_group_name, factory_name, subscription_id		Lists linked services.
create_or_update	insert	resource_group_name, factory_name, linked_service_name, subscription_id, properties		Creates or updates a linked service.
create_or_update	replace	resource_group_name, factory_name, linked_service_name, subscription_id, properties		Creates or updates a linked service.
delete	delete	resource_group_name, factory_name, linked_service_name, subscription_id		Deletes 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
factory_name	string	The factory name. Required.
linked_service_name	string	The linked service name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a linked service.

SELECT
id,
name,
annotations,
connectVia,
description,
etag,
parameters,
systemData,
type,
version
FROM azure.data_factory.linked_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND linked_service_name = '{{ linked_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_factory

Lists linked services.

SELECT
id,
name,
annotations,
connectVia,
description,
etag,
parameters,
systemData,
type,
version
FROM azure.data_factory.linked_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a linked service.

INSERT INTO azure.data_factory.linked_services (
properties,
resource_group_name,
factory_name,
linked_service_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ linked_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: linked_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the linked_services resource.
  - name: factory_name
    value: "{{ factory_name }}"
    description: Required parameter for the linked_services resource.
  - name: linked_service_name
    value: "{{ linked_service_name }}"
    description: Required parameter for the linked_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the linked_services resource.
  - name: properties
    description: |
      Properties of linked service. Required.
    value:
      type: "{{ type }}"
      version: "{{ version }}"
      connectVia:
        type: "{{ type }}"
        referenceName: "{{ referenceName }}"
        parameters: "{{ parameters }}"
      description: "{{ description }}"
      parameters: "{{ parameters }}"
      annotations: "{{ annotations }}"

REPLACE examples

create_or_update

Creates or updates a linked service.

REPLACE azure.data_factory.linked_services
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND linked_service_name = '{{ linked_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a linked service.

DELETE FROM azure.data_factory.linked_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND linked_service_name = '{{ linked_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;