WebActivity Class

Web activity.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.ExecutionActivity

WebActivity

Constructor

WebActivity(*, name: str, method: str | _models.WebActivityMethod, 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, linked_service_name: _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy | None = None, headers: Dict[str, MutableMapping[str, Any]] | None = None, body: MutableMapping[str, Any] | None = None, authentication: _models.WebActivityAuthentication | None = None, disable_cert_validation: bool | None = None, http_request_timeout: MutableMapping[str, Any] | None = None, turn_off_async: bool | None = None, datasets: List[_models.DatasetReference] | None = None, linked_services: List[_models.LinkedServiceReference] | None = None, connect_via: _models.IntegrationRuntimeReference | 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.
method	str or WebActivityMethod Rest API method for target endpoint. Required. Known values are: "GET", "POST", "PUT", and "DELETE".
url	<xref:JSON> Web activity target endpoint and path. Type: string (or Expression with resultType string). Required.
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.
disable_cert_validation	bool When set to true, Certificate validation will be disabled.
http_request_timeout	<xref:JSON> Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes.
turn_off_async	bool Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers.
datasets	list[DatasetReference] List of datasets passed to web endpoint.
linked_services	list[LinkedServiceReference] List of linked services passed to web endpoint.
connect_via	IntegrationRuntimeReference The integration runtime reference.

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.
method	str or WebActivityMethod Rest API method for target endpoint. Required. Known values are: "GET", "POST", "PUT", and "DELETE".
url	<xref:JSON> Web activity target endpoint and path. Type: string (or Expression with resultType string). Required.
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.
disable_cert_validation	bool When set to true, Certificate validation will be disabled.
http_request_timeout	<xref:JSON> Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes.
turn_off_async	bool Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers.
datasets	list[DatasetReference] List of datasets passed to web endpoint.
linked_services	list[LinkedServiceReference] List of linked services passed to web endpoint.
connect_via	IntegrationRuntimeReference The integration runtime reference.