Compartilhar via


FailActivity interface

Essa atividade falhará dentro de seu próprio escopo e gerará uma mensagem de erro personalizada e um código de erro. A mensagem de erro e o código podem ser fornecidos como um literal de cadeia de caracteres ou como uma expressão que pode ser avaliada para uma cadeia de caracteres em runtime. O escopo da atividade pode ser todo o pipeline ou uma atividade de controle (por exemplo, foreach, switch, until), se a atividade de falha estiver contida nele.

Extends

Propriedades

errorCode

O código de erro que categoriza o tipo de erro da atividade Fail. Pode ser um conteúdo dinâmico avaliado para uma cadeia de caracteres não vazia/em branco no runtime. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

message

A mensagem de erro que surgiu na atividade Fail. Pode ser um conteúdo dinâmico avaliado para uma cadeia de caracteres não vazia/em branco no runtime. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

type

Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser

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 de atividade.

Detalhes da propriedade

errorCode

O código de erro que categoriza o tipo de erro da atividade Fail. Pode ser um conteúdo dinâmico avaliado para uma cadeia de caracteres não vazia/em branco no runtime. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

errorCode: any

Valor da propriedade

any

message

A mensagem de erro que surgiu na atividade Fail. Pode ser um conteúdo dinâmico avaliado para uma cadeia de caracteres não vazia/em branco no runtime. Tipo: cadeia de caracteres (ou Expressão com cadeia de caracteres resultType).

message: any

Valor da propriedade

any

type

Discriminatório polimórfico, que especifica os diferentes tipos que esse objeto pode ser

type: "Fail"

Valor da propriedade

"Fail"

Detalhes das propriedades herdadas

dependsOn

A atividade depende da condição.

dependsOn?: ActivityDependency[]

Valor da propriedade

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 de atividade.

userProperties?: UserProperty[]

Valor da propriedade

Herdado deControlActivity.userProperties