WebHookActivity interface

Pakket:

@azure/synapse-artifacts

WebHook-activiteit.

Uitbreiding

ControlActivity

Eigenschappen

authentication	Verificatiemethode die wordt gebruikt voor het aanroepen van het eindpunt.
body	Vertegenwoordigt de nettolading die naar het eindpunt wordt verzonden. Vereist voor post/PUT-methode, niet toegestaan voor get-methodetype: tekenreeks (of expressie met resultType-tekenreeks).
headers	Vertegenwoordigt de headers die naar de aanvraag worden verzonden. Als u bijvoorbeeld de taal en het type wilt instellen voor een aanvraag: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: tekenreeks (of expressie met resultType-tekenreeks).
method	Rest API-methode voor doeleindpunt.
reportStatusOnCallBack	Wanneer deze is ingesteld op waar, worden statusCode, uitvoer en fout in de hoofdtekst van de callback-aanvraag verbruikt door activiteit. De activiteit kan worden gemarkeerd als mislukt door statusCode in te stellen >= 400 in callback-aanvraag. De standaardwaarde is onwaar. Type: Booleaanse waarde (of expressie met resultType booleaanse waarde).
timeout	De time-out waarin de webhook moet worden teruggeroepen. Als er geen waarde is opgegeven, wordt deze standaard ingesteld op 10 minuten. Type: tekenreeks. Patroon: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).
type	Polymorf discriminator, waarmee de verschillende typen dit object kunnen worden opgegeven
url	Doeleindpunt en pad van webhookactiviteit. Type: tekenreeks (of expressie met resultType-tekenreeks).

Overgenomen eigenschappen

dependsOn	Activiteit is afhankelijk van voorwaarde.
description	Beschrijving van activiteit.
name	Naam van activiteit.
onInactiveMarkAs	Statusresultaat van de activiteit wanneer de status is ingesteld op Inactief. Dit is een optionele eigenschap en als deze niet wordt opgegeven wanneer de activiteit inactief is, wordt de status standaard geslaagd.
state	Activiteitsstatus. Dit is een optionele eigenschap en indien niet opgegeven, is de status standaard actief.
userProperties	Eigenschappen van activiteitsgebruikers.

Eigenschapdetails

authentication

Verificatiemethode die wordt gebruikt voor het aanroepen van het eindpunt.

authentication?: WebActivityAuthentication

Waarde van eigenschap

WebActivityAuthentication

body

Vertegenwoordigt de nettolading die naar het eindpunt wordt verzonden. Vereist voor post/PUT-methode, niet toegestaan voor get-methodetype: tekenreeks (of expressie met resultType-tekenreeks).

body?: any

Waarde van eigenschap

any

headers

Vertegenwoordigt de headers die naar de aanvraag worden verzonden. Als u bijvoorbeeld de taal en het type wilt instellen voor een aanvraag: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: tekenreeks (of expressie met resultType-tekenreeks).

headers?: any

Waarde van eigenschap

any

method

Rest API-methode voor doeleindpunt.

method: string

Waarde van eigenschap

string

reportStatusOnCallBack

Wanneer deze is ingesteld op waar, worden statusCode, uitvoer en fout in de hoofdtekst van de callback-aanvraag verbruikt door activiteit. De activiteit kan worden gemarkeerd als mislukt door statusCode in te stellen >= 400 in callback-aanvraag. De standaardwaarde is onwaar. Type: Booleaanse waarde (of expressie met resultType booleaanse waarde).

reportStatusOnCallBack?: any

Waarde van eigenschap

any

timeout

De time-out waarin de webhook moet worden teruggeroepen. Als er geen waarde is opgegeven, wordt deze standaard ingesteld op 10 minuten. Type: tekenreeks. Patroon: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).

timeout?: string

Waarde van eigenschap

string

type

Polymorf discriminator, waarmee de verschillende typen dit object kunnen worden opgegeven

type: "WebHook"

Waarde van eigenschap

"WebHook"

url

Doeleindpunt en pad van webhookactiviteit. Type: tekenreeks (of expressie met resultType-tekenreeks).

url: any

Waarde van eigenschap

any

Details van overgenomen eigenschap

dependsOn

Activiteit is afhankelijk van voorwaarde.

dependsOn?: ActivityDependency[]

Waarde van eigenschap

ActivityDependency[]

overgenomen vanControlActivity.dependsOn

description

Beschrijving van activiteit.

description?: string

Waarde van eigenschap

string

overgenomen vanControlActivity.description

name

Naam van activiteit.

name: string

Waarde van eigenschap

string

overgenomen vanControlActivity.name

onInactiveMarkAs

Statusresultaat van de activiteit wanneer de status is ingesteld op Inactief. Dit is een optionele eigenschap en als deze niet wordt opgegeven wanneer de activiteit inactief is, wordt de status standaard geslaagd.

onInactiveMarkAs?: string

Waarde van eigenschap

string

overgenomen vanControlActivity.onInactiveMarkAs

state

Activiteitsstatus. Dit is een optionele eigenschap en indien niet opgegeven, is de status standaard actief.

state?: string

Waarde van eigenschap

string

overgenomen vanControlActivity.state

userProperties

Eigenschappen van activiteitsgebruikers.

userProperties?: UserProperty[]

Waarde van eigenschap

UserProperty[]

overgenomen vanControlActivity.userProperties-