trigger_runs

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

Overview

Name	trigger_runs
Type	Resource
Id	azure.data_factory.trigger_runs

Fields

The following fields are returned by SELECT queries:

query_by_factory

Name	Datatype	Description
continuationToken	string	The continuation token for getting the next page of results, if any remaining results exist, null otherwise.
value	array	List of trigger runs. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
query_by_factory	select	resource_group_name, factory_name, subscription_id		Query trigger runs.
rerun	exec	resource_group_name, factory_name, trigger_name, run_id, subscription_id		Rerun single trigger instance by runId.
cancel	exec	resource_group_name, factory_name, trigger_name, run_id, subscription_id		Cancel a single trigger instance by runId.

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
factory_name	string	Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
run_id	string	The pipeline run identifier. Required.
subscription_id	string
trigger_name	string	Required.

SELECT examples

query_by_factory

Query trigger runs.

SELECT
continuationToken,
value
FROM azure.data_factory.trigger_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

rerun

Rerun single trigger instance by runId.

EXEC azure.data_factory.trigger_runs.rerun 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@run_id='{{ run_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

cancel

Cancel a single trigger instance by runId.

EXEC azure.data_factory.trigger_runs.cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@factory_name='{{ factory_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@run_id='{{ run_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;