BatchJobSpecificationOutput interface

Pacote:

@azure-rest/batch

Especifica os detalhes dos Trabalhos a serem criados em um agendamento.

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.
commonEnvironmentSettings	Uma lista de configurações comuns de variável de ambiente. Essas variáveis de ambiente são definidas para todas as Tarefas em Trabalhos criadas nessa agenda (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 trabalhos criados nessa agenda.
displayName	O nome de exibição para trabalhos criados nessa agenda. O nome não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
jobManagerTask	Os detalhes de uma Tarefa do Gerenciador de Trabalhos a ser iniciada quando um trabalho é iniciado nessa agenda. Se o Trabalho não especificar uma Tarefa do Gerenciador de Trabalhos, o usuário deverá adicionar explicitamente Tarefas ao Trabalho usando a API de Tarefa. Se o Trabalho especificar uma Tarefa do Gerenciador de Trabalhos, o serviço Do Lote criará a Tarefa do Gerenciador de Trabalhos quando o Trabalho for criado e tentará agendar a Tarefa do Gerenciador de Trabalhos antes de agendar outras tarefas no Trabalho.
jobPreparationTask	A Tarefa de Preparação do Trabalho para Trabalhos criada neste agendamento. Se um trabalho tiver uma tarefa de preparação de trabalho, o serviço do Lote executará a Tarefa de Preparação de Trabalho em um nó antes de iniciar qualquer tarefa desse trabalho nesse nó de computação.
jobReleaseTask	A Tarefa de Liberação de Trabalho para Trabalhos criada nessa agenda. A principal finalidade da Tarefa de Liberação de Trabalho é desfazer alterações em nós feitas pela Tarefa de Preparação do Trabalho. As atividades de exemplo incluem a exclusão de arquivos locais ou o desligamento de serviços que foram iniciados como parte da preparação do trabalho. Uma tarefa de liberação de trabalho não pode ser especificada sem especificar também uma tarefa de preparação de trabalho para o trabalho. O serviço Lote executa a Tarefa de Liberação de Trabalho nos Nós de Computação que executaram a Tarefa de Preparação do Trabalho.
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 a cada trabalho criado nesse agendamento 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.
onAllTasksComplete	A ação que o serviço lote deve executar quando todas as Tarefas em um Trabalho criadas nesse agendamento estão no estado concluído. Observe que, se um trabalho não contiver Tarefas, todas as Tarefas serão consideradas concluídas. Essa opção é, portanto, mais comumente usada com uma tarefa do Gerenciador de Trabalhos; se você quiser usar a terminação automática de trabalho sem um Gerenciador de Trabalhos, inicialmente deverá definir emAllTasksComplete para noaction e atualizar as propriedades de trabalho a serem definidas emAllTasksComplete para encerrar o trabalho depois de terminar de adicionar Tarefas. O padrão é noaction. Valores possíveis: "noaction", "terminatejob"
onTaskFailure	A ação que o serviço do Lote deve executar quando qualquer Tarefa falha em um trabalho criado neste agendamento. Uma tarefa será considerada com falha se tiver falhado se tiver um failureInfo. 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. Valores possíveis: "noaction", "performexitoptionsjobaction"
poolInfo	O pool no qual o serviço do Lote executa as Tarefas de Trabalhos criadas nesse agendamento.
priority	A prioridade dos trabalhos criados nessa agenda. 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. Essa prioridade é usada como o padrão para todos os trabalhos na Agenda de Trabalho. Você pode atualizar a prioridade de um trabalho depois que ele tiver sido criado usando a API de trabalho de atualização.
usesTaskDependencies	Se as tarefas no trabalho podem definir dependências entre si. O padrão é false.

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

commonEnvironmentSettings

Uma lista de configurações comuns de variável de ambiente. Essas variáveis de ambiente são definidas para todas as Tarefas em Trabalhos criadas nessa agenda (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?: EnvironmentSettingOutput[]

Valor da propriedade

EnvironmentSettingOutput[]

constraints

As restrições de execução para trabalhos criados nessa agenda.

constraints?: BatchJobConstraintsOutput

Valor da propriedade

BatchJobConstraintsOutput

displayName

O nome de exibição para trabalhos criados nessa agenda. O nome não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.

displayName?: string

Valor da propriedade

string

jobManagerTask

Os detalhes de uma Tarefa do Gerenciador de Trabalhos a ser iniciada quando um trabalho é iniciado nessa agenda. Se o Trabalho não especificar uma Tarefa do Gerenciador de Trabalhos, o usuário deverá adicionar explicitamente Tarefas ao Trabalho usando a API de Tarefa. Se o Trabalho especificar uma Tarefa do Gerenciador de Trabalhos, o serviço Do Lote criará a Tarefa do Gerenciador de Trabalhos quando o Trabalho for criado e tentará agendar a Tarefa do Gerenciador de Trabalhos antes de agendar outras tarefas no Trabalho.

jobManagerTask?: BatchJobManagerTaskOutput

Valor da propriedade

BatchJobManagerTaskOutput

jobPreparationTask

A Tarefa de Preparação do Trabalho para Trabalhos criada neste agendamento. Se um trabalho tiver uma tarefa de preparação de trabalho, o serviço do Lote executará a Tarefa de Preparação de Trabalho em um nó antes de iniciar qualquer tarefa desse trabalho nesse nó de computação.

jobPreparationTask?: BatchJobPreparationTaskOutput

Valor da propriedade

BatchJobPreparationTaskOutput

jobReleaseTask

A Tarefa de Liberação de Trabalho para Trabalhos criada nessa agenda. A principal finalidade da Tarefa de Liberação de Trabalho é desfazer alterações em nós feitas pela Tarefa de Preparação do Trabalho. As atividades de exemplo incluem a exclusão de arquivos locais ou o desligamento de serviços que foram iniciados como parte da preparação do trabalho. Uma tarefa de liberação de trabalho não pode ser especificada sem especificar também uma tarefa de preparação de trabalho para o trabalho. O serviço Lote executa a Tarefa de Liberação de Trabalho nos Nós de Computação que executaram a Tarefa de Preparação do Trabalho.

jobReleaseTask?: BatchJobReleaseTaskOutput

Valor da propriedade

BatchJobReleaseTaskOutput

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 a cada trabalho criado nesse agendamento 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?: BatchMetadataItemOutput[]

Valor da propriedade

BatchMetadataItemOutput[]

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?: BatchJobNetworkConfigurationOutput

Valor da propriedade

BatchJobNetworkConfigurationOutput

onAllTasksComplete

A ação que o serviço lote deve executar quando todas as Tarefas em um Trabalho criadas nesse agendamento estão no estado concluído. Observe que, se um trabalho não contiver Tarefas, todas as Tarefas serão consideradas concluídas. Essa opção é, portanto, mais comumente usada com uma tarefa do Gerenciador de Trabalhos; se você quiser usar a terminação automática de trabalho sem um Gerenciador de Trabalhos, inicialmente deverá definir emAllTasksComplete para noaction e atualizar as propriedades de trabalho a serem definidas emAllTasksComplete para encerrar o trabalho depois de terminar de adicionar Tarefas. O padrão é noaction.

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

onAllTasksComplete?: string

Valor da propriedade

string

onTaskFailure

A ação que o serviço do Lote deve executar quando qualquer Tarefa falha em um trabalho criado neste agendamento. Uma tarefa será considerada com falha se tiver falhado se tiver um failureInfo. 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.

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

onTaskFailure?: string

Valor da propriedade

string

poolInfo

O pool no qual o serviço do Lote executa as Tarefas de Trabalhos criadas nesse agendamento.

poolInfo: BatchPoolInfoOutput

Valor da propriedade

BatchPoolInfoOutput

priority

A prioridade dos trabalhos criados nessa agenda. 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. Essa prioridade é usada como o padrão para todos os trabalhos na Agenda de Trabalho. Você pode atualizar a prioridade de um trabalho depois que ele tiver sido criado usando a API de trabalho de atualização.

priority?: number

Valor da propriedade

number

usesTaskDependencies

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

usesTaskDependencies?: boolean

Valor da propriedade

boolean