AzureMLExecutePipelineActivity Class

Azure ML Execute Pipeline activity.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.synapse.artifacts.models._models_py3.ExecutionActivity

AzureMLExecutePipelineActivity

Constructor

AzureMLExecutePipelineActivity(*, name: str, ml_pipeline_id: object, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, experiment_name: Optional[object] = None, ml_pipeline_parameters: Optional[object] = None, ml_parent_run_id: Optional[object] = None, continue_on_step_failure: Optional[object] = None, **kwargs)

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized to this collection.

name

str

Required

Required. Activity name.

type

str

Required

Required. Type of activity.Constant filled by server.

description

str

Required

Activity description.

depends_on

list[ActivityDependency]

Required

Activity depends on condition.

user_properties

list[UserProperty]

Required

Activity user properties.

linked_service_name

LinkedServiceReference

Required

Linked service reference.

policy

ActivityPolicy

Required

Activity policy.

ml_pipeline_id

object

Required

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

experiment_name

object

Required

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

ml_pipeline_parameters

object

Required

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

ml_parent_run_id

object

Required

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

continue_on_step_failure

object

Required

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