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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the private link resource.
forceUpdateTag	string	How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed.
provisioningState	string	The provisioning state of a pipeline run. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
request	object	The request parameters for a pipeline run.
response	object	The response of a pipeline run.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the private link resource.
forceUpdateTag	string	How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed.
provisioningState	string	The provisioning state of a pipeline run. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
request	object	The request parameters for a pipeline run.
response	object	The response of a pipeline run.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, registry_name, pipeline_run_name, subscription_id		Gets the detailed information for a given pipeline run.
list	select	resource_group_name, registry_name, subscription_id		Lists all the pipeline runs for the specified container registry.
create	insert	resource_group_name, registry_name, pipeline_run_name, subscription_id		Creates a pipeline run for a container registry with the specified parameters.
delete	delete	resource_group_name, registry_name, pipeline_run_name, subscription_id		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
pipeline_run_name	string	The name of the pipeline run. Required.
registry_name	string	The name of the container registry. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the detailed information for a given pipeline run.

SELECT
id,
name,
forceUpdateTag,
provisioningState,
request,
response,
systemData,
type
FROM azure.container_registry.pipeline_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND pipeline_run_name = '{{ pipeline_run_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the pipeline runs for the specified container registry.

SELECT
id,
name,
forceUpdateTag,
provisioningState,
request,
response,
systemData,
type
FROM azure.container_registry.pipeline_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND registry_name = '{{ registry_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.container_registry.pipeline_runs (
properties,
resource_group_name,
registry_name,
pipeline_run_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ registry_name }}',
'{{ pipeline_run_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: pipeline_runs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the pipeline_runs resource.
  - name: registry_name
    value: "{{ registry_name }}"
    description: Required parameter for the pipeline_runs resource.
  - name: pipeline_run_name
    value: "{{ pipeline_run_name }}"
    description: Required parameter for the pipeline_runs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the pipeline_runs resource.
  - name: properties
    description: |
      The properties of a pipeline run.
    value:
      provisioningState: "{{ provisioningState }}"
      request:
        pipelineResourceId: "{{ pipelineResourceId }}"
        artifacts:
          - "{{ artifacts }}"
        source:
          type: "{{ type }}"
          name: "{{ name }}"
        target:
          type: "{{ type }}"
          name: "{{ name }}"
        catalogDigest: "{{ catalogDigest }}"
      response:
        status: "{{ status }}"
        importedArtifacts:
          - "{{ importedArtifacts }}"
        progress:
          percentage: "{{ percentage }}"
        startTime: "{{ startTime }}"
        finishTime: "{{ finishTime }}"
        source:
          type: "{{ type }}"
          uri: "{{ uri }}"
          keyVaultUri: "{{ keyVaultUri }}"
          storageAccessMode: "{{ storageAccessMode }}"
        target:
          type: "{{ type }}"
          uri: "{{ uri }}"
          keyVaultUri: "{{ keyVaultUri }}"
          storageAccessMode: "{{ storageAccessMode }}"
        catalogDigest: "{{ catalogDigest }}"
        trigger:
          sourceTrigger:
            timestamp: "{{ timestamp }}"
        pipelineRunErrorMessage: "{{ pipelineRunErrorMessage }}"
      forceUpdateTag: "{{ forceUpdateTag }}"

DELETE examples

delete

Deletes a pipeline run from a container registry.

DELETE FROM azure.container_registry.pipeline_runs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND registry_name = '{{ registry_name }}' --required
AND pipeline_run_name = '{{ pipeline_run_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;