FailActivity Class

Definition

This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.

[Microsoft.Rest.Serialization.JsonTransformation]
[Newtonsoft.Json.JsonObject("Fail")]
public class FailActivity : Microsoft.Azure.Management.DataFactory.Models.ControlActivity
[<Microsoft.Rest.Serialization.JsonTransformation>]
[<Newtonsoft.Json.JsonObject("Fail")>]
type FailActivity = class
    inherit ControlActivity
Public Class FailActivity
Inherits ControlActivity
Inheritance
Attributes
JsonTransformationAttribute Newtonsoft.Json.JsonObjectAttribute

Constructors

FailActivity()

Initializes a new instance of the FailActivity class.

FailActivity(String, Object, Object, IDictionary<String,Object>, String, IList<ActivityDependency>, IList<UserProperty>)

Initializes a new instance of the FailActivity class.

Properties

AdditionalProperties

Gets or sets unmatched properties from the message are deserialized this collection

(Inherited from Activity)
DependsOn

Gets or sets activity depends on condition.

(Inherited from Activity)
Description

Gets or sets activity description.

(Inherited from Activity)
ErrorCode

Gets or sets the error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).

Message

Gets or sets the error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).

Name

Gets or sets activity name.

(Inherited from Activity)
UserProperties

Gets or sets activity user properties.

(Inherited from Activity)

Methods

Validate()

Validate the object.

Applies to