pipelines

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

Overview

Name	pipelines
Type	Resource
Id	azure.devops.pipelines

Fields

The following fields are returned by SELECT queries:

get

The Azure Pipeline has been fetched successfully.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	Custom properties of the Pipeline.
tags	object	Resource Tags
type	string	Resource Type

list_by_resource_group

The Azure Pipelines have been fetched successfully.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	Custom properties of the Pipeline.
tags	object	Resource Tags
type	string	Resource Type

list_by_subscription

The Azure Pipelines have been fetched successfully.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	Custom properties of the Pipeline.
tags	object	Resource Tags
type	string	Resource Type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, pipelineName		Gets an existing Azure Pipeline.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all Azure Pipelines under the specified resource group.
list_by_subscription	select	subscriptionId		Lists all Azure Pipelines under the specified subscription.
create_or_update	insert	subscriptionId, resourceGroupName, pipelineName, data__properties		Creates or updates an Azure Pipeline.
update	update	subscriptionId, resourceGroupName, pipelineName		Updates the properties of an Azure Pipeline. Currently, only tags can be updated.
delete	delete	subscriptionId, resourceGroupName, pipelineName		Deletes an Azure 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 of the Azure Pipeline resource.
resourceGroupName	string	Name of the resource group within the Azure subscription.
subscriptionId	string	Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

SELECT examples

get

Gets an existing Azure Pipeline.

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

list_by_resource_group

Lists all Azure Pipelines under the specified resource group.

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

list_by_subscription

Lists all Azure Pipelines under the specified subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.devops.pipelines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Azure Pipeline.

INSERT INTO azure.devops.pipelines (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
pipelineName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ pipelineName }}'
RETURNING
id,
name,
location,
properties,
tags,
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: pipelineName
      value: string
      description: Required parameter for the pipelines resource.
    - name: properties
      value: object
      description: |
        Custom properties of the Pipeline.
    - name: tags
      value: object
      description: |
        Resource Tags
    - name: location
      value: string
      description: |
        Resource Location

UPDATE examples

update

Updates the properties of an Azure Pipeline. Currently, only tags can be updated.

UPDATE azure.devops.pipelines
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND pipelineName = '{{ pipelineName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes an Azure Pipeline.

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