WebHookActivity Class

Reference

WebHook activity.

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

Inheritance: azure.mgmt.datafactory.models._models_py3.ControlActivity

WebHookActivity

Constructor

WebHookActivity(*, name: str, method: str | _models.WebHookActivityMethod, url: MutableMapping[str, Any], 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, policy: _models.SecureInputOutputPolicy | None = None, timeout: str | None = None, headers: Dict[str, MutableMapping[str, Any]] | None = None, body: MutableMapping[str, Any] | None = None, authentication: _models.WebActivityAuthentication | None = None, report_status_on_call_back: 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.
policy	SecureInputOutputPolicy Activity policy.
method	str or WebHookActivityMethod Rest API method for target endpoint. Required. "POST"
url	<xref:JSON> WebHook activity target endpoint and path. Type: string (or Expression with resultType string). Required.
timeout	str The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((d+).)?(dd):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
headers	dict[str, <xref:JSON>] Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
body	<xref:JSON> Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
authentication	WebActivityAuthentication Authentication method used for calling the endpoint.
report_status_on_call_back	<xref:JSON> When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. 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.
policy	SecureInputOutputPolicy Activity policy.
method	str or WebHookActivityMethod Rest API method for target endpoint. Required. "POST"
url	<xref:JSON> WebHook activity target endpoint and path. Type: string (or Expression with resultType string). Required.
timeout	str The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((d+).)?(dd):(60\|([0-5][0-9])):(60\|([0-5][0-9])).
headers	dict[str, <xref:JSON>] Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).
body	<xref:JSON> Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).
authentication	WebActivityAuthentication Authentication method used for calling the endpoint.
report_status_on_call_back	<xref:JSON> When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).

Share via

WebHookActivity Class

Constructor

Keyword-Only Parameters

Variables

Additional resources