WebHookActivity interface

Balíček:

@azure/synapse-artifacts

Aktivita WebHooku

Extends

ControlActivity

Vlastnosti

authentication	Metoda ověřování používaná pro volání koncového bodu
body	Představuje datovou část, která se odešle do koncového bodu. Požadováno pro metodu POST/PUT, není povoleno pro typ metody GET: řetězec (nebo výraz s řetězcem resultType).
headers	Představuje hlavičky, které se odešlou do požadavku. Pokud chcete například nastavit jazyk a typ v požadavku: "headers": { "Accept-Language": "en-us", "Content-Type": "application/json" }. Typ: řetězec (nebo výraz s řetězcem resultType).
method	Metoda rest API pro cílový koncový bod
reportStatusOnCallBack	Pokud je nastavená hodnota true, statusCode, výstup a chyba v textu požadavku zpětného volání budou spotřebovány aktivitou. Aktivitu lze označit jako neúspěšnou nastavením statusCode >= 400 v žádosti o zpětné volání. Výchozí hodnota je false. Typ: logická hodnota (nebo výraz s logickou hodnotou resultType).
timeout	Časový limit, ve kterém by se měl webhook volat zpět. Pokud není zadaná žádná hodnota, výchozí hodnota je 10 minut. Typ: řetězec. Vzor: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).
type	Polymorfní diskriminátor, který určuje různé typy tohoto objektu
url	Cílový koncový bod aktivity WebHook a cesta Typ: řetězec (nebo výraz s řetězcem resultType).

Zděděné vlastnosti

dependsOn	Aktivita závisí na podmínce.
description	Popis aktivity
name	Název aktivity
onInactiveMarkAs	Výsledek stavu aktivity, pokud je stav nastaven na Neaktivní. Jedná se o volitelnou vlastnost a pokud není zadaná, když je aktivita neaktivní, stav bude ve výchozím nastavení Úspěšný.
state	Stav aktivity. Jedná se o volitelnou vlastnost a pokud není k dispozici, stav bude ve výchozím nastavení aktivní.
userProperties	Vlastnosti uživatele aktivity.

Podrobnosti vlastnosti

authentication

Metoda ověřování používaná pro volání koncového bodu

authentication?: WebActivityAuthentication

Hodnota vlastnosti

WebActivityAuthentication

body

Představuje datovou část, která se odešle do koncového bodu. Požadováno pro metodu POST/PUT, není povoleno pro typ metody GET: řetězec (nebo výraz s řetězcem resultType).

body?: any

Hodnota vlastnosti

any

headers

Představuje hlavičky, které se odešlou do požadavku. Pokud chcete například nastavit jazyk a typ v požadavku: "headers": { "Accept-Language": "en-us", "Content-Type": "application/json" }. Typ: řetězec (nebo výraz s řetězcem resultType).

headers?: any

Hodnota vlastnosti

any

method

Metoda rest API pro cílový koncový bod

method: string

Hodnota vlastnosti

string

reportStatusOnCallBack

Pokud je nastavená hodnota true, statusCode, výstup a chyba v textu požadavku zpětného volání budou spotřebovány aktivitou. Aktivitu lze označit jako neúspěšnou nastavením statusCode >= 400 v žádosti o zpětné volání. Výchozí hodnota je false. Typ: logická hodnota (nebo výraz s logickou hodnotou resultType).

reportStatusOnCallBack?: any

Hodnota vlastnosti

any

timeout

Časový limit, ve kterém by se měl webhook volat zpět. Pokud není zadaná žádná hodnota, výchozí hodnota je 10 minut. Typ: řetězec. Vzor: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).

timeout?: string

Hodnota vlastnosti

string

type

Polymorfní diskriminátor, který určuje různé typy tohoto objektu

type: "WebHook"

Hodnota vlastnosti

"WebHook"

url

Cílový koncový bod aktivity WebHook a cesta Typ: řetězec (nebo výraz s řetězcem resultType).

url: any

Hodnota vlastnosti

any

Podrobnosti zděděných vlastností

dependsOn

Aktivita závisí na podmínce.

dependsOn?: ActivityDependency[]

Hodnota vlastnosti

ActivityDependency[]

zděděno zControlActivity.dependsOn

description

Popis aktivity

description?: string

Hodnota vlastnosti

string

zděděno zControlActivity.description

name

Název aktivity

name: string

Hodnota vlastnosti

string

zděděné zControlActivity.name

onInactiveMarkAs

Výsledek stavu aktivity, pokud je stav nastaven na Neaktivní. Jedná se o volitelnou vlastnost a pokud není zadaná, když je aktivita neaktivní, stav bude ve výchozím nastavení Úspěšný.

onInactiveMarkAs?: string

Hodnota vlastnosti

string

zděděné zControlActivity.onInactiveMarkAs

state

Stav aktivity. Jedná se o volitelnou vlastnost a pokud není k dispozici, stav bude ve výchozím nastavení aktivní.

state?: string

Hodnota vlastnosti

string

zděděno zControlActivity.state

userProperties

Vlastnosti uživatele aktivity.

userProperties?: UserProperty[]

Hodnota vlastnosti

UserProperty[]

zděděno zControlActivity.userProperties