WebHookActivity interface

Paket:

@azure/synapse-artifacts

WebHook-aktivitet.

Extends

ControlActivity

Egenskaper

authentication	Autentiseringsmetod som används för att anropa slutpunkten.
body	Representerar nyttolasten som ska skickas till slutpunkten. Krävs för POST/PUT-metoden, tillåts inte för GET-metoden Typ: sträng (eller Uttryck med resultType-sträng).
headers	Representerar de rubriker som ska skickas till begäran. Om du till exempel vill ange språket och skriva på en begäran: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Typ: sträng (eller uttryck med resultType-sträng).
method	Rest API-metod för målslutpunkt.
reportStatusOnCallBack	När värdet är true används statusCode, utdata och fel i begärandetexten för återanrop av aktivitet. Aktiviteten kan markeras som misslyckad genom att ange statusCode >= 400 i begäran om återanrop. Standardvärdet är falskt. Typ: booleskt (eller uttryck med resultType booleskt värde).
timeout	Tidsgränsen inom vilken webhooken ska anropas tillbaka. Om inget värde har angetts är standardvärdet 10 minuter. Typ: sträng. Mönster: ((\d+).)? (\d\d):(60|( [0-5] [0-9]))):(60|( [0-5] [0-9])).
type	Polymorft diskriminerande, vilket anger de olika typer som det här objektet kan vara
url	Slutpunkt och sökväg för WebHook-aktivitetsmål. Typ: sträng (eller uttryck med resultType-sträng).

Ärvda egenskaper

dependsOn	Aktivitet beror på villkor.
description	Aktivitetsbeskrivning.
name	Aktivitetsnamn.
onInactiveMarkAs	Statusresultat för aktiviteten när tillståndet är inställt på Inaktiv. Det här är en valfri egenskap och om den inte anges när aktiviteten är inaktiv kommer statusen att lyckas som standard.
state	Aktivitetstillstånd. Det här är en valfri egenskap och om det inte anges är tillståndet Aktivt som standard.
userProperties	Egenskaper för aktivitetsanvändare.

Egenskapsinformation

authentication

Autentiseringsmetod som används för att anropa slutpunkten.

authentication?: WebActivityAuthentication

Egenskapsvärde

WebActivityAuthentication

body

Representerar nyttolasten som ska skickas till slutpunkten. Krävs för POST/PUT-metoden, tillåts inte för GET-metoden Typ: sträng (eller Uttryck med resultType-sträng).

body?: any

Egenskapsvärde

any

headers

Representerar de rubriker som ska skickas till begäran. Om du till exempel vill ange språket och skriva på en begäran: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Typ: sträng (eller uttryck med resultType-sträng).

headers?: any

Egenskapsvärde

any

method

Rest API-metod för målslutpunkt.

method: string

Egenskapsvärde

string

reportStatusOnCallBack

När värdet är true används statusCode, utdata och fel i begärandetexten för återanrop av aktivitet. Aktiviteten kan markeras som misslyckad genom att ange statusCode >= 400 i begäran om återanrop. Standardvärdet är falskt. Typ: booleskt (eller uttryck med resultType booleskt värde).

reportStatusOnCallBack?: any

Egenskapsvärde

any

timeout

Tidsgränsen inom vilken webhooken ska anropas tillbaka. Om inget värde har angetts är standardvärdet 10 minuter. Typ: sträng. Mönster: ((\d+).)? (\d\d):(60|( [0-5] [0-9]))):(60|( [0-5] [0-9])).

timeout?: string

Egenskapsvärde

string

type

Polymorft diskriminerande, vilket anger de olika typer som det här objektet kan vara

type: "WebHook"

Egenskapsvärde

"WebHook"

url

Slutpunkt och sökväg för WebHook-aktivitetsmål. Typ: sträng (eller uttryck med resultType-sträng).

url: any

Egenskapsvärde

any

Information om ärvda egenskaper

dependsOn

Aktivitet beror på villkor.

dependsOn?: ActivityDependency[]

Egenskapsvärde

ActivityDependency[]

ärvd frånControlActivity.dependsOn

description

Aktivitetsbeskrivning.

description?: string

Egenskapsvärde

string

ärvd frånControlActivity.description

name

Aktivitetsnamn.

name: string

Egenskapsvärde

string

ärvd frånControlActivity.name

onInactiveMarkAs

Statusresultat för aktiviteten när tillståndet är inställt på Inaktiv. Det här är en valfri egenskap och om den inte anges när aktiviteten är inaktiv kommer statusen att lyckas som standard.

onInactiveMarkAs?: string

Egenskapsvärde

string

ärvs frånControlActivity.onInactiveMarkAs

state

Aktivitetstillstånd. Det här är en valfri egenskap och om det inte anges är tillståndet Aktivt som standard.

state?: string

Egenskapsvärde

string

ärvs frånControlActivity.state

userProperties

Egenskaper för aktivitetsanvändare.

userProperties?: UserProperty[]

Egenskapsvärde

UserProperty[]

ärvs frånControlActivity.userProperties