Azure Data Factory (Preview)

Azure Data Factory is a hybrid data integration service that allows you to create, schedule and orchestrate your ETL/ELT workflows at scale wherever your data lives, in cloud or self-hosted network.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Cancel a pipeline run

This operation cancels a pipeline run by its run ID.

Create a pipeline run

This operation creates a new pipeline run in your factory

Get a pipeline run

Get a particular pipeline run execution

Cancel a pipeline run

This operation cancels a pipeline run by its run ID.

Parameters

Name Key Required Type Description
Subscription
subscriptionId True string

The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Resource Group
resourceGroupName True string

Resource group name.

Data Factory Name
dataFactoryName True string

The name of the Data Factory.

Data Factory Pipeline Run Id
pipelineRunName True string

The id of the Data Factory pipeline run.

Create a pipeline run

This operation creates a new pipeline run in your factory

Parameters

Name Key Required Type Description
Subscription
subscriptionId True string

The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Resource Group
resourceGroupName True string

Resource group name.

Data Factory Name
dataFactoryName True string

The name of the Data Factory.

Data Factory Pipeline Name
pipelineName True string

The name of the Data Factory pipeline.

Reference pipelineRunId.
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.

Returns

Name Path Type Description
runId
runId string

runId

Get a pipeline run

Get a particular pipeline run execution

Parameters

Name Key Required Type Description
Subscription
subscriptionId True string

The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.

Resource Group
resourceGroupName True string

Resource group name.

Data Factory Name
dataFactoryName True string

The name of the Data Factory.

Data Factory Pipeline Run Id
pipelineRunName True string

The id of the Data Factory pipeline run.

Returns

Information about a pipeline run.

Definitions

PipelineRun

Information about a pipeline run.

Name Path Type Description
Run Id
runId string

Identifier of a run

Pipeline Name
pipelineName string

The pipeline name

ID
invokedBy.id string

The ID of the entity that started the run.

Name
invokedBy.name string

Name of the entity that started the pipeline run.

Run Start
runStart date-time

The start time of a pipeline run in ISO8601 format.

Run End
runEnd date-time

The end time of a pipeline run in ISO8601 format.

Duration
durationInMs integer

The duration of a pipeline run in milliseconds.

Status
status string

The status of the pipeline run.

Message
message string

The message from a pipeline run.

Last Updated
lastUpdated date-time

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

Annotations
annotations array of string

The annotations for the pipeline run.