WebHookActivity interface

Pacchetto:

@azure/synapse-artifacts

Attività WebHook.

Extends

ControlActivity

Proprietà

authentication	Metodo di autenticazione usato per chiamare l'endpoint.
body	Rappresenta il payload che verrà inviato all'endpoint. Obbligatorio per il metodo POST/PUT, non consentito per il metodo GET Type: string (o Expression con stringa resultType).
headers	Rappresenta le intestazioni che verranno inviate alla richiesta. Ad esempio, per impostare la lingua e il tipo su una richiesta: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: stringa (o Espressione con stringa resultType).
method	Metodo DELL'API REST per l'endpoint di destinazione.
reportStatusOnCallBack	Se impostato su true, statusCode, output ed errore nel corpo della richiesta di callback verranno utilizzati dall'attività. L'attività può essere contrassegnata come non riuscita impostando statusCode >= 400 nella richiesta di callback. Il valore predefinito è false. Tipo: booleano (o espressione con valore booleano resultType).
timeout	Timeout entro il quale deve essere richiamato il webhook. Se non è specificato alcun valore, il valore predefinito è 10 minuti. Tipo: stringa. Modello: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).
type	Discriminare polimorfico, che specifica i diversi tipi che questo oggetto può essere
url	Endpoint e percorso dell'attività WebHook. Tipo: stringa (o Espressione con stringa resultType).

Proprietà ereditate

dependsOn	L'attività dipende dalla condizione.
description	Descrizione dell'attività.
name	Nome dell'attività.
onInactiveMarkAs	Risultato dello stato dell'attività quando lo stato è impostato su Inattivo. Si tratta di una proprietà facoltativa e, se non specificata quando l'attività è inattiva, lo stato sarà Succeeded per impostazione predefinita.
state	Stato dell'attività. Si tratta di una proprietà facoltativa e, se non specificato, lo stato sarà Attivo per impostazione predefinita.
userProperties	Proprietà utente attività.

Dettagli proprietà

authentication

Metodo di autenticazione usato per chiamare l'endpoint.

authentication?: WebActivityAuthentication

Valore della proprietà

WebActivityAuthentication

body

Rappresenta il payload che verrà inviato all'endpoint. Obbligatorio per il metodo POST/PUT, non consentito per il metodo GET Type: string (o Expression con stringa resultType).

body?: any

Valore della proprietà

any

headers

Rappresenta le intestazioni che verranno inviate alla richiesta. Ad esempio, per impostare la lingua e il tipo su una richiesta: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: stringa (o Espressione con stringa resultType).

headers?: any

Valore della proprietà

any

method

Metodo DELL'API REST per l'endpoint di destinazione.

method: string

Valore della proprietà

string

reportStatusOnCallBack

Se impostato su true, statusCode, output ed errore nel corpo della richiesta di callback verranno utilizzati dall'attività. L'attività può essere contrassegnata come non riuscita impostando statusCode >= 400 nella richiesta di callback. Il valore predefinito è false. Tipo: booleano (o espressione con valore booleano resultType).

reportStatusOnCallBack?: any

Valore della proprietà

any

timeout

Timeout entro il quale deve essere richiamato il webhook. Se non è specificato alcun valore, il valore predefinito è 10 minuti. Tipo: stringa. Modello: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).

timeout?: string

Valore della proprietà

string

type

Discriminare polimorfico, che specifica i diversi tipi che questo oggetto può essere

type: "WebHook"

Valore della proprietà

"WebHook"

url

Endpoint e percorso dell'attività WebHook. Tipo: stringa (o Espressione con stringa resultType).

url: any

Valore della proprietà

any

Dettagli proprietà ereditate

dependsOn

L'attività dipende dalla condizione.

dependsOn?: ActivityDependency[]

Valore della proprietà

ActivityDependency[]

ereditato daControlActivity.dependsOn

description

Descrizione dell'attività.

description?: string

Valore della proprietà

string

ereditato daControlActivity.description

name

Nome dell'attività.

name: string

Valore della proprietà

string

ereditato daControlActivity.name

onInactiveMarkAs

Risultato dello stato dell'attività quando lo stato è impostato su Inattivo. Si tratta di una proprietà facoltativa e, se non specificata quando l'attività è inattiva, lo stato sarà Succeeded per impostazione predefinita.

onInactiveMarkAs?: string

Valore della proprietà

string

ereditato daControlActivity.onInactiveMarkAs

state

Stato dell'attività. Si tratta di una proprietà facoltativa e, se non specificato, lo stato sarà Attivo per impostazione predefinita.

state?: string

Valore della proprietà

string

ereditato daControlActivity.state

userProperties

Proprietà utente attività.

userProperties?: UserProperty[]

Valore della proprietà

UserProperty[]

ereditato daControlActivity.userProperties