Share via

AzureMLExecutePipelineActivity interface

  • Reference
Package:
@azure/arm-datafactory

Azure ML Execute Pipeline activity.

Extends
ExecutionActivity

Properties

continueOnStepFailure

Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).
dataPathAssignments

Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object (or Expression with resultType object).
experimentName

Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).
mlParentRunId

The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).
mlPipelineEndpointId

ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
mlPipelineId

ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).
mlPipelineParameters

Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).
type

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

Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).

Inherited Properties

dependsOn

Activity depends on condition.
description

Activity description.
linkedServiceName

Linked service reference.
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.
policy

Activity policy.
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

continueOnStepFailure

Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean).

continueOnStepFailure?: any

Property Value

any

dataPathAssignments

Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object (or Expression with resultType object).

dataPathAssignments?: any

Property Value

any

experimentName

Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string).

experimentName?: any

Property Value

any

mlParentRunId

The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string).

mlParentRunId?: any

Property Value

any

mlPipelineEndpointId

ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).

mlPipelineEndpointId?: any

Property Value

any

mlPipelineId

ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).

mlPipelineId?: any

Property Value

any

mlPipelineParameters

Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).

mlPipelineParameters?: any

Property Value

any

type

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

type: "AzureMLExecutePipeline"

Property Value

"AzureMLExecutePipeline"

version

Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).

version?: any

Property Value

any

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ExecutionActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ExecutionActivity.description

linkedServiceName

Linked service reference.

linkedServiceName?: LinkedServiceReference

Property Value

LinkedServiceReference

Inherited From ExecutionActivity.linkedServiceName

name

Activity name.

name: string

Property Value

string

Inherited From ExecutionActivity.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 ExecutionActivity.onInactiveMarkAs

policy

Activity policy.

policy?: ActivityPolicy

Property Value

ActivityPolicy

Inherited From ExecutionActivity.policy

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 ExecutionActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ExecutionActivity.userProperties