Pipeline Runs - Query By Factory

Service:: Data Factory

API Version:: 2018-06-01

Query pipeline runs in the factory based on input filter conditions.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns?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	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
lastUpdatedAfter	True	string (date-time)	The time at or after which the run event was updated in 'ISO 8601' format.
lastUpdatedBefore	True	string (date-time)	The time at or before which the run event was updated in 'ISO 8601' format.
continuationToken		string	The continuation token for getting the next page of results. Null for first page.
filters		RunQueryFilter[]	List of filters.
orderBy		RunQueryOrderBy[]	List of OrderBy option.

Responses

Name	Type	Description
200 OK	PipelineRunsQueryResponse	Azure operation completed successfully.
Other Status Codes	CloudError	An unexpected error response.

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_QueryByFactory

Sample request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/queryPipelineRuns?api-version=2018-06-01

{
  "filters": [
    {
      "operand": "PipelineName",
      "operator": "Equals",
      "values": [
        "examplePipeline"
      ]
    }
  ],
  "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
  "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z"
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python pipeline_runs_query_by_factory.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.pipeline_runs.query_by_factory(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        filter_parameters={
            "filters": [{"operand": "PipelineName", "operator": "Equals", "values": ["examplePipeline"]}],
            "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
            "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z",
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/PipelineRuns_QueryByFactory.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/PipelineRuns_QueryByFactory.json
// this example is just showing the usage of "PipelineRuns_QueryByFactory" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// invoke the operation and iterate over the result
RunFilterContent content = new RunFilterContent(DateTimeOffset.Parse("2018-06-16T00:36:44.3345758Z"), DateTimeOffset.Parse("2018-06-16T00:49:48.3686473Z"))
{
    Filters = { new RunQueryFilter(RunQueryFilterOperand.PipelineName, RunQueryFilterOperator.EqualsValue, new string[] { "examplePipeline" }) },
};
await foreach (DataFactoryPipelineRunInfo item in dataFactory.GetPipelineRunsAsync(content))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

Date: Sat, 16 Jun 2018 00:40:01 GMT
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
x-ms-ratelimit-remaining-subscription-reads: 14989
x-ms-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd

{
  "value": [
    {
      "annotations": [],
      "durationInMs": 28105,
      "invokedBy": {
        "name": "Manual",
        "id": "80a01654a9d34ad18b3fcac5d5d76b67"
      },
      "lastUpdated": "2018-06-16T00:38:12.7314495Z",
      "message": "",
      "parameters": {
        "OutputBlobNameList": "[\"exampleoutput.csv\"]"
      },
      "pipelineName": "examplePipeline",
      "runDimension": {
        "JobId": "79c1cc52-265f-41a5-9553-be65e736fbd3"
      },
      "runEnd": "2018-06-16T00:38:12.7314495Z",
      "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "runStart": "2018-06-16T00:37:44.6257014Z",
      "status": "Succeeded"
    },
    {
      "annotations": [],
      "durationInMs": null,
      "invokedBy": {
        "name": "Manual",
        "id": "7c5fd7ef7e8a464b98b931cf15fcac66"
      },
      "lastUpdated": "2018-06-16T00:39:51.216097Z",
      "message": "",
      "parameters": {
        "OutputBlobNameList": "[\"exampleoutput.csv\"]"
      },
      "pipelineName": "examplePipeline",
      "runDimension": {
        "JobId": "84a3c493-0628-4b44-852f-ef5b3a11bdab"
      },
      "runEnd": null,
      "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721",
      "runStart": "2018-06-16T00:39:49.2745128Z",
      "status": "Cancelled"
    }
  ]
}

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.
PipelineRunsQueryResponse	A list pipeline runs.
RunFilterParameters	Query parameters for listing runs.
RunQueryFilter	Query filter option for listing runs.
RunQueryFilterOperand	Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.
RunQueryFilterOperator	Operator to be used for filter.
RunQueryOrder	Sorting order of the parameter.
RunQueryOrderBy	An object to provide order by options for listing runs.
RunQueryOrderByField	Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.

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 (int32)	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.

PipelineRunsQueryResponse

Object

A list pipeline runs.

Name	Type	Description
continuationToken	string	The continuation token for getting the next page of results, if any remaining results exist, null otherwise.
value	PipelineRun[]	List of pipeline runs.

RunFilterParameters

Object

Query parameters for listing runs.

Name	Type	Description
continuationToken	string	The continuation token for getting the next page of results. Null for first page.
filters	RunQueryFilter[]	List of filters.
lastUpdatedAfter	string (date-time)	The time at or after which the run event was updated in 'ISO 8601' format.
lastUpdatedBefore	string (date-time)	The time at or before which the run event was updated in 'ISO 8601' format.
orderBy	RunQueryOrderBy[]	List of OrderBy option.

RunQueryFilter

Object

Query filter option for listing runs.

Name	Type	Description
operand	RunQueryFilterOperand	Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.
operator	RunQueryFilterOperator	Operator to be used for filter.
values	string[]	List of filter values.

RunQueryFilterOperand

Enumeration

Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.

Value	Description
PipelineName	PipelineName
Status	Status
RunStart	RunStart
RunEnd	RunEnd
ActivityName	ActivityName
ActivityRunStart	ActivityRunStart
ActivityRunEnd	ActivityRunEnd
ActivityType	ActivityType
TriggerName	TriggerName
TriggerRunTimestamp	TriggerRunTimestamp
RunGroupId	RunGroupId
LatestOnly	LatestOnly

RunQueryFilterOperator

Enumeration

Operator to be used for filter.

Value	Description
Equals	Equals
NotEquals	NotEquals
In	In
NotIn	NotIn

RunQueryOrder

Enumeration

Sorting order of the parameter.

Value	Description
ASC	ASC
DESC	DESC

RunQueryOrderBy

Object

An object to provide order by options for listing runs.

Name	Type	Description
order	RunQueryOrder	Sorting order of the parameter.
orderBy	RunQueryOrderByField	Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.

RunQueryOrderByField

Enumeration

Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.

Value	Description
RunStart	RunStart
RunEnd	RunEnd
PipelineName	PipelineName
Status	Status
ActivityName	ActivityName
ActivityRunStart	ActivityRunStart
ActivityRunEnd	ActivityRunEnd
TriggerName	TriggerName
TriggerRunTimestamp	TriggerRunTimestamp

Share via

Pipeline Runs - Query By Factory

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

PipelineRuns_QueryByFactory

Sample request

Sample response

Definitions

CloudError

PipelineRun

PipelineRunInvokedBy

PipelineRunsQueryResponse

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField