FailActivity Class

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.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.ControlActivity

FailActivity

Constructor

FailActivity(*, name: str, message: Any, error_code: Any, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, depends_on: Optional[List[_models.ActivityDependency]] = None, user_properties: Optional[List[_models.UserProperty]] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

name

str

Required. Activity name.

type

str

Required. Type of activity.Constant filled by server.

description

str

Activity description.

depends_on

list[ActivityDependency]

Activity depends on condition.

user_properties

list[UserProperty]

Activity user properties.

message

any

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

error_code

any

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