pipelines

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

Overview

Name	pipelines
Type	Resource
Id	azure.iot_data_processor.pipelines

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	Edge location of the resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
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, instanceName, pipelineName		Get a Pipeline
create_or_update	insert	subscriptionId, resourceGroupName, instanceName, pipelineName, data__extendedLocation		Create a Pipeline
update	update	subscriptionId, resourceGroupName, instanceName, pipelineName		Update a Pipeline
delete	delete	subscriptionId, resourceGroupName, instanceName, pipelineName		Delete 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
instanceName	string	Name of instance.
pipelineName	string	Name of pipeline
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a Pipeline

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

INSERT examples

create_or_update

Create a Pipeline

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

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: instanceName
      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: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        Edge location of the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a Pipeline

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

DELETE examples

delete

Delete a Pipeline

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