BatchJobOutput interface

Pacote:

@azure-rest/batch

Um trabalho em lote do Azure.

Propriedades

allowTaskPreemption	Se as tarefas neste trabalho podem ser antecipadas por outros trabalhos de alta prioridade. (Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) Se o valor for definido como True, outros trabalhos de alta prioridade enviados ao sistema terão precedência e poderão enfileirar novamente as tarefas desse trabalho. Você pode atualizar allowTaskPreemption de um trabalho depois que ele tiver sido criado usando a API do trabalho de atualização.
commonEnvironmentSettings	A lista de configurações de variáveis de ambiente comuns. Essas variáveis de ambiente são definidas para todas as Tarefas no Trabalho (incluindo o Gerenciador de Tarefas, Preparação de Trabalho e Tarefas de Liberação de Trabalho). As Tarefas Individuais podem substituir uma configuração de ambiente especificada aqui, especificando o mesmo nome de configuração com um valor diferente.
constraints	As restrições de execução para o trabalho.
creationTime	O tempo de criação do Job.
displayName	O nome para exibição do trabalho.
eTag	O ETag do Trabalho. Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detetar se o trabalho foi alterado entre as solicitações. Em particular, você pode passar o ETag ao atualizar um trabalho para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado o trabalho entretanto.
executionInfo	As informações de execução para o trabalho.
id	Uma cadeia de caracteres que identifica exclusivamente o Trabalho dentro da Conta. O ID preserva maiúsculas e minúsculas (ou seja, você não pode ter dois IDs em uma Conta que diferem apenas por maiúsculas e minúsculas).
jobManagerTask	Detalhes de uma Tarefa do Gerenciador de Tarefas a ser iniciada quando a Tarefa for iniciada.
jobPreparationTask	A Tarefa de Preparação do Trabalho. A Tarefa de Preparação de Trabalho é uma Tarefa especial executada em cada Nó de Computação antes de qualquer outra Tarefa do Trabalho.
jobReleaseTask	A tarefa de liberação de trabalho. A Tarefa de Liberação de Trabalho é uma Tarefa especial executada no final do Trabalho em cada Nó de Computação que executou qualquer outra Tarefa do Trabalho.
lastModified	A última hora modificada do Job. Esta é a última vez em que os dados de nível de trabalho, como o estado ou a prioridade do trabalho, foram alterados. Ele não leva em consideração as alterações no nível da tarefa, como a adição de novas Tarefas ou Tarefas alterando o estado.
maxParallelTasks	O número máximo de tarefas que podem ser executadas em paralelo para o trabalho. (Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) O valor de maxParallelTasks deve ser -1 ou maior que 0, se especificado. Se não for especificado, o valor padrão será -1, o que significa que não há limite para o número de tarefas que podem ser executadas de uma só vez. Você pode atualizar maxParallelTasks de um trabalho depois que ele tiver sido criado usando a API do trabalho de atualização.
metadata	Uma lista de pares nome-valor associados ao Job como metadados. O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário.
networkConfiguration	(Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) A configuração de rede para o trabalho.
onAllTasksComplete	A ação que o serviço em lote deve executar quando todas as tarefas no trabalho estiverem no estado concluído. O padrão é noaction. Valores possíveis: "noaction", "terminatejob"
onTaskFailure	A ação que o serviço em lote deve executar quando qualquer tarefa no trabalho falhar. Uma tarefa é considerada como tendo falhado se tiver uma failureInfo. Um failureInfo é definido se a Tarefa for concluída com um código de saída diferente de zero depois de esgotar sua contagem de novas tentativas, ou se houver um erro ao iniciar a Tarefa, por exemplo, devido a um erro de download do arquivo de recurso. O padrão é noaction. Valores possíveis: "noaction", "performexitoptionsjobaction"
poolInfo	As configurações do Pool associadas ao Trabalho.
previousState	O estado anterior do Jó. Esta propriedade não será definida se o Job estiver em seu estado Ativo inicial. Valores possíveis: "ativo", "desativando", "desativado", "habilitando", "terminando", "concluído", "excluindo"
previousStateTransitionTime	O momento em que o Job entrou em seu estado anterior. Esta propriedade não será definida se o Job estiver em seu estado Ativo inicial.
priority	A prioridade do Trabalho. Os valores de prioridade podem variar de -1000 a 1000, sendo -1000 a prioridade mais baixa e 1000 a prioridade mais alta. O valor padrão é 0.
state	O estado atual do Job. Valores possíveis: "ativo", "desativando", "desativado", "habilitando", "terminando", "concluído", "excluindo"
stateTransitionTime	O momento em que o Job entrou em seu estado atual.
stats	Estatísticas de uso de recursos para todo o tempo de vida do trabalho. Esta propriedade é preenchida somente se o BatchJob foi recuperado com uma cláusula de expansão incluindo o atributo 'stats'; caso contrário, é nulo. As estatísticas podem não estar imediatamente disponíveis. O serviço Batch executa o roll-up periódico de estatísticas. O atraso típico é de cerca de 30 minutos.
url	A URL do trabalho.
usesTaskDependencies	Se as Tarefas no Trabalho podem definir dependências entre si. O padrão é false.

