Share via

ExecutePipelineActivity interface

  • Reference
Package:
@azure/arm-datafactory

Execute pipeline activity.

Extends
ControlActivity

Properties

parameters

Pipeline parameters.
pipeline

Pipeline reference.
policy

Execute pipeline activity policy.
type

Polymorphic discriminator, which specifies the different types this object can be
waitOnCompletion

Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

Inherited Properties

dependsOn

Activity depends on condition.
description

Activity description.
name

Activity name.
onInactiveMarkAs

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.
state

Activity state. This is an optional property and if not provided, the state will be Active by default.
userProperties

Activity user properties.

Property Details

parameters

Pipeline parameters.

parameters?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

pipeline

Pipeline reference.

pipeline: PipelineReference

Property Value

PipelineReference

policy

Execute pipeline activity policy.

policy?: ExecutePipelineActivityPolicy

Property Value

ExecutePipelineActivityPolicy

type

Polymorphic discriminator, which specifies the different types this object can be

type: "ExecutePipeline"

Property Value

"ExecutePipeline"

waitOnCompletion

Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

waitOnCompletion?: boolean

Property Value

boolean

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ControlActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ControlActivity.description

name

Activity name.

name: string

Property Value

string

Inherited From ControlActivity.name

onInactiveMarkAs

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

onInactiveMarkAs?: string

Property Value

string

Inherited From ControlActivity.onInactiveMarkAs

state

Activity state. This is an optional property and if not provided, the state will be Active by default.

state?: string

Property Value

string

Inherited From ControlActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ControlActivity.userProperties