Partilhar via

WebHookActivity interface

  • Referência
Pacote:
@azure/arm-datafactory

Atividade WebHook.

Extends
ControlActivity

Propriedades

authentication

Método de autenticação usado para chamar o ponto de extremidade.
body

Representa a carga que será enviada para o ponto de extremidade. Necessário para o método POST/PUT, não permitido para o método GET Type: string (ou Expression with resultType string).
headers

Representa os cabeçalhos que serão enviados para a solicitação. Por exemplo, para definir o idioma e digitar em uma solicitação: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (ou Expression with resultType string).
method

Método da API Rest para o ponto de extremidade de destino.
policy

Política de atividades.
reportStatusOnCallBack

Quando definido como true, statusCode, saída e erro no corpo da solicitação de retorno de chamada serão consumidos pela atividade. A atividade pode ser marcada como falha definindo statusCode >= 400 na solicitação de retorno de chamada. O padrão é false. Tipo: booleano (ou Expressão com resultType booleano).
timeout

O tempo limite dentro do qual o webhook deve ser chamado de volta. Se não houver nenhum valor especificado, o padrão será de 10 minutos. Tipo: string. Padrão: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).
type

Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser
url

Ponto de extremidade e caminho de destino da atividade do WebHook. Type: string (ou Expression with resultType string).

Propriedades Herdadas

dependsOn

A atividade depende da condição.
description

Descrição da atividade.
name

Nome da atividade.
onInactiveMarkAs

Resultado do status da atividade quando o estado é definido como Inativo. Esta é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será Sucedido por padrão.
state

Estado da atividade. Esta é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.
userProperties

Propriedades do usuário da atividade.

Detalhes de Propriedade

authentication

Método de autenticação usado para chamar o ponto de extremidade.

authentication?: WebActivityAuthentication

Valor de Propriedade

WebActivityAuthentication

body

Representa a carga que será enviada para o ponto de extremidade. Necessário para o método POST/PUT, não permitido para o método GET Type: string (ou Expression with resultType string).

body?: any

Valor de Propriedade

any

headers

Representa os cabeçalhos que serão enviados para a solicitação. Por exemplo, para definir o idioma e digitar em uma solicitação: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (ou Expression with resultType string).

headers?: {[propertyName: string]: any}

Valor de Propriedade

{[propertyName: string]: any}

method

Método da API Rest para o ponto de extremidade de destino.

method: string

Valor de Propriedade

string

policy

Política de atividades.

policy?: SecureInputOutputPolicy

Valor de Propriedade

SecureInputOutputPolicy

reportStatusOnCallBack

Quando definido como true, statusCode, saída e erro no corpo da solicitação de retorno de chamada serão consumidos pela atividade. A atividade pode ser marcada como falha definindo statusCode >= 400 na solicitação de retorno de chamada. O padrão é false. Tipo: booleano (ou Expressão com resultType booleano).

reportStatusOnCallBack?: any

Valor de Propriedade

any

timeout

O tempo limite dentro do qual o webhook deve ser chamado de volta. Se não houver nenhum valor especificado, o padrão será de 10 minutos. Tipo: string. Padrão: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).

timeout?: string

Valor de Propriedade

string

type

Discriminador polimórfico, que especifica os diferentes tipos que este objeto pode ser

type: "WebHook"

Valor de Propriedade

"WebHook"

url

Ponto de extremidade e caminho de destino da atividade do WebHook. Type: string (ou Expression with resultType string).

url: any

Valor de Propriedade

any

Detalhes da Propriedade Herdada

dependsOn

A atividade depende da condição.

dependsOn?: ActivityDependency[]

Valor de Propriedade

ActivityDependency[]

herdado deControlActivity.dependsOn

description

Descrição da atividade.

description?: string

Valor de Propriedade

string

herdado deControlActivity.description

name

Nome da atividade.

name: string

Valor de Propriedade

string

herdada deControlActivity.name

onInactiveMarkAs

Resultado do status da atividade quando o estado é definido como Inativo. Esta é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será Sucedido por padrão.

onInactiveMarkAs?: string

Valor de Propriedade

string

herdado deControlActivity.onInactiveMarkAs

state

Estado da atividade. Esta é uma propriedade opcional e, se não for fornecida, o estado será Ativo por padrão.

state?: string

Valor de Propriedade

string

herdado deControlActivity.state

userProperties

Propriedades do usuário da atividade.

userProperties?: UserProperty[]

Valor de Propriedade

UserProperty[]

herdado deControlActivity.userProperties