Share via

AzureFunctionActivity Class

  • Reference

Azure Function activity.

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

Inheritance
azure.mgmt.datafactory.models._models_py3.ExecutionActivity
AzureFunctionActivity

Constructor

AzureFunctionActivity(*, name: str, method: str | _models.AzureFunctionActivityMethod, function_name: 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, **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 AzureFunctionActivityMethod

Rest API method for target endpoint. Required. Known values are: "GET", "POST", "PUT", "DELETE", "OPTIONS", "HEAD", and "TRACE".
function_name
<xref:JSON>

Name of the Function that the Azure Function Activity will call. 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).

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 AzureFunctionActivityMethod

Rest API method for target endpoint. Required. Known values are: "GET", "POST", "PUT", "DELETE", "OPTIONS", "HEAD", and "TRACE".
function_name
<xref:JSON>

Name of the Function that the Azure Function Activity will call. 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).