WebHookActivity interface

套件:

@azure/arm-datafactory

WebHook 活動。

Extends

ControlActivity

屬性

authentication	用於呼叫端點的驗證方法。
body	表示將傳送至端點的承載。 POST/PUT 方法的必要專案，GET 方法類型不允許：string （或 expression with resultType 字串串的表達式）。
headers	表示將傳送至要求的標頭。 例如，若要在要求上設定語言和類型：“headers” ： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。 Type：string （或 expression with resultType string） 。
method	目標端點的 Rest API 方法。
policy	活動原則。
reportStatusOnCallBack	當設定為 true 時，活動會取用回呼要求本文中的 statusCode、輸出和錯誤。 您可以在回呼要求中設定 statusCode >= 400，將活動標示為失敗。 默認值為 false。 類型：布爾值（或 expression 含 resultType 布爾值的表達式）。
timeout	應該在其中呼叫 Webhook 的逾時。 如果沒有指定任何值，則預設為10分鐘。 類型：字串。 模式：（\d+）？（\d\d）:(60|（[0-5][0-9]）:(60|（[0-5][0-9])).
type	多型歧視性，指定這個物件可以是的不同類型
url	WebHook 活動目標端點和路徑。 Type：string （或 expression with resultType string） 。

繼承的屬性

dependsOn	活動取決於條件。
description	活動描述。
name	活動名稱。
onInactiveMarkAs	當狀態設定為 [非使用中] 時，活動的狀態結果。 這是選擇性屬性，如果未在活動處於非使用中狀態時提供，則狀態預設會是 [成功]。
state	活動狀態。 這是選擇性屬性，如果未提供，則狀態預設為 [作用中]。
userProperties	活動用戶屬性。

屬性詳細資料

authentication

用於呼叫端點的驗證方法。

authentication?: WebActivityAuthentication

屬性值

WebActivityAuthentication

body

表示將傳送至端點的承載。 POST/PUT 方法的必要專案，GET 方法類型不允許：string （或 expression with resultType 字串串的表達式）。

body?: any

屬性值

any

headers

表示將傳送至要求的標頭。 例如，若要在要求上設定語言和類型：“headers” ： { “Accept-Language”： “en-us”， “Content-Type”： “application/json” }。 Type：string （或 expression with resultType string） 。

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

屬性值

{[propertyName: string]: any}

method

目標端點的 Rest API 方法。

method: string

屬性值

string

policy

活動原則。

policy?: SecureInputOutputPolicy

屬性值

SecureInputOutputPolicy

reportStatusOnCallBack

當設定為 true 時，活動會取用回呼要求本文中的 statusCode、輸出和錯誤。 您可以在回呼要求中設定 statusCode >= 400，將活動標示為失敗。 默認值為 false。 類型：布爾值（或 expression 含 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 活動目標端點和路徑。 Type：string （或 expression with resultType string） 。

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