pipeline

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

Overview

Name	pipeline
Type	Resource
Id	azure.synapse_artifacts.pipeline

Fields

The following fields are returned by SELECT queries:

get_pipeline

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.
activities	array	List of activities in pipeline.
annotations	array	List of tags that can be used for describing the Pipeline.
concurrency	integer	The max number of concurrent runs for the pipeline.
description	string	The description of the pipeline.
etag	string	Resource Etag.
folder	object	The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.
parameters	object	List of parameters for pipeline.
runDimensions	object	Dimensions emitted by Pipeline.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
variables	object	List of variables for pipeline.

get_pipelines_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.
activities	array	List of activities in pipeline.
annotations	array	List of tags that can be used for describing the Pipeline.
concurrency	integer	The max number of concurrent runs for the pipeline.
description	string	The description of the pipeline.
etag	string	Resource Etag.
folder	object	The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.
parameters	object	List of parameters for pipeline.
runDimensions	object	Dimensions emitted by Pipeline.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
variables	object	List of variables for pipeline.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pipeline	select	pipeline_name, endpoint	If-None-Match	Gets a pipeline.
get_pipelines_by_workspace	select	endpoint		Lists pipelines.
create_or_update_pipeline	insert	pipeline_name, endpoint	If-Match	Creates or updates a pipeline.
create_or_update_pipeline	replace	pipeline_name, endpoint	If-Match	Creates or updates a pipeline.
delete_pipeline	delete	pipeline_name, endpoint		Deletes a pipeline.
rename_pipeline	exec	pipeline_name, endpoint		Renames a pipeline.
create_pipeline_run	exec	pipeline_name, endpoint	referencePipelineRunId, isRecovery, startActivityName	Creates a run of a pipeline.

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: )
pipeline_name	string	The pipeline name. Required.
If-Match	string	ETag of the pipeline 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 pipeline 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.
isRecovery	boolean	Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId. Default value is None.
referencePipelineRunId	string	The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run. Default value is None.
startActivityName	string	In recovery mode, the rerun will start from this activity. If not specified, all activities will run. Default value is None.

SELECT examples

get_pipeline

Gets a pipeline.

SELECT
id,
name,
,
activities,
annotations,
concurrency,
description,
etag,
folder,
parameters,
runDimensions,
type,
variables
FROM azure.synapse_artifacts.pipeline
WHERE pipeline_name = '{{ pipeline_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
;

get_pipelines_by_workspace

Lists pipelines.

SELECT
id,
name,
,
activities,
annotations,
concurrency,
description,
etag,
folder,
parameters,
runDimensions,
type,
variables
FROM azure.synapse_artifacts.pipeline
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_pipeline

Creates or updates a pipeline.

INSERT INTO azure.synapse_artifacts.pipeline (
,
properties,
pipeline_name,
endpoint,
If-Match
)
SELECT 
'{{  }}',
'{{ properties }}',
'{{ pipeline_name }}',
'{{ endpoint }}',
'{{ If-Match }}'
RETURNING
id,
name,
,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: pipeline
props:
  - name: pipeline_name
    value: "{{ pipeline_name }}"
    description: Required parameter for the pipeline resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the pipeline resource.
  - name: 
    value: "{{  }}"
    description: |
      Unmatched properties from the message are deserialized to this collection.
  - name: properties
    value:
      description: "{{ description }}"
      activities:
        - : "{{  }}"
          name: "{{ name }}"
          type: "{{ type }}"
          description: "{{ description }}"
          state: "{{ state }}"
          onInactiveMarkAs: "{{ onInactiveMarkAs }}"
          dependsOn: "{{ dependsOn }}"
          userProperties: "{{ userProperties }}"
      parameters: "{{ parameters }}"
      variables: "{{ variables }}"
      concurrency: {{ concurrency }}
      annotations: "{{ annotations }}"
      runDimensions: "{{ runDimensions }}"
      folder:
        name: "{{ name }}"
  - name: If-Match
    value: "{{ If-Match }}"
    description: ETag of the pipeline 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 pipeline 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_pipeline

Creates or updates a pipeline.

REPLACE azure.synapse_artifacts.pipeline
SET 
 = '{{  }}',
properties = '{{ properties }}'
WHERE 
pipeline_name = '{{ pipeline_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
,
etag,
properties,
type;

DELETE examples

delete_pipeline

Deletes a pipeline.

DELETE FROM azure.synapse_artifacts.pipeline
WHERE pipeline_name = '{{ pipeline_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

rename_pipeline

Renames a pipeline.

EXEC azure.synapse_artifacts.pipeline.rename_pipeline 
@pipeline_name='{{ pipeline_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_pipeline_run

Creates a run of a pipeline.

EXEC azure.synapse_artifacts.pipeline.create_pipeline_run 
@pipeline_name='{{ pipeline_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@referencePipelineRunId='{{ referencePipelineRunId }}', 
@isRecovery={{ isRecovery }}, 
@startActivityName='{{ startActivityName }}'
;