pipelines

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

Overview

Name	pipelines
Type	Resource
Id	azure.data_transfer.pipelines

Fields

The following fields are returned by SELECT queries:

get

Retrieved the pipelines resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of pipeline
tags	object	Resource tags.

list_by_resource_group

Listed all pipelines under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of pipeline
tags	object	Resource tags.

list_by_subscription

Listed all pipelines under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of pipeline
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, pipelineName		Gets pipeline resource.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets pipelines in a resource group.
list_by_subscription	select	subscriptionId		Gets pipelines in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, pipelineName, data__location		Creates or updates the pipeline resource.
update	update	subscriptionId, resourceGroupName, pipelineName		Updates the pipeline resource.
delete	delete	subscriptionId, resourceGroupName, pipelineName		Deletes the pipeline resource.
approve_connection	exec	subscriptionId, resourceGroupName, pipelineName, id		Approves the specified connection in a pipeline.
reject_connection	exec	subscriptionId, resourceGroupName, pipelineName, id		Rejects the specified connection in 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
pipelineName	string	The name for the pipeline that is to be requested.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets pipeline resource.

SELECT
location,
properties,
tags
FROM azure.data_transfer.pipelines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND pipelineName = '{{ pipelineName }}' -- required
;

list_by_resource_group

Gets pipelines in a resource group.

SELECT
location,
properties,
tags
FROM azure.data_transfer.pipelines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Gets pipelines in a subscription.

SELECT
location,
properties,
tags
FROM azure.data_transfer.pipelines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the pipeline resource.

INSERT INTO azure.data_transfer.pipelines (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
pipelineName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ pipelineName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: pipelines
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the pipelines resource.
    - name: resourceGroupName
      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 pipeline
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates the pipeline resource.

UPDATE azure.data_transfer.pipelines
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND pipelineName = '{{ pipelineName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes the pipeline resource.

DELETE FROM azure.data_transfer.pipelines
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND pipelineName = '{{ pipelineName }}' --required
;

Lifecycle Methods

approve_connection

Approves the specified connection in a pipeline.

EXEC azure.data_transfer.pipelines.approve_connection 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@pipelineName='{{ pipelineName }}' --required 
@@json=
'{
"id": "{{ id }}", 
"statusReason": "{{ statusReason }}"
}'
;

reject_connection

Rejects the specified connection in a pipeline.

EXEC azure.data_transfer.pipelines.reject_connection 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@pipelineName='{{ pipelineName }}' --required 
@@json=
'{
"id": "{{ id }}", 
"statusReason": "{{ statusReason }}"
}'
;