WebHookActivity interface

包:

@azure/arm-datafactory

WebHook 活动。

扩展

ControlActivity

属性

authentication	用于调用终结点的身份验证方法。
body	表示将发送到终结点的有效负载。 POST/PUT 方法是必需的，不允许 GET 方法类型：字符串（或带有 resultType 字符串的表达式）。
headers	表示将发送到请求的标头。 例如，若要在请求上设置语言和类型：“headers”： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。 类型：字符串（或带有 resultType 字符串的表达式）。
method	目标终结点的 Rest API 方法。
policy	活动策略。
reportStatusOnCallBack	设置为 true 时，活动将使用回调请求正文中的 statusCode、输出和错误。 可以通过在回调请求中设置 statusCode >= 400 来将活动标记为失败。 默认值为 false。 类型：布尔值（或带有 resultType 布尔值的表达式）。
timeout	Webhook 应调用回的超时。 如果没有指定值，则默认为 10 分钟。 类型：字符串。 模式：（\d+）。？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).
type	多态鉴别器，它指定此对象可以的不同类型的
url	WebHook 活动目标终结点和路径。 类型：字符串（或带有 resultType 字符串的表达式）。

继承属性

dependsOn	活动取决于条件。
description	活动说明。
name	活动名称。
onInactiveMarkAs	当状态设置为“非活动”时活动的状态结果。 这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。
state	活动状态。 这是一个可选属性，如果未提供，则状态默认为“活动”。
userProperties	活动用户属性。

属性详细信息

authentication

用于调用终结点的身份验证方法。

authentication?: WebActivityAuthentication

属性值

WebActivityAuthentication

body

表示将发送到终结点的有效负载。 POST/PUT 方法是必需的，不允许 GET 方法类型：字符串（或带有 resultType 字符串的表达式）。

body?: any

属性值

any

headers

表示将发送到请求的标头。 例如，若要在请求上设置语言和类型：“headers”： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。 类型：字符串（或带有 resultType 字符串的表达式）。

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

属性值

{[propertyName: string]: any}

method

目标终结点的 Rest API 方法。

method: string

属性值

string

policy

活动策略。

policy?: SecureInputOutputPolicy

属性值

SecureInputOutputPolicy

reportStatusOnCallBack

设置为 true 时，活动将使用回调请求正文中的 statusCode、输出和错误。 可以通过在回调请求中设置 statusCode >= 400 来将活动标记为失败。 默认值为 false。 类型：布尔值（或带有 resultType 布尔值的表达式）。

reportStatusOnCallBack?: any

属性值

any

timeout

Webhook 应调用回的超时。 如果没有指定值，则默认为 10 分钟。 类型：字符串。 模式：（\d+）。？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).

timeout?: string

属性值

string

type

多态鉴别器，它指定此对象可以的不同类型的

type: "WebHook"

属性值

"WebHook"

url

WebHook 活动目标终结点和路径。 类型：字符串（或带有 resultType 字符串的表达式）。

url: any

属性值

any

继承属性详细信息

dependsOn

活动取决于条件。

dependsOn?: ActivityDependency[]

属性值

ActivityDependency[]

继承自 ControlActivity.dependsOn 的

description

活动说明。

description?: string

属性值

string

继承自ControlActivity.description

name

活动名称。

name: string

属性值

string

继承自 ControlActivity.name 的

onInactiveMarkAs

当状态设置为“非活动”时活动的状态结果。 这是一个可选属性，如果未在活动处于非活动状态时提供，则默认情况下状态将成功。

onInactiveMarkAs?: string

属性值

string

继承自 ControlActivity.onInactiveMarkAs 的

state

活动状态。 这是一个可选属性，如果未提供，则状态默认为“活动”。

state?: string

属性值

string

继承自 ControlActivity.state 的

userProperties

活动用户属性。

userProperties?: UserProperty[]

属性值

UserProperty[]

继承自ControlActivity.userProperties