WebHookActivity interface

الحزمة:

@azure/synapse-artifacts

نشاط WebHook.

يمتد

ControlActivity

الخصائص

authentication	أسلوب المصادقة المستخدم لاستدعاء نقطة النهاية.
body	يمثل الحمولة التي سيتم إرسالها إلى نقطة النهاية. مطلوب لأسلوب POST/PUT، غير مسموح به لنوع أسلوب GET: سلسلة (أو تعبير مع سلسلة resultType).
headers	يمثل الرؤوس التي سيتم إرسالها إلى الطلب. على سبيل المثال، لتعيين اللغة والكتابة بناء على طلب: "رؤوس" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. النوع: سلسلة (أو تعبير مع سلسلة resultType).
method	طريقة Rest API لنقطة النهاية الهدف.
reportStatusOnCallBack	عند التعيين إلى true، سيتم استهلاك statusCode والإخراج والخطأ في نص طلب رد الاتصال بواسطة النشاط. يمكن وضع علامة على النشاط على أنه فشل عن طريق تعيين statusCode >= 400 في طلب رد الاتصال. الافتراضي هو خطأ. النوع: منطقي (أو تعبير مع قيمة منطقية ل resultType).
timeout	المهلة التي يجب استدعاء خطاف الويب خلالها مرة أخرى. إذا لم يتم تحديد قيمة، تعيينها افتراضيا إلى 10 دقائق. النوع: سلسلة. النمط: ((\d+).)؟ (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).
type	تمييزي متعدد الأشكال، والذي يحدد الأنواع المختلفة التي يمكن أن يكون هذا الكائن
url	نقطة نهاية ومسار هدف نشاط WebHook. النوع: سلسلة (أو تعبير مع سلسلة resultType).

الخصائص الموروثة

dependsOn	يعتمد النشاط على الشرط.
description	وصف النشاط.
name	اسم النشاط.
onInactiveMarkAs	نتيجة الحالة للنشاط عند تعيين الحالة إلى غير نشط. هذه خاصية اختيارية وإذا لم يتم توفيرها عندما يكون النشاط غير نشط، نجاح الحالة بشكل افتراضي.
state	حالة النشاط. هذه خاصية اختيارية وإذا لم يتم توفيرها، ستكون الحالة نشطة بشكل افتراضي.
userProperties	خصائص مستخدم النشاط.

تفاصيل الخاصية

authentication

أسلوب المصادقة المستخدم لاستدعاء نقطة النهاية.

authentication?: WebActivityAuthentication

قيمة الخاصية

WebActivityAuthentication

body

يمثل الحمولة التي سيتم إرسالها إلى نقطة النهاية. مطلوب لأسلوب POST/PUT، غير مسموح به لنوع أسلوب GET: سلسلة (أو تعبير مع سلسلة resultType).

body?: any

قيمة الخاصية

any

headers

يمثل الرؤوس التي سيتم إرسالها إلى الطلب. على سبيل المثال، لتعيين اللغة والكتابة بناء على طلب: "رؤوس" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. النوع: سلسلة (أو تعبير مع سلسلة resultType).

headers?: any

قيمة الخاصية

any

method

طريقة Rest API لنقطة النهاية الهدف.

method: string

قيمة الخاصية

string

reportStatusOnCallBack

عند التعيين إلى true، سيتم استهلاك statusCode والإخراج والخطأ في نص طلب رد الاتصال بواسطة النشاط. يمكن وضع علامة على النشاط على أنه فشل عن طريق تعيين statusCode >= 400 في طلب رد الاتصال. الافتراضي هو خطأ. النوع: منطقي (أو تعبير مع قيمة منطقية ل resultType).

reportStatusOnCallBack?: any

قيمة الخاصية

any

timeout

المهلة التي يجب استدعاء خطاف الويب خلالها مرة أخرى. إذا لم يتم تحديد قيمة، تعيينها افتراضيا إلى 10 دقائق. النوع: سلسلة. النمط: ((\d+).)؟ (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).

timeout?: string

قيمة الخاصية

string

type

تمييزي متعدد الأشكال، والذي يحدد الأنواع المختلفة التي يمكن أن يكون هذا الكائن

type: "WebHook"

قيمة الخاصية

"WebHook"

url

نقطة نهاية ومسار هدف نشاط WebHook. النوع: سلسلة (أو تعبير مع سلسلة resultType).

url: any

قيمة الخاصية

any

تفاصيل الخاصية الموروثة

dependsOn

يعتمد النشاط على الشرط.

dependsOn?: ActivityDependency[]

قيمة الخاصية

ActivityDependency[]

موروث منControlActivity.dependsOn

description

وصف النشاط.

description?: string

قيمة الخاصية

string

موروث منControlActivity.description

name

اسم النشاط.

name: string

قيمة الخاصية

string

موروث منControlActivity.name

onInactiveMarkAs

نتيجة الحالة للنشاط عند تعيين الحالة إلى غير نشط. هذه خاصية اختيارية وإذا لم يتم توفيرها عندما يكون النشاط غير نشط، نجاح الحالة بشكل افتراضي.

onInactiveMarkAs?: string

قيمة الخاصية

string

موروثة منControlActivity.onInactiveMarkAs

state

حالة النشاط. هذه خاصية اختيارية وإذا لم يتم توفيرها، ستكون الحالة نشطة بشكل افتراضي.

state?: string

قيمة الخاصية

string

موروث منControlActivity.state

userProperties

خصائص مستخدم النشاط.

userProperties?: UserProperty[]

قيمة الخاصية

UserProperty[]

موروث منControlActivity.userProperties