AzureMLExecutePipelineActivity Class

Definition

Azure ML Execute Pipeline activity.

public class AzureMLExecutePipelineActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.AzureMLExecutePipelineActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.AzureMLExecutePipelineActivity>
public class AzureMLExecutePipelineActivity : Azure.ResourceManager.DataFactory.Models.ExecutionActivity
type AzureMLExecutePipelineActivity = class
    inherit ExecutionActivity
    interface IJsonModel<AzureMLExecutePipelineActivity>
    interface IPersistableModel<AzureMLExecutePipelineActivity>
type AzureMLExecutePipelineActivity = class
    inherit ExecutionActivity
Public Class AzureMLExecutePipelineActivity
Inherits ExecutionActivity
Implements IJsonModel(Of AzureMLExecutePipelineActivity), IPersistableModel(Of AzureMLExecutePipelineActivity)
Public Class AzureMLExecutePipelineActivity
Inherits ExecutionActivity
Inheritance
AzureMLExecutePipelineActivity
Implements

Constructors

AzureMLExecutePipelineActivity(String)

Initializes a new instance of AzureMLExecutePipelineActivity.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
(Inherited from PipelineActivity)
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).

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
DependsOn

Activity depends on condition.

(Inherited from PipelineActivity)
Description

Activity description.

(Inherited from PipelineActivity)
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).

LinkedServiceName

Linked service reference.

(Inherited from ExecutionActivity)
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).

Name

Activity name.

(Inherited from PipelineActivity)
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.

(Inherited from PipelineActivity)
Policy

Activity policy.

(Inherited from ExecutionActivity)
State

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

(Inherited from PipelineActivity)
UserProperties

Activity user properties.

(Inherited from PipelineActivity)
Version

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

Explicit Interface Implementations

IJsonModel<AzureMLExecutePipelineActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AzureMLExecutePipelineActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<ExecutionActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ExecutionActivity)
IJsonModel<ExecutionActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ExecutionActivity)
IJsonModel<PipelineActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from PipelineActivity)
IJsonModel<PipelineActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from PipelineActivity)
IPersistableModel<AzureMLExecutePipelineActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AzureMLExecutePipelineActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AzureMLExecutePipelineActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<ExecutionActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ExecutionActivity)
IPersistableModel<ExecutionActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ExecutionActivity)
IPersistableModel<ExecutionActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ExecutionActivity)
IPersistableModel<PipelineActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from PipelineActivity)

Applies to