WebActivity Class

Web activity.

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

Inheritance

azure.synapse.artifacts.models._models_py3.ExecutionActivity

WebActivity

Constructor

WebActivity(*, name: str, method: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.WebActivityMethod], url: object, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, depends_on: Optional[List[azure.synapse.artifacts.models._models_py3.ActivityDependency]] = None, user_properties: Optional[List[azure.synapse.artifacts.models._models_py3.UserProperty]] = None, linked_service_name: Optional[azure.synapse.artifacts.models._models_py3.LinkedServiceReference] = None, policy: Optional[azure.synapse.artifacts.models._models_py3.ActivityPolicy] = None, headers: Optional[object] = None, body: Optional[object] = None, authentication: Optional[azure.synapse.artifacts.models._models_py3.WebActivityAuthentication] = None, datasets: Optional[List[azure.synapse.artifacts.models._models_py3.DatasetReference]] = None, linked_services: Optional[List[azure.synapse.artifacts.models._models_py3.LinkedServiceReference]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, **kwargs)

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized to this collection.

name

str

Required

Required. Activity name.

type

str

Required

Required. Type of activity.Constant filled by server.

description

str

Required

Activity description.

depends_on

list[ActivityDependency]

Required

Activity depends on condition.

user_properties

list[UserProperty]

Required

Activity user properties.

linked_service_name

LinkedServiceReference

Required

Linked service reference.

policy

ActivityPolicy

Required

Activity policy.

method

str or WebActivityMethod

Required

Required. Rest API method for target endpoint. Possible values include: "GET", "POST", "PUT", "DELETE".

url

object

Required

Required. Web activity target endpoint and path. Type: string (or Expression with resultType string).

headers

object

Required

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

object

Required

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

Required

Authentication method used for calling the endpoint.

datasets

list[DatasetReference]

Required

List of datasets passed to web endpoint.

linked_services

list[LinkedServiceReference]

Required

List of linked services passed to web endpoint.

connect_via

IntegrationRuntimeReference

Required

The integration runtime reference.