pipelines

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

Overview

Name	pipelines
Type	Resource
Id	azure.iot_data_processor.pipelines

Fields

vw_pipelines

Name	Datatype	Description
description	text	field from the properties object
enabled	text	field from the properties object
extended_location	text	field from the properties object
input	text	field from the properties object
instanceName	text	field from the properties object
location	text	The geo-location where the resource lives
pipelineName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
stages	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

pipelines

Name	Datatype	Description
extendedLocation	object	Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.
location	string	The geo-location where the resource lives
properties	object	The properties of a Pipeline resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instanceName, pipelineName, resourceGroupName, subscriptionId	Get a Pipeline
create_or_update	INSERT	instanceName, pipelineName, resourceGroupName, subscriptionId, data__extendedLocation	Create a Pipeline
delete	DELETE	instanceName, pipelineName, resourceGroupName, subscriptionId	Delete a Pipeline
update	UPDATE	instanceName, pipelineName, resourceGroupName, subscriptionId	Update a Pipeline

SELECT examples

Get a Pipeline

vw_pipelines

SELECT
description,
enabled,
extended_location,
input,
instanceName,
location,
pipelineName,
provisioning_state,
resourceGroupName,
stages,
subscriptionId,
tags
FROM azure.iot_data_processor.vw_pipelines
WHERE instanceName = '{{ instanceName }}'
AND pipelineName = '{{ pipelineName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

pipelines

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.iot_data_processor.pipelines
WHERE instanceName = '{{ instanceName }}'
AND pipelineName = '{{ pipelineName }}'
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.iot_data_processor.pipelines (
instanceName,
pipelineName,
resourceGroupName,
subscriptionId,
data__extendedLocation,
properties,
extendedLocation,
tags,
location
)
SELECT 
'{{ instanceName }}',
'{{ pipelineName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__extendedLocation }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: description
          value: string
        - name: enabled
          value: boolean
        - name: input
          value:
            - name: type
              value: string
            - name: description
              value: string
            - name: next
              value:
                - string
        - name: stages
          value: object
        - name: provisioningState
          value: []
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a pipelines resource.

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

DELETE example

Deletes the specified pipelines resource.

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