WebHookActivity interface

Пакет:

@azure/synapse-artifacts

Действие WebHook.

Extends

ControlActivity

Свойства

authentication	Метод проверки подлинности, используемый для вызова конечной точки.
body	Представляет полезные данные, которые будут отправляться в конечную точку. Требуется для метода POST/PUT, не допускается для типа метода GET: string (или Expression с строкой resultType).
headers	Представляет заголовки, которые будут отправлены в запрос. Например, чтобы задать язык и тип для запроса: "заголовки": { "Accept-Language": "en-us", "Content-Type": "application/json" }. Тип: строка (или выражение с строкой resultType).
method	Метод REST API для целевой конечной точки.
reportStatusOnCallBack	Если задано значение true, statusCode, выходные данные и ошибка в тексте запроса обратного вызова будут использоваться действием. Действие можно пометить как неудачное, задав statusCode >= 400 в запросе обратного вызова. Значение по умолчанию — false. Тип: логический (или выражение с логическим типом результата).
timeout	Время ожидания, в течение которого должен вызываться веб-перехватчик. Если не указано значение, значение по умолчанию составляет 10 минут. Тип: строка. Шаблон: (\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).
type	Полиморфная дискриминация, указывающая различные типы этого объекта, может быть
url	Целевая конечная точка и путь действия WebHook. Тип: строка (или выражение с строкой resultType).

Унаследованные свойства

dependsOn	Действие зависит от условия.
description	Описание действия.
name	Имя действия.
onInactiveMarkAs	Результат состояния действия, если для состояния задано значение Inactive. Это необязательное свойство, если действие неактивно, состояние будет успешно выполнено по умолчанию.
state	Состояние действия. Это необязательное свойство, если оно не указано, состояние будет активным по умолчанию.
userProperties	Свойства пользователя действия.

Сведения о свойстве

authentication

Метод проверки подлинности, используемый для вызова конечной точки.

authentication?: WebActivityAuthentication

Значение свойства

WebActivityAuthentication

body

Представляет полезные данные, которые будут отправляться в конечную точку. Требуется для метода POST/PUT, не допускается для типа метода GET: string (или Expression с строкой 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 в запросе обратного вызова. Значение по умолчанию — false. Тип: логический (или выражение с логическим типом результата).

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

Результат состояния действия, если для состояния задано значение Inactive. Это необязательное свойство, если действие неактивно, состояние будет успешно выполнено по умолчанию.

onInactiveMarkAs?: string

Значение свойства

string

наследуется отControlActivity.onInactiveMarkAs

state

Состояние действия. Это необязательное свойство, если оно не указано, состояние будет активным по умолчанию.

state?: string

Значение свойства

string

наследуется отControlActivity.state

userProperties

Свойства пользователя действия.

userProperties?: UserProperty[]

Значение свойства

UserProperty[]

наследуется отControlActivity.userProperties