pipelines

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

Overview

Name	pipelines
Type	Resource
Id	azure.data_factory.pipelines

Fields

The following fields are returned by SELECT queries:

get

OK.

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

list_by_factory

OK.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, factoryName, pipelineName	api-version, If-None-Match	Gets a pipeline.
list_by_factory	select	subscriptionId, resourceGroupName, factoryName	api-version	Lists pipelines.
create_or_update	insert	subscriptionId, resourceGroupName, factoryName, pipelineName, data__properties	api-version, If-Match	Creates or updates a pipeline.
delete	delete	subscriptionId, resourceGroupName, factoryName, pipelineName	api-version	Deletes 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
factoryName	string	The factory name.
pipelineName	string	The pipeline name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
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.
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.
api-version	string	The API version.

SELECT examples

get

Gets a pipeline.

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.pipelines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND pipelineName = '{{ pipelineName }}' -- required
AND api-version = '{{ api-version }}'
AND If-None-Match = '{{ If-None-Match }}'
;

list_by_factory

Lists pipelines.

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

INSERT examples

create_or_update

Creates or updates a pipeline.

INSERT INTO azure.data_factory.pipelines (
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
pipelineName,
api-version,
If-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ pipelineName }}',
'{{ api-version }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: pipelines
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the pipelines resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the pipelines resource.
    - name: factoryName
      value: string
      description: Required parameter for the pipelines resource.
    - name: pipelineName
      value: string
      description: Required parameter for the pipelines resource.
    - name: properties
      value: object
      description: |
        Properties of the pipeline.
    - name: api-version
      value: string
      description: The API version.
    - name: If-Match
      value: string
      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.

DELETE examples

delete

Deletes a pipeline.

DELETE FROM azure.data_factory.pipelines
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND factoryName = '{{ factoryName }}' --required
AND pipelineName = '{{ pipelineName }}' --required
AND api-version = '{{ api-version }}'
;