WebHookActivity interface

Pakiet:

@azure/synapse-artifacts

Działanie elementu webhook.

Rozszerzenie

ControlActivity

Właściwości

authentication	Metoda uwierzytelniania używana do wywoływania punktu końcowego.
body	Reprezentuje ładunek, który zostanie wysłany do punktu końcowego. Wymagana dla metody POST/PUT niedozwolona dla metody GET Type: string (lub Expression with resultType string).
headers	Reprezentuje nagłówki, które zostaną wysłane do żądania. Aby na przykład ustawić język i wpisać żądanie: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Typ: ciąg (lub wyrażenie z ciągiem resultType).
method	Metoda interfejsu API REST dla docelowego punktu końcowego.
reportStatusOnCallBack	Jeśli ustawienie ma wartość true, statusCode, dane wyjściowe i błąd w treści żądania wywołania zwrotnego będą używane przez działanie. Działanie można oznaczyć jako nieudane, ustawiając wartość statusCode >= 400 w żądaniu wywołania zwrotnego. Wartość domyślna to false. Typ: wartość logiczna (lub wyrażenie z wartością logiczną resultType).
timeout	Limit czasu, w którym element webhook powinien zostać wywołany z powrotem. Jeśli nie określono żadnej wartości, wartość domyślna to 10 minut. Typ: ciąg. Wzorzec: ((\d+).)? (\d\d):(60|( [0-5] [0–9])):(60|( [0-5] [0-9])).
type	Dyskryminujący polimorficzny, który określa różne typy tego obiektu może być
url	Docelowy punkt końcowy działania elementu webhook i ścieżka. Typ: ciąg (lub wyrażenie z ciągiem resultType).

Właściwości dziedziczone

dependsOn	Działanie zależy od warunku.
description	Opis działania.
name	Nazwa działania.
onInactiveMarkAs	Wynik stanu działania, gdy stan jest ustawiony na Nieaktywny. Jest to właściwość opcjonalna i jeśli nie zostanie podana, gdy działanie jest nieaktywne, stan to Powodzenie domyślnie.
state	Stan działania. Jest to właściwość opcjonalna i jeśli nie zostanie podana, stan będzie domyślnie aktywny.
userProperties	Właściwości użytkownika działania.

Szczegóły właściwości

authentication

Metoda uwierzytelniania używana do wywoływania punktu końcowego.

authentication?: WebActivityAuthentication

Wartość właściwości

WebActivityAuthentication

body

Reprezentuje ładunek, który zostanie wysłany do punktu końcowego. Wymagana dla metody POST/PUT niedozwolona dla metody GET Type: string (lub Expression with resultType string).

body?: any

Wartość właściwości

any

headers

Reprezentuje nagłówki, które zostaną wysłane do żądania. Aby na przykład ustawić język i wpisać żądanie: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Typ: ciąg (lub wyrażenie z ciągiem resultType).

headers?: any

Wartość właściwości

any

method

Metoda interfejsu API REST dla docelowego punktu końcowego.

method: string

Wartość właściwości

string

reportStatusOnCallBack

Jeśli ustawienie ma wartość true, statusCode, dane wyjściowe i błąd w treści żądania wywołania zwrotnego będą używane przez działanie. Działanie można oznaczyć jako nieudane, ustawiając wartość statusCode >= 400 w żądaniu wywołania zwrotnego. Wartość domyślna to false. Typ: wartość logiczna (lub wyrażenie z wartością logiczną resultType).

reportStatusOnCallBack?: any

Wartość właściwości

any

timeout

Limit czasu, w którym element webhook powinien zostać wywołany z powrotem. Jeśli nie określono żadnej wartości, wartość domyślna to 10 minut. Typ: ciąg. Wzorzec: ((\d+).)? (\d\d):(60|( [0-5] [0–9])):(60|( [0-5] [0-9])).

timeout?: string

Wartość właściwości

string

type

Dyskryminujący polimorficzny, który określa różne typy tego obiektu może być

type: "WebHook"

Wartość właściwości

"WebHook"

url

Docelowy punkt końcowy działania elementu webhook i ścieżka. Typ: ciąg (lub wyrażenie z ciągiem resultType).

url: any

Wartość właściwości

any

Szczegóły właściwości dziedziczonej

dependsOn

Działanie zależy od warunku.

dependsOn?: ActivityDependency[]

Wartość właściwości

ActivityDependency[]

dziedziczone zControlActivity.dependsOn

description

Opis działania.

description?: string

Wartość właściwości

string

dziedziczone zControlActivity.description

name

Nazwa działania.

name: string

Wartość właściwości

string

dziedziczone zControlActivity.name

onInactiveMarkAs

Wynik stanu działania, gdy stan jest ustawiony na Nieaktywny. Jest to właściwość opcjonalna i jeśli nie zostanie podana, gdy działanie jest nieaktywne, stan to Powodzenie domyślnie.

onInactiveMarkAs?: string

Wartość właściwości

string

dziedziczone zControlActivity.onInactiveMarkAs

state

Stan działania. Jest to właściwość opcjonalna i jeśli nie zostanie podana, stan będzie domyślnie aktywny.

state?: string

Wartość właściwości

string

dziedziczone zControlActivity.state

userProperties

Właściwości użytkownika działania.

userProperties?: UserProperty[]

Wartość właściwości

UserProperty[]

dziedziczone zControlActivity.userProperties