Aracılığıyla paylaş

WebHookActivity interface

  • Başvuru
Paket:
@azure/synapse-artifacts

Web Kancası etkinliği.

Extends
ControlActivity

Özellikler

authentication

Uç noktayı çağırmak için kullanılan kimlik doğrulama yöntemi.
body

Uç noktaya gönderilecek yükü temsil eder. POST/PUT yöntemi için gereklidir, GET yöntemi Türü için izin verilmez: dize (veya resultType dizeli ifade).
headers

İsteğe gönderilecek üst bilgileri temsil eder. Örneğin, bir istekte dili ve türü ayarlamak için: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tür: dize (veya resultType dizeli ifade).
method

Hedef uç nokta için Rest API yöntemi.
reportStatusOnCallBack

true olarak ayarlandığında, statusCode, geri çağırma isteği gövdesindeki çıkış ve hata etkinlik tarafından kullanılır. Geri çağırma isteğinde statusCode >= 400 ayarlanarak etkinlik başarısız olarak işaretlenebilir. Varsayılan değer false'tur. Tür: boolean (veya resultType boole değeriyle ifade).
timeout

Web kancasının geri çağrılması gereken zaman aşımı. Herhangi bir değer belirtilmezse, varsayılan olarak 10 dakika olur. Tür: dize. Desen: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).
type

Bu nesnenin olabileceği farklı türleri belirten polimorfik ayrımcı
url

Web Kancası etkinliği hedef uç noktası ve yolu. Tür: dize (veya resultType dizeli ifade).

Devralınan Özellikler

dependsOn

Etkinlik koşula bağlıdır.
description

Etkinlik açıklaması.
name

Etkinlik adı.
onInactiveMarkAs

Durum Etkin Değil olarak ayarlandığında etkinliğin durum sonucu. Bu isteğe bağlı bir özelliktir ve etkinlik etkin olmadığında sağlanmazsa, durum varsayılan olarak Başarılı olur.
state

Etkinlik durumu. Bu isteğe bağlı bir özelliktir ve sağlanmazsa, durum varsayılan olarak Etkin olur.
userProperties

Etkinlik kullanıcı özellikleri.

Özellik Ayrıntıları

authentication

Uç noktayı çağırmak için kullanılan kimlik doğrulama yöntemi.

authentication?: WebActivityAuthentication

Özellik Değeri

WebActivityAuthentication

body

Uç noktaya gönderilecek yükü temsil eder. POST/PUT yöntemi için gereklidir, GET yöntemi Türü için izin verilmez: dize (veya resultType dizeli ifade).

body?: any

Özellik Değeri

any

headers

İsteğe gönderilecek üst bilgileri temsil eder. Örneğin, bir istekte dili ve türü ayarlamak için: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tür: dize (veya resultType dizeli ifade).

headers?: any

Özellik Değeri

any

method

Hedef uç nokta için Rest API yöntemi.

method: string

Özellik Değeri

string

reportStatusOnCallBack

true olarak ayarlandığında, statusCode, geri çağırma isteği gövdesindeki çıkış ve hata etkinlik tarafından kullanılır. Geri çağırma isteğinde statusCode >= 400 ayarlanarak etkinlik başarısız olarak işaretlenebilir. Varsayılan değer false'tur. Tür: boolean (veya resultType boole değeriyle ifade).

reportStatusOnCallBack?: any

Özellik Değeri

any

timeout

Web kancasının geri çağrılması gereken zaman aşımı. Herhangi bir değer belirtilmezse, varsayılan olarak 10 dakika olur. Tür: dize. Desen: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).

timeout?: string

Özellik Değeri

string

type

Bu nesnenin olabileceği farklı türleri belirten polimorfik ayrımcı

type: "WebHook"

Özellik Değeri

"WebHook"

url

Web Kancası etkinliği hedef uç noktası ve yolu. Tür: dize (veya resultType dizeli ifade).

url: any

Özellik Değeri

any

Devralınan Özellik Detayları

dependsOn

Etkinlik koşula bağlıdır.

dependsOn?: ActivityDependency[]

Özellik Değeri

ActivityDependency[]

ControlActivity.dependsOn'dan Devralınmış

description

Etkinlik açıklaması.

description?: string

Özellik Değeri

string

ControlActivity.description Devralındı

name

Etkinlik adı.

name: string

Özellik Değeri

string

ControlActivity.name'dan Devralınan

onInactiveMarkAs

Durum Etkin Değil olarak ayarlandığında etkinliğin durum sonucu. Bu isteğe bağlı bir özelliktir ve etkinlik etkin olmadığında sağlanmazsa, durum varsayılan olarak Başarılı olur.

onInactiveMarkAs?: string

Özellik Değeri

string

ControlActivity.onInactiveMarkAs Devralınmış

state

Etkinlik durumu. Bu isteğe bağlı bir özelliktir ve sağlanmazsa, durum varsayılan olarak Etkin olur.

state?: string

Özellik Değeri

string

ControlActivity.stateDevralındı

userProperties

Etkinlik kullanıcı özellikleri.

userProperties?: UserProperty[]

Özellik Değeri

UserProperty[]

ControlActivity.userProperties Devralındı