Compartilhar via

WebHookActivity interface

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

Atividade do WebHook.

Extends
ControlActivity

Propriedades

authentication

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

Representa o conteúdo que será enviado para o ponto de extremidade. Necessário para o método POST/PUT, não permitido para o método GET Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
headers

Representa os cabeçalhos que serão enviados para a solicitação. Por exemplo, para definir o idioma e o tipo em uma solicitação: "headers": { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).
method

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

Política de atividade.
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 com falha definindo statusCode >= 400 na solicitação de retorno de chamada. O padrão é false. Tipo: booliano (ou Expression com resultType boolean).
timeout

O tempo limite no qual o webhook deve ser chamado de volta. Se não houver nenhum valor especificado, o padrão será 10 minutos. Tipo: cadeia de caracteres. 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. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

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. Essa é uma propriedade opcional e, se não for fornecida quando a atividade estiver inativa, o status será Bem-sucedido por padrão.
state

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

Propriedades do usuário da atividade.

Detalhes da propriedade

authentication

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

authentication?: WebActivityAuthentication

Valor da propriedade

WebActivityAuthentication

body

Representa o conteúdo que será enviado para o ponto de extremidade. Necessário para o método POST/PUT, não permitido para o método GET Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

body?: any

Valor da propriedade

any

headers

Representa os cabeçalhos que serão enviados para a solicitação. Por exemplo, para definir o idioma e o tipo em uma solicitação: "headers": { "Accept-Language": "en-us", "Content-Type": "application/json" }. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

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

Valor da propriedade

{[propertyName: string]: any}

method

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

method: string

Valor da propriedade

string

policy

Política de atividade.

policy?: SecureInputOutputPolicy

Valor da 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 com falha definindo statusCode >= 400 na solicitação de retorno de chamada. O padrão é false. Tipo: booliano (ou Expression com resultType boolean).

reportStatusOnCallBack?: any

Valor da propriedade

any

timeout

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

timeout?: string

Valor da propriedade

string

type

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

type: "WebHook"

Valor da propriedade

"WebHook"

url

Ponto de extremidade e caminho de destino da atividade do WebHook. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

url: any

Valor da propriedade

any

Detalhes das propriedades herdadas

dependsOn

A atividade depende da condição.

dependsOn?: ActivityDependency[]

Valor da propriedade

ActivityDependency[]

Herdado deControlActivity.dependsOn

description

Descrição da atividade.

description?: string

Valor da propriedade

string

Herdado deControlActivity.description

name

Nome da atividade.

name: string

Valor da propriedade

string

Herdado deControlActivity.name

onInactiveMarkAs

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

onInactiveMarkAs?: string

Valor da propriedade

string

Herdado deControlActivity.onInactiveMarkAs

state

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

state?: string

Valor da propriedade

string

Herdado deControlActivity.state

userProperties

Propriedades do usuário da atividade.

userProperties?: UserProperty[]

Valor da propriedade

UserProperty[]

Herdado deControlActivity.userProperties