runs

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

Overview

Name	runs
Type	Resource
Id	azure.container_registry.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 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 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, runId		Gets the detailed information for a given run.
list	select	subscriptionId, resourceGroupName, registryName	$filter, $top	Gets all the runs for a registry.
update	update	subscriptionId, resourceGroupName, registryName, runId		Patch the run properties.
cancel	exec	subscriptionId, resourceGroupName, registryName, runId		Cancel an existing run.

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
registryName	string	The name of the container registry.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
runId	string	The run ID.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$filter	string	The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed.
$top	integer (int32)	$top is supported for get list of runs, which limits the maximum number of runs to return.

SELECT examples

get

Gets the detailed information for a given run.

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

list

Gets all the runs for a registry.

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

UPDATE examples

update

Patch the run properties.

UPDATE azure.container_registry.runs
SET 
data__isArchiveEnabled = {{ isArchiveEnabled }}
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND runId = '{{ runId }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

cancel

Cancel an existing run.

EXEC azure.container_registry.runs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@registryName='{{ registryName }}' --required, 
@runId='{{ runId }}' --required
;