Share via

Pipeline Runs - Get

Service:
Data Factory
API Version:
2018-06-01

Get a pipeline run by its run ID.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}?api-version=2018-06-01

URI Parameters

Name In Required Type Description
factoryName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

The factory name.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

The resource group name.
runId
 path True

string

The pipeline run identifier.
subscriptionId
 path True

string

The subscription identifier.
api-version
 query True

string

The API version.

Responses

Name Type Description
200 OK

PipelineRun

OK.
Other Status Codes

CloudError

An error response received from the Azure Data Factory service.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

PipelineRuns_Get

Sample request

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b?api-version=2018-06-01

Sample response

Status code:
200 
Date: Sat, 16 Jun 2018 00:40:02 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14988
x-ms-request-id: 6d9de9bd-a412-4a6f-8b9e-37d369323646
x-ms-correlation-request-id: 6d9de9bd-a412-4a6f-8b9e-37d369323646
{
  "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
  "pipelineName": "examplePipeline",
  "parameters": {
    "OutputBlobNameList": "[\"exampleoutput.csv\"]"
  },
  "invokedBy": {
    "id": "80a01654a9d34ad18b3fcac5d5d76b67",
    "name": "Manual"
  },
  "runStart": "2018-06-16T00:37:44.6257014Z",
  "runEnd": "2018-06-16T00:38:12.7314495Z",
  "durationInMs": 28105,
  "status": "Succeeded",
  "message": "",
  "lastUpdated": "2018-06-16T00:38:12.7314495Z",
  "annotations": []
}

Definitions

Name Description
CloudError

The object that defines the structure of an Azure Data Factory error response.
PipelineRun

Information about a pipeline run.
PipelineRunInvokedBy

Provides entity name and id that started the pipeline run.

CloudError

Object

The object that defines the structure of an Azure Data Factory error response.

Name Type Description
error.code

string

Error code.
error.details

CloudError[]

Array with additional error details.
error.message

string

Error message.
error.target

string

Property name/path in request associated with error.

PipelineRun

Object

Information about a pipeline run.

Name Type Description
durationInMs

integer

The duration of a pipeline run.
invokedBy

PipelineRunInvokedBy

Entity that started the pipeline run.
isLatest

boolean

Indicates if the recovered pipeline run is the latest in its group.
lastUpdated

string (date-time)

The last updated timestamp for the pipeline run event in ISO8601 format.
message

string

The message from a pipeline run.
parameters

object

The full or partial list of parameter name, value pair used in the pipeline run.
pipelineName

string

The pipeline name.
runDimensions

object

Run dimensions emitted by Pipeline run.
runEnd

string (date-time)

The end time of a pipeline run in ISO8601 format.
runGroupId

string

Identifier that correlates all the recovery runs of a pipeline run.
runId

string

Identifier of a run.
runStart

string (date-time)

The start time of a pipeline run in ISO8601 format.
status

string

The status of a pipeline run. Possible values: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled

PipelineRunInvokedBy

Object

Provides entity name and id that started the pipeline run.

Name Type Description
id

string

The ID of the entity that started the run.
invokedByType

string

The type of the entity that started the run.
name

string

Name of the entity that started the pipeline run.
pipelineName

string

The name of the pipeline that triggered the run, if any.
pipelineRunId

string

The run id of the pipeline that triggered the run, if any.