pipelines

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

Overview

Name	pipelines
Type	Resource
Id	azure.data_transfer.pipelines

Fields

vw_pipelines

Name	Datatype	Description
connections	text	field from the properties object
display_name	text	field from the properties object
flow_types	text	field from the properties object
location	text	The geo-location where the resource lives
pipelineName	text	field from the properties object
policies	text	field from the properties object
provisioning_state	text	field from the properties object
remote_cloud	text	field from the properties object
resourceGroupName	text	field from the properties object
subscribers	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

pipelines

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	pipelineName, resourceGroupName, subscriptionId	Gets pipeline resource.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets pipelines in a resource group.
list_by_subscription	SELECT	subscriptionId	Gets pipelines in a subscription.
create_or_update	INSERT	pipelineName, resourceGroupName, subscriptionId, data__location	Creates or updates the pipeline resource.
delete	DELETE	pipelineName, resourceGroupName, subscriptionId	Deletes the pipeline resource.
update	UPDATE	pipelineName, resourceGroupName, subscriptionId	Updates the pipeline resource.
approve_connection	EXEC	pipelineName, resourceGroupName, subscriptionId, data__id	Approves the specified connection in a pipeline.
reject_connection	EXEC	pipelineName, resourceGroupName, subscriptionId, data__id	Rejects the specified connection in a pipeline.

SELECT examples

Gets pipelines in a subscription.

vw_pipelines

SELECT
connections,
display_name,
flow_types,
location,
pipelineName,
policies,
provisioning_state,
remote_cloud,
resourceGroupName,
subscribers,
subscriptionId,
tags
FROM azure.data_transfer.vw_pipelines
WHERE subscriptionId = '{{ subscriptionId }}';

pipelines

SELECT
location,
properties,
tags
FROM azure.data_transfer.pipelines
WHERE 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_transfer.pipelines (
pipelineName,
resourceGroupName,
subscriptionId,
data__location,
properties,
tags,
location
)
SELECT 
'{{ pipelineName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: remoteCloud
          value: string
        - name: displayName
          value: string
        - name: connections
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: location
                value: string
              - name: etag
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
              - name: properties
                value:
                  - name: internalMetadata
                    value:
                      - name: operationStatus
                        value:
                          - name: status
                            value: string
                          - name: id
                            value: string
                          - name: message
                            value: string
                      - name: statusSetBy
                        value: string
        - name: subscribers
          value:
            - - name: email
                value: string
              - name: notifications
                value: integer
        - name: provisioningState
          value: string
        - name: policies
          value:
            - string
        - name: flowTypes
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a pipelines resource.

/*+ update */
UPDATE azure.data_transfer.pipelines
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
pipelineName = '{{ pipelineName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified pipelines resource.

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