Detalhes de Propriedade

allowTaskPreemption

Se as tarefas neste trabalho podem ser antecipadas por outros trabalhos de alta prioridade. (Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) Se o valor for definido como True, outros trabalhos de alta prioridade enviados ao sistema terão precedência e poderão enfileirar novamente as tarefas desse trabalho. Você pode atualizar allowTaskPreemption de um trabalho depois que ele tiver sido criado usando a API do trabalho de atualização.

allowTaskPreemption?: boolean

Valor de Propriedade

boolean

commonEnvironmentSettings

A lista de configurações de variáveis de ambiente comuns. Essas variáveis de ambiente são definidas para todas as Tarefas no Trabalho (incluindo o Gerenciador de Tarefas, Preparação de Trabalho e Tarefas de Liberação de Trabalho). As Tarefas Individuais podem substituir uma configuração de ambiente especificada aqui, especificando o mesmo nome de configuração com um valor diferente.

commonEnvironmentSettings?: EnvironmentSettingOutput[]

Valor de Propriedade

EnvironmentSettingOutput[]

constraints

As restrições de execução para o trabalho.

constraints?: BatchJobConstraintsOutput

Valor de Propriedade

BatchJobConstraintsOutput

creationTime

O tempo de criação do Job.

creationTime: string

Valor de Propriedade

string

displayName

O nome para exibição do trabalho.

displayName?: string

Valor de Propriedade

string

eTag

O ETag do Trabalho. Esta é uma cadeia de caracteres opaca. Você pode usá-lo para detetar se o trabalho foi alterado entre as solicitações. Em particular, você pode passar o ETag ao atualizar um trabalho para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado o trabalho entretanto.

eTag: string

Valor de Propriedade

string

executionInfo

As informações de execução para o trabalho.

executionInfo?: BatchJobExecutionInfoOutput

Valor de Propriedade

BatchJobExecutionInfoOutput

id

Uma cadeia de caracteres que identifica exclusivamente o Trabalho dentro da Conta. O ID preserva maiúsculas e minúsculas (ou seja, você não pode ter dois IDs em uma Conta que diferem apenas por maiúsculas e minúsculas).

id: string

Valor de Propriedade

string

jobManagerTask

Detalhes de uma Tarefa do Gerenciador de Tarefas a ser iniciada quando a Tarefa for iniciada.

jobManagerTask?: BatchJobManagerTaskOutput

Valor de Propriedade

BatchJobManagerTaskOutput

jobPreparationTask

A Tarefa de Preparação do Trabalho. A Tarefa de Preparação de Trabalho é uma Tarefa especial executada em cada Nó de Computação antes de qualquer outra Tarefa do Trabalho.

jobPreparationTask?: BatchJobPreparationTaskOutput

Valor de Propriedade

BatchJobPreparationTaskOutput

jobReleaseTask

A tarefa de liberação de trabalho. A Tarefa de Liberação de Trabalho é uma Tarefa especial executada no final do Trabalho em cada Nó de Computação que executou qualquer outra Tarefa do Trabalho.

jobReleaseTask?: BatchJobReleaseTaskOutput

