AzureMLExecutePipelineActivity Class

Azure ML Execute Pipeline activity.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.ExecutionActivity

AzureMLExecutePipelineActivity

Constructor

AzureMLExecutePipelineActivity(*, name: str, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy | None = None, ml_pipeline_id: MutableMapping[str, Any] | None = None, ml_pipeline_endpoint_id: MutableMapping[str, Any] | None = None, version: MutableMapping[str, Any] | None = None, experiment_name: MutableMapping[str, Any] | None = None, ml_pipeline_parameters: MutableMapping[str, Any] | None = None, data_path_assignments: MutableMapping[str, Any] | None = None, ml_parent_run_id: MutableMapping[str, Any] | None = None, continue_on_step_failure: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
name	str Activity name. Required.
description	str Activity description.
state	str or ActivityState Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".
on_inactive_mark_as	str or ActivityOnInactiveMarkAs 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. Known values are: "Succeeded", "Failed", and "Skipped".
depends_on	list[ActivityDependency] Activity depends on condition.
user_properties	list[UserProperty] Activity user properties.
linked_service_name	LinkedServiceReference Linked service reference.
policy	ActivityPolicy Activity policy.
ml_pipeline_id	<xref:JSON> ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).
ml_pipeline_endpoint_id	<xref:JSON> ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
version	<xref:JSON> Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
experiment_name	<xref:JSON> 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	<xref:JSON> 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).
data_path_assignments	<xref:JSON> 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).
ml_parent_run_id	<xref:JSON> 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	<xref:JSON> 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).

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
name	str Activity name. Required.
type	str Type of activity. Required.
description	str Activity description.
state	str or ActivityState Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".
on_inactive_mark_as	str or ActivityOnInactiveMarkAs 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. Known values are: "Succeeded", "Failed", and "Skipped".
depends_on	list[ActivityDependency] Activity depends on condition.
user_properties	list[UserProperty] Activity user properties.
linked_service_name	LinkedServiceReference Linked service reference.
policy	ActivityPolicy Activity policy.
ml_pipeline_id	<xref:JSON> ID of the published Azure ML pipeline. Type: string (or Expression with resultType string).
ml_pipeline_endpoint_id	<xref:JSON> ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
version	<xref:JSON> Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string).
experiment_name	<xref:JSON> 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	<xref:JSON> 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).
data_path_assignments	<xref:JSON> 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).
ml_parent_run_id	<xref:JSON> 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	<xref:JSON> 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).