pipeline_runs

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

Overview

Name	pipeline_runs
Type	Resource
Id	azure.container_registry.pipeline_runs

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well - formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of a pipeline run.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

The request was successful; the request was well - formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of a pipeline run.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, registryName, pipelineRunName		Gets the detailed information for a given pipeline run.
list	select	subscriptionId, resourceGroupName, registryName		Lists all the pipeline runs for the specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, pipelineRunName		Creates a pipeline run for a container registry with the specified parameters
delete	delete	subscriptionId, resourceGroupName, registryName, pipelineRunName		Deletes a pipeline run from a container registry.

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
pipelineRunName	string	The name of the pipeline run.
registryName	string	The name of the container registry.
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 the detailed information for a given pipeline run.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.container_registry.pipeline_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
AND pipelineRunName = '{{ pipelineRunName }}' -- required
;

list

Lists all the pipeline runs for the specified container registry.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.container_registry.pipeline_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
;

INSERT examples

create

Creates a pipeline run for a container registry with the specified parameters

INSERT INTO azure.container_registry.pipeline_runs (
data__properties,
subscriptionId,
resourceGroupName,
registryName,
pipelineRunName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}',
'{{ pipelineRunName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: pipeline_runs
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the pipeline_runs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the pipeline_runs resource.
    - name: registryName
      value: string
      description: Required parameter for the pipeline_runs resource.
    - name: pipelineRunName
      value: string
      description: Required parameter for the pipeline_runs resource.
    - name: properties
      value: object
      description: |
        The properties of a pipeline run.

DELETE examples

delete

Deletes a pipeline run from a container registry.

DELETE FROM azure.container_registry.pipeline_runs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND pipelineRunName = '{{ pipelineRunName }}' --required
;