Valor de Propriedade

BatchJobReleaseTaskOutput

lastModified

A última hora modificada do Job. Esta é a última vez em que os dados de nível de trabalho, como o estado ou a prioridade do trabalho, foram alterados. Ele não leva em consideração as alterações no nível da tarefa, como a adição de novas Tarefas ou Tarefas alterando o estado.

lastModified: string

Valor de Propriedade

string

maxParallelTasks

O número máximo de tarefas que podem ser executadas em paralelo para o trabalho. (Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) O valor de maxParallelTasks deve ser -1 ou maior que 0, se especificado. Se não for especificado, o valor padrão será -1, o que significa que não há limite para o número de tarefas que podem ser executadas de uma só vez. Você pode atualizar maxParallelTasks de um trabalho depois que ele tiver sido criado usando a API do trabalho de atualização.

maxParallelTasks?: number

Valor de Propriedade

number

metadata

Uma lista de pares nome-valor associados ao Job como metadados. O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário.

metadata?: BatchMetadataItemOutput[]

Valor de Propriedade

BatchMetadataItemOutput[]

networkConfiguration

(Esta propriedade não está disponível por padrão. Entre em contato com o suporte para obter mais informações) A configuração de rede para o trabalho.

networkConfiguration?: BatchJobNetworkConfigurationOutput

Valor de Propriedade

BatchJobNetworkConfigurationOutput

onAllTasksComplete

A ação que o serviço em lote deve executar quando todas as tarefas no trabalho estiverem no estado concluído. O padrão é noaction.

Valores possíveis: "noaction", "terminatejob"

onAllTasksComplete?: string

Valor de Propriedade

string

onTaskFailure

A ação que o serviço em lote deve executar quando qualquer tarefa no trabalho falhar. Uma tarefa é considerada como tendo falhado se tiver uma failureInfo. Um failureInfo é definido se a Tarefa for concluída com um código de saída diferente de zero depois de esgotar sua contagem de novas tentativas, ou se houver um erro ao iniciar a Tarefa, por exemplo, devido a um erro de download do arquivo de recurso. O padrão é noaction.

Valores possíveis: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Valor de Propriedade

string

poolInfo

As configurações do Pool associadas ao Trabalho.

poolInfo: BatchPoolInfoOutput

Valor de Propriedade

BatchPoolInfoOutput

previousState

O estado anterior do Jó. Esta propriedade não será definida se o Job estiver em seu estado Ativo inicial.

Valores possíveis: "ativo", "desativando", "desativado", "habilitando", "terminando", "concluído", "excluindo"

previousState?: string

Valor de Propriedade

string

previousStateTransitionTime

O momento em que o Job entrou em seu estado anterior. Esta propriedade não será definida se o Job estiver em seu estado Ativo inicial.

previousStateTransitionTime?: string

Valor de Propriedade

string

priority

A prioridade do Trabalho. Os valores de prioridade podem variar de -1000 a 1000, sendo -1000 a prioridade mais baixa e 1000 a prioridade mais alta. O valor padrão é 0.

priority?: number

Valor de Propriedade

number

state

O estado atual do Job.

Valores possíveis: "ativo", "desativando", "desativado", "habilitando", "terminando", "concluído", "excluindo"

state: string

Valor de Propriedade

string

stateTransitionTime

O momento em que o Job entrou em seu estado atual.

stateTransitionTime: string

Valor de Propriedade

string

stats

Estatísticas de uso de recursos para todo o tempo de vida do trabalho. Esta propriedade é preenchida somente se o BatchJob foi recuperado com uma cláusula de expansão incluindo o atributo 'stats'; caso contrário, é nulo. As estatísticas podem não estar imediatamente disponíveis. O serviço Batch executa o roll-up periódico de estatísticas. O atraso típico é de cerca de 30 minutos.

stats?: BatchJobStatisticsOutput

Valor de Propriedade

BatchJobStatisticsOutput

url

A URL do trabalho.

url: string

Valor de Propriedade

string

usesTaskDependencies

Se as Tarefas no Trabalho podem definir dependências entre si. O padrão é false.

usesTaskDependencies?: boolean

Valor de Propriedade

boolean