WebHookActivity interface

Csomag:

@azure/synapse-artifacts

WebHook-tevékenység.

Extends

ControlActivity

Tulajdonságok

authentication	A végpont meghívásához használt hitelesítési módszer.
body	A végpontnak küldött hasznos adatokat jelöli. A POST/PUT metódushoz szükséges, nem engedélyezett a GET metódus típusa: sztring (vagy kifejezés resultType sztringgel).
headers	A kérésnek küldött fejléceket jelöli. Ha például egy kérés nyelvét és típusát szeretné beállítani: "fejlécek" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Típus: sztring (vagy kifejezés resultType sztringgel).
method	Rest API-metódus a célvégponthoz.
reportStatusOnCallBack	Ha igaz értékre van állítva, a statusCode, a kimenet és a hiba a visszahívási kérelem törzsében a tevékenység által lesz felhasználva. A tevékenység sikertelenként jelölhető meg a statusCode >= 400 beállításával a visszahívási kérelemben. Az alapértelmezett érték hamis. Típus: logikai (vagy resultType logikai értéket tartalmazó kifejezés).
timeout	Az időtúllépés, amelyen belül a webhookot vissza kell hívni. Ha nincs megadva érték, az alapértelmezés szerint 10 perc. Típus: sztring. Minta: ((\d+).)? (\d\d):(60|( [0-5] [0-9]))):(60|( [0-5] [0-9])).
type	Polimorfikus diszkriminatív, amely meghatározza az objektum különböző típusait
url	WebHook tevékenység célvégpontja és elérési útja. Típus: sztring (vagy kifejezés resultType sztringgel).

Örökölt tulajdonságok

dependsOn	A tevékenység a feltételtől függ.
description	Tevékenység leírása.
name	Tevékenység neve.
onInactiveMarkAs	A tevékenység állapoteredménye, ha az állapot Inaktív értékre van állítva. Ez egy nem kötelező tulajdonság, és ha a tevékenység inaktív állapotban nincs megadva, az állapot alapértelmezés szerint sikeres lesz.
state	Tevékenység állapota. Ez nem kötelező tulajdonság, és ha nincs megadva, az állapot alapértelmezés szerint aktív lesz.
userProperties	Tevékenységfelhasználó tulajdonságai.

Tulajdonság adatai

authentication

A végpont meghívásához használt hitelesítési módszer.

authentication?: WebActivityAuthentication

Tulajdonság értéke

WebActivityAuthentication

body

A végpontnak küldött hasznos adatokat jelöli. A POST/PUT metódushoz szükséges, nem engedélyezett a GET metódus típusa: sztring (vagy kifejezés resultType sztringgel).

body?: any

Tulajdonság értéke

any

headers

A kérésnek küldött fejléceket jelöli. Ha például egy kérés nyelvét és típusát szeretné beállítani: "fejlécek" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Típus: sztring (vagy kifejezés resultType sztringgel).

headers?: any

Tulajdonság értéke

any

method

Rest API-metódus a célvégponthoz.

method: string

Tulajdonság értéke

string

reportStatusOnCallBack

Ha igaz értékre van állítva, a statusCode, a kimenet és a hiba a visszahívási kérelem törzsében a tevékenység által lesz felhasználva. A tevékenység sikertelenként jelölhető meg a statusCode >= 400 beállításával a visszahívási kérelemben. Az alapértelmezett érték hamis. Típus: logikai (vagy resultType logikai értéket tartalmazó kifejezés).

reportStatusOnCallBack?: any

Tulajdonság értéke

any

timeout

Az időtúllépés, amelyen belül a webhookot vissza kell hívni. Ha nincs megadva érték, az alapértelmezés szerint 10 perc. Típus: sztring. Minta: ((\d+).)? (\d\d):(60|( [0-5] [0-9]))):(60|( [0-5] [0-9])).

timeout?: string

Tulajdonság értéke

string

type

Polimorfikus diszkriminatív, amely meghatározza az objektum különböző típusait

type: "WebHook"

Tulajdonság értéke

"WebHook"

url

WebHook tevékenység célvégpontja és elérési útja. Típus: sztring (vagy kifejezés resultType sztringgel).

url: any

Tulajdonság értéke

any

Örökölt tulajdonság részletei

dependsOn

A tevékenység a feltételtől függ.

dependsOn?: ActivityDependency[]

Tulajdonság értéke

ActivityDependency[]

ÖrököltControlActivity.dependsOn

description

Tevékenység leírása.

description?: string

Tulajdonság értéke

string

ControlActivity.description

name

Tevékenység neve.

name: string

Tulajdonság értéke

string

örököltControlActivity.name

onInactiveMarkAs

A tevékenység állapoteredménye, ha az állapot Inaktív értékre van állítva. Ez egy nem kötelező tulajdonság, és ha a tevékenység inaktív állapotban nincs megadva, az állapot alapértelmezés szerint sikeres lesz.

onInactiveMarkAs?: string

Tulajdonság értéke

string

örököltControlActivity.onInactiveMarkAs

state

Tevékenység állapota. Ez nem kötelező tulajdonság, és ha nincs megadva, az állapot alapértelmezés szerint aktív lesz.

state?: string

Tulajdonság értéke

string

ControlActivity.state örökölte

userProperties

Tevékenységfelhasználó tulajdonságai.

userProperties?: UserProperty[]

Tulajdonság értéke

UserProperty[]

ControlActivity.userProperties