pipelines_runs

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

Overview

Name	pipelines_runs
Type	Resource
Id	azure.data_factory.pipelines_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
create	insert	subscriptionId, resourceGroupName, factoryName, pipelineName	api-version, referencePipelineRunId, isRecovery, startActivityName, startFromFailure	Creates a run of a pipeline.

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.
pipelineName	string	The pipeline name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
api-version	string	The API version.
isRecovery	boolean	Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.
referencePipelineRunId	string	The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.
startActivityName	string	In recovery mode, the rerun will start from this activity. If not specified, all activities will run.
startFromFailure	boolean	In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified.

INSERT examples

create

Creates a run of a pipeline.

INSERT INTO azure.data_factory.pipelines_runs (
subscriptionId,
resourceGroupName,
factoryName,
pipelineName,
api-version,
referencePipelineRunId,
isRecovery,
startActivityName,
startFromFailure
)
SELECT 
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ pipelineName }}',
'{{ api-version }}',
'{{ referencePipelineRunId }}',
'{{ isRecovery }}',
'{{ startActivityName }}',
'{{ startFromFailure }}'
RETURNING
runId
;

Manifest

# Description fields are for documentation purposes
- name: pipelines_runs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the pipelines_runs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the pipelines_runs resource.
    - name: factoryName
      value: string
      description: Required parameter for the pipelines_runs resource.
    - name: pipelineName
      value: string
      description: Required parameter for the pipelines_runs resource.
    - name: api-version
      value: string
      description: The API version.
    - name: referencePipelineRunId
      value: string
      description: The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.
    - name: isRecovery
      value: boolean
      description: Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.
    - name: startActivityName
      value: string
      description: In recovery mode, the rerun will start from this activity. If not specified, all activities will run.
    - name: startFromFailure
      value: boolean
      description: In recovery mode, if set to true, the rerun will start from failed activities. The property will be used only if startActivityName is not specified.