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:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
rerun	exec	subscriptionId, resourceGroupName, factoryName, triggerName, runId	api-version	Rerun single trigger instance by runId.
cancel	exec	subscriptionId, resourceGroupName, factoryName, triggerName, runId	api-version	Cancel a single trigger instance by runId.
query_by_factory	exec	subscriptionId, resourceGroupName, factoryName, lastUpdatedAfter, lastUpdatedBefore	api-version	Query trigger runs.

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
factoryName	string	The factory name.
resourceGroupName	string	The resource group name.
runId	string	The pipeline run identifier.
subscriptionId	string	The subscription identifier.
triggerName	string	The trigger name.
api-version	string	The API version.

Lifecycle Methods

rerun

Rerun single trigger instance by runId.

EXEC azure.data_factory.trigger_runs.rerun 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@triggerName='{{ triggerName }}' --required, 
@runId='{{ runId }}' --required, 
@api-version='{{ api-version }}'
;

cancel

Cancel a single trigger instance by runId.

EXEC azure.data_factory.trigger_runs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@triggerName='{{ triggerName }}' --required, 
@runId='{{ runId }}' --required, 
@api-version='{{ api-version }}'
;

query_by_factory

Query trigger runs.

EXEC azure.data_factory.trigger_runs.query_by_factory 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@factoryName='{{ factoryName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"continuationToken": "{{ continuationToken }}", 
"lastUpdatedAfter": "{{ lastUpdatedAfter }}", 
"lastUpdatedBefore": "{{ lastUpdatedBefore }}", 
"filters": "{{ filters }}", 
"orderBy": "{{ orderBy }}"
}'
;