BatchJob interface

Pacote:

@azure/batch

Um Trabalho Lote do Azure.

Propriedades

allowTaskPreemption	Se as tarefas neste trabalho podem ser preempidas por outros trabalhos de alta prioridade. (Essa 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 recolocar tarefas na fila desse trabalho. Você pode atualizar o allowTaskPreemption de um trabalho depois de ele ter sido criado usando a API de trabalho de atualização.
allTasksCompleteMode	A ação que o serviço lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído. O padrão é noaction.
commonEnvironmentSettings	A lista de configurações comuns de variável de ambiente. Essas variáveis de ambiente são definidas para todas as Tarefas no Trabalho (incluindo as Tarefas de Preparação de Trabalho, Preparação de Trabalho e Liberação de Trabalho). 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	A hora de criação do Trabalho.
displayName	O nome de exibição do Trabalho.
eTag	A ETag do Trabalho. Essa é uma cadeia de caracteres opaca. Você pode usá-lo para detectar se o Trabalho foi alterado entre solicitações. Em particular, você pode passar a ETag ao atualizar um Trabalho para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado o Trabalho enquanto isso.
executionInfo	As informações de execução do trabalho.
id	Uma cadeia de caracteres que identifica exclusivamente o Trabalho na Conta. A ID não diferencia maiúsculas de minúsculas e diferencia maiúsculas de minúsculas (ou seja, você pode não ter duas IDs em uma conta que diferem apenas por caso).
jobManagerTask	Detalhes de uma Tarefa do Gerenciador de Trabalhos a ser iniciada quando o Trabalho for iniciado.
jobPreparationTask	A tarefa de preparação do trabalho. A Tarefa preparação do trabalho é uma tarefa especial executada em cada nó de computação antes de qualquer outra tarefa do trabalho.
jobReleaseTask	A tarefa de liberação do 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.
jobStatistics	Estatísticas de uso de recursos durante todo o tempo de vida do trabalho. Essa propriedade será preenchida somente se o BatchJob tiver sido recuperado com uma cláusula de expansão, incluindo o atributo 'stats'; caso contrário, será nulo. As estatísticas podem não estar disponíveis imediatamente. O serviço do Lote executa a acumulação periódica de estatísticas. O atraso típico é de cerca de 30 minutos.
lastModified	A hora da última modificação do Trabalho. Esta é a última vez em que os dados de nível de trabalho, como o estado do trabalho ou a prioridade, foram alterados. Ele não leva em conta alterações no nível da tarefa, como adicionar novas tarefas ou tarefas alterando o estado.
maxParallelTasks	O número máximo de tarefas que podem ser executadas em paralelo para o trabalho. (Essa 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 ao mesmo tempo. Você pode atualizar maxParallelTasks de um trabalho depois de ele ter sido criado usando a API de trabalho de atualização.
metadata	Uma lista de pares nome-valor associados ao Trabalho como metadados. O serviço do Lote não atribui nenhum significado aos metadados; é apenas para o uso do código do usuário.
networkConfiguration	(Essa 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 do trabalho.
poolInfo	As configurações do Pool associadas ao Trabalho.
previousState	O estado anterior do trabalho. Essa propriedade não será definida se o Trabalho estiver em seu estado ativo inicial.
previousStateTransitionTime	A hora em que o Trabalho inseriu seu estado anterior. Essa propriedade não será definida se o Trabalho estiver em seu estado ativo inicial.
priority	A prioridade do Trabalho. Os valores de prioridade podem variar de -1000 a 1000, com -1000 sendo a prioridade mais baixa e 1000 sendo a prioridade mais alta. O valor padrão é 0.
state	O estado atual do Trabalho.
stateTransitionTime	A hora em que o Trabalho inseriu seu estado atual.
taskFailureMode	A ação que o serviço lote deve executar quando qualquer Tarefa no Trabalho falhar. Uma tarefa será considerada com falha se houver uma falhaInfo. Um failureInfo será definido se a Tarefa for concluída com um código de saída diferente de zero depois de esgotar sua contagem de repetições ou se houver um erro ao iniciar a Tarefa, por exemplo, devido a um erro de download de arquivo de recurso. O padrão é noaction.
url	A URL do Trabalho.
usesTaskDependencies	Se as tarefas no trabalho podem definir dependências entre si. O valor padrão é falso.

Detalhes da propriedade

allowTaskPreemption

Se as tarefas neste trabalho podem ser preempidas por outros trabalhos de alta prioridade. (Essa 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 recolocar tarefas na fila desse trabalho. Você pode atualizar o allowTaskPreemption de um trabalho depois de ele ter sido criado usando a API de trabalho de atualização.

allowTaskPreemption?: boolean

Valor da propriedade

boolean

allTasksCompleteMode

A ação que o serviço lote deve executar quando todas as Tarefas no Trabalho estão no estado concluído. O padrão é noaction.

allTasksCompleteMode?: BatchAllTasksCompleteMode

Valor da propriedade

BatchAllTasksCompleteMode

commonEnvironmentSettings

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

commonEnvironmentSettings?: EnvironmentSetting[]

Valor da propriedade

EnvironmentSetting[]

constraints

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

constraints?: BatchJobConstraints

Valor da propriedade

BatchJobConstraints

creationTime

A hora de criação do Trabalho.

creationTime: Date

Valor da propriedade

Date

displayName

O nome de exibição do Trabalho.

displayName?: string

Valor da propriedade

string

eTag

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

eTag: string

Valor da propriedade

string

executionInfo

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

executionInfo?: BatchJobExecutionInfo

Valor da propriedade

BatchJobExecutionInfo

id

Uma cadeia de caracteres que identifica exclusivamente o Trabalho na Conta. A ID não diferencia maiúsculas de minúsculas e diferencia maiúsculas de minúsculas (ou seja, você pode não ter duas IDs em uma conta que diferem apenas por caso).

id: string

Valor da propriedade

string

jobManagerTask

Detalhes de uma Tarefa do Gerenciador de Trabalhos a ser iniciada quando o Trabalho for iniciado.

jobManagerTask?: BatchJobManagerTask

Valor da propriedade

BatchJobManagerTask

jobPreparationTask

A tarefa de preparação do trabalho. A Tarefa preparação do trabalho é uma tarefa especial executada em cada nó de computação antes de qualquer outra tarefa do trabalho.

jobPreparationTask?: BatchJobPreparationTask

Valor da propriedade

BatchJobPreparationTask

jobReleaseTask

A tarefa de liberação do 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?: BatchJobReleaseTask

Valor da propriedade

BatchJobReleaseTask

jobStatistics

Estatísticas de uso de recursos durante todo o tempo de vida do trabalho. Essa propriedade será preenchida somente se o BatchJob tiver sido recuperado com uma cláusula de expansão, incluindo o atributo 'stats'; caso contrário, será nulo. As estatísticas podem não estar disponíveis imediatamente. O serviço do Lote executa a acumulação periódica de estatísticas. O atraso típico é de cerca de 30 minutos.

jobStatistics?: BatchJobStatistics

Valor da propriedade

BatchJobStatistics

lastModified

A hora da última modificação do Trabalho. Esta é a última vez em que os dados de nível de trabalho, como o estado do trabalho ou a prioridade, foram alterados. Ele não leva em conta alterações no nível da tarefa, como adicionar novas tarefas ou tarefas alterando o estado.

lastModified: Date

Valor da propriedade

Date

maxParallelTasks

O número máximo de tarefas que podem ser executadas em paralelo para o trabalho. (Essa 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 ao mesmo tempo. Você pode atualizar maxParallelTasks de um trabalho depois de ele ter sido criado usando a API de trabalho de atualização.

maxParallelTasks?: number

Valor da propriedade

number

metadata

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

metadata?: BatchMetadataItem[]

Valor da propriedade

BatchMetadataItem[]

networkConfiguration

(Essa 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 do trabalho.

networkConfiguration?: BatchJobNetworkConfiguration

Valor da propriedade

BatchJobNetworkConfiguration

poolInfo

As configurações do Pool associadas ao Trabalho.

poolInfo: BatchPoolInfo

Valor da propriedade

BatchPoolInfo

previousState

O estado anterior do trabalho. Essa propriedade não será definida se o Trabalho estiver em seu estado ativo inicial.

previousState?: BatchJobState

Valor da propriedade

BatchJobState

previousStateTransitionTime

A hora em que o Trabalho inseriu seu estado anterior. Essa propriedade não será definida se o Trabalho estiver em seu estado ativo inicial.

previousStateTransitionTime?: Date

Valor da propriedade

Date

priority

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

priority?: number

Valor da propriedade

number

state

O estado atual do Trabalho.

state: BatchJobState

Valor da propriedade

BatchJobState

stateTransitionTime

A hora em que o Trabalho inseriu seu estado atual.

stateTransitionTime: Date

Valor da propriedade

Date

taskFailureMode

A ação que o serviço lote deve executar quando qualquer Tarefa no Trabalho falhar. Uma tarefa será considerada com falha se houver uma falhaInfo. Um failureInfo será definido se a Tarefa for concluída com um código de saída diferente de zero depois de esgotar sua contagem de repetições ou se houver um erro ao iniciar a Tarefa, por exemplo, devido a um erro de download de arquivo de recurso. O padrão é noaction.

taskFailureMode?: BatchTaskFailureMode

Valor da propriedade

BatchTaskFailureMode

url

A URL do Trabalho.

url: string

Valor da propriedade

string

usesTaskDependencies

Se as tarefas no trabalho podem definir dependências entre si. O valor padrão é falso.

usesTaskDependencies?: boolean

Valor da propriedade

boolean