pipelines

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

Overview

Name	pipelines
Type	Resource
Id	azure.data_factory.pipelines

Fields

vw_pipelines

Name	Datatype	Description
id	text	The resource identifier.
name	text	The resource name.
description	text	field from the properties object
activities	text	field from the properties object
annotations	text	field from the properties object
concurrency	text	field from the properties object
etag	text	Etag identifies change in the resource.
factoryName	text	field from the properties object
folder	text	field from the properties object
parameters	text	field from the properties object
pipelineName	text	field from the properties object
policy	text	field from the properties object
resourceGroupName	text	field from the properties object
run_dimensions	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The resource type.
variables	text	field from the properties object

pipelines

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	A data factory pipeline.
type	string	The resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	factoryName, pipelineName, resourceGroupName, subscriptionId	Gets a pipeline.
list_by_factory	SELECT	factoryName, resourceGroupName, subscriptionId	Lists pipelines.
create_or_update	INSERT	factoryName, pipelineName, resourceGroupName, subscriptionId, data__properties	Creates or updates a pipeline.
delete	DELETE	factoryName, pipelineName, resourceGroupName, subscriptionId	Deletes a pipeline.

SELECT examples

Lists pipelines.

vw_pipelines

SELECT
id,
name,
description,
activities,
annotations,
concurrency,
etag,
factoryName,
folder,
parameters,
pipelineName,
policy,
resourceGroupName,
run_dimensions,
subscriptionId,
type,
variables
FROM azure.data_factory.vw_pipelines
WHERE factoryName = '{{ factoryName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

pipelines

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_factory.pipelines (
factoryName,
pipelineName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ factoryName }}',
'{{ pipelineName }}',
'{{ 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: description
          value: string
        - name: activities
          value:
            - - name: name
                value: string
              - name: type
                value: string
              - name: description
                value: string
              - name: state
                value: string
              - name: onInactiveMarkAs
                value: string
              - name: dependsOn
                value:
                  - - name: activity
                      value: string
                    - name: dependencyConditions
                      value:
                        - string
              - name: userProperties
                value:
                  - - name: name
                      value: string
                    - name: value
                      value: object
        - name: parameters
          value: []
        - name: variables
          value: []
        - name: concurrency
          value: integer
        - name: annotations
          value:
            - object
        - name: runDimensions
          value: object
        - name: folder
          value:
            - name: name
              value: string
        - name: policy
          value:
            - name: elapsedTimeMetric
              value:
                - name: duration
                  value: object

DELETE example

Deletes the specified pipelines resource.

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