BatchJobSpecification interface

Pacote:

@azure-rest/batch

Especifica detalhes dos trabalhos a serem criados em um cronograma.

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	Uma lista de configurações comuns de variáveis de ambiente. Essas variáveis de ambiente são definidas para todas as Tarefas em Trabalhos criados sob esse cronograma (incluindo o Gerenciador de Tarefas, Tarefas de 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 Trabalhos criados sob este cronograma.
displayName	O nome para exibição de Trabalhos criados sob esta 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 Tarefas a ser iniciada quando um Trabalho for iniciado sob esse cronograma. Se o Trabalho não especificar uma Tarefa do Gerenciador de Tarefas, o usuário deverá adicionar explicitamente Tarefas ao Trabalho usando a API de Tarefas. Se o Trabalho especificar uma Tarefa do Gerenciador de Tarefas, o serviço em Lote criará a Tarefa do Gerenciador de Tarefas quando o Trabalho for criado e tentará agendar a Tarefa do Gerenciador de Tarefas antes de agendar outras Tarefas no Trabalho.
jobPreparationTask	A Tarefa de Preparação de Trabalhos para Trabalhos criados sob este cronograma. Se um Trabalho tiver uma Tarefa de Preparação de Trabalho, o serviço em 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 criados sob esta agenda. O objetivo principal da Tarefa de Liberação de Trabalho é desfazer alterações nos Nós feitas pela Tarefa de Preparação de Trabalho. Exemplos de atividades incluem a exclusão de arquivos locais ou o encerramento 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 em lote executa a tarefa de liberação de trabalho nos nós de computação que executaram a tarefa de preparação de trabalho.
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 a cada Trabalho criado sob esta agenda 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 em um trabalho criado sob essa agenda estiverem no estado concluído. Observe que, se um Trabalho não contiver Tarefas, todas as Tarefas serão consideradas concluídas. Esta opção é, portanto, mais comumente usada com uma tarefa do Job Manager; se você quiser usar o encerramento automático de trabalho sem um Gerenciador de tarefas, você deve inicialmente definir onAllTasksComplete como noaction e atualizar as propriedades de trabalho para definir onAllTasksComplete para encerrar o trabalho assim que terminar de adicionar tarefas. O padrão é noaction. Valores possíveis: "noaction", "terminatejob"
onTaskFailure	A ação que o serviço em lote deve executar quando qualquer tarefa falhar em um trabalho criado sob essa agenda. Uma tarefa é considerada como tendo falhado se tiver 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	O Pool no qual o serviço em lote executa as tarefas de trabalhos criados sob esta agenda.
priority	A prioridade dos postos de trabalho criados ao abrigo deste calendário. 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. Essa prioridade é usada como padrão para todos os trabalhos na Agenda de trabalhos. 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 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

Uma lista de configurações comuns de variáveis de ambiente. Essas variáveis de ambiente são definidas para todas as Tarefas em Trabalhos criados sob esse cronograma (incluindo o Gerenciador de Tarefas, Tarefas de 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?: EnvironmentSetting[]

Valor de Propriedade

EnvironmentSetting[]

constraints

As restrições de execução para Trabalhos criados sob este cronograma.

constraints?: BatchJobConstraints

Valor de Propriedade

BatchJobConstraints

displayName

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

displayName?: string

Valor de Propriedade

string

jobManagerTask

Os detalhes de uma Tarefa do Gerenciador de Tarefas a ser iniciada quando um Trabalho for iniciado sob esse cronograma. Se o Trabalho não especificar uma Tarefa do Gerenciador de Tarefas, o usuário deverá adicionar explicitamente Tarefas ao Trabalho usando a API de Tarefas. Se o Trabalho especificar uma Tarefa do Gerenciador de Tarefas, o serviço em Lote criará a Tarefa do Gerenciador de Tarefas quando o Trabalho for criado e tentará agendar a Tarefa do Gerenciador de Tarefas antes de agendar outras Tarefas no Trabalho.

jobManagerTask?: BatchJobManagerTask

Valor de Propriedade

BatchJobManagerTask

jobPreparationTask

A Tarefa de Preparação de Trabalhos para Trabalhos criados sob este cronograma. Se um Trabalho tiver uma Tarefa de Preparação de Trabalho, o serviço em 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?: BatchJobPreparationTask

Valor de Propriedade

BatchJobPreparationTask

jobReleaseTask

A Tarefa de Liberação de Trabalho para Trabalhos criados sob esta agenda. O objetivo principal da Tarefa de Liberação de Trabalho é desfazer alterações nos Nós feitas pela Tarefa de Preparação de Trabalho. Exemplos de atividades incluem a exclusão de arquivos locais ou o encerramento 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 em lote executa a tarefa de liberação de trabalho nos nós de computação que executaram a tarefa de preparação de trabalho.

jobReleaseTask?: BatchJobReleaseTask

Valor de Propriedade

BatchJobReleaseTask

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 a cada Trabalho criado sob esta agenda como metadados. O serviço Batch não atribui qualquer significado aos metadados; é exclusivamente para o uso do código de usuário.

metadata?: BatchMetadataItem[]

Valor de Propriedade

BatchMetadataItem[]

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

Valor de Propriedade

BatchJobNetworkConfiguration

onAllTasksComplete

A ação que o serviço em lote deve executar quando todas as tarefas em um trabalho criado sob essa agenda estiverem no estado concluído. Observe que, se um Trabalho não contiver Tarefas, todas as Tarefas serão consideradas concluídas. Esta opção é, portanto, mais comumente usada com uma tarefa do Job Manager; se você quiser usar o encerramento automático de trabalho sem um Gerenciador de tarefas, você deve inicialmente definir onAllTasksComplete como noaction e atualizar as propriedades de trabalho para definir onAllTasksComplete para encerrar o trabalho assim que terminar de adicionar tarefas. 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 falhar em um trabalho criado sob essa agenda. Uma tarefa é considerada como tendo falhado se tiver 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

O Pool no qual o serviço em lote executa as tarefas de trabalhos criados sob esta agenda.

poolInfo: BatchPoolInfo

Valor de Propriedade

BatchPoolInfo

priority

A prioridade dos postos de trabalho criados ao abrigo deste calendário. 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. Essa prioridade é usada como padrão para todos os trabalhos na Agenda de trabalhos. 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 de Propriedade

number

usesTaskDependencies

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

usesTaskDependencies?: boolean

Valor de Propriedade

boolean