WebActivity interface

  • Reference
Package:
@azure/arm-datafactory

Web activity.

Extends
ExecutionActivity

Properties

authentication

Authentication method used for calling the endpoint.
body

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

The integration runtime reference.
datasets

List of datasets passed to web endpoint.
disableCertValidation

When set to true, Certificate validation will be disabled.
headers

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

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
linkedServices

List of linked services passed to web endpoint.
method

Rest API method for target endpoint.
turnOffAsync

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.
type

Polymorphic discriminator, which specifies the different types this object can be
url

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

Inherited Properties

dependsOn

Activity depends on condition.
description

Activity description.
linkedServiceName

Linked service reference.
name

Activity name.
onInactiveMarkAs

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.
policy

Activity policy.
state

Activity state. This is an optional property and if not provided, the state will be Active by default.
userProperties

Activity user properties.

Property Details

authentication

Authentication method used for calling the endpoint.

authentication?: WebActivityAuthentication

Property Value

WebActivityAuthentication

body

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

body?: any

Property Value

any

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

datasets

List of datasets passed to web endpoint.

datasets?: DatasetReference[]

Property Value

DatasetReference[]

disableCertValidation

When set to true, Certificate validation will be disabled.

disableCertValidation?: boolean

Property Value

boolean

headers

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

headers?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

httpRequestTimeout

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

httpRequestTimeout?: any

Property Value

any

linkedServices

List of linked services passed to web endpoint.

linkedServices?: LinkedServiceReference[]

Property Value

LinkedServiceReference[]

method

Rest API method for target endpoint.

method: string

Property Value

string

turnOffAsync

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.

turnOffAsync?: boolean

Property Value

boolean

type

Polymorphic discriminator, which specifies the different types this object can be

type: "WebActivity"

Property Value

"WebActivity"

url

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

url: any

Property Value

any

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ExecutionActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ExecutionActivity.description

linkedServiceName

Linked service reference.

linkedServiceName?: LinkedServiceReference

Property Value

LinkedServiceReference

Inherited From ExecutionActivity.linkedServiceName

name

Activity name.

name: string

Property Value

string

Inherited From ExecutionActivity.name

onInactiveMarkAs

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.

onInactiveMarkAs?: string

Property Value

string

Inherited From ExecutionActivity.onInactiveMarkAs

policy

Activity policy.

policy?: ActivityPolicy

Property Value

ActivityPolicy

Inherited From ExecutionActivity.policy

state

Activity state. This is an optional property and if not provided, the state will be Active by default.

state?: string

Property Value

string

Inherited From ExecutionActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ExecutionActivity.userProperties