BatchJobCreateOptions interface

Pacote:

@azure-rest/batch

Parâmetros para criar 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.
displayName	O nome para exibição do trabalho. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
id	Uma cadeia de caracteres que identifica exclusivamente o Trabalho dentro da Conta. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. 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. Se o Trabalho não especificar uma Tarefa do Gerenciador de Tarefas, o usuário deverá adicionar explicitamente Tarefas ao Trabalho. 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. O objetivo típico da Tarefa do Gerente de Trabalho é controlar e/ou monitorar a execução do Trabalho, por exemplo, decidindo quais Tarefas adicionais executar, determinando quando o trabalho é concluído, etc. (No entanto, uma Tarefa do Gerente de Trabalho não se restringe a essas atividades - é uma Tarefa completa no sistema e executa todas as ações necessárias para o Trabalho.) Por exemplo, uma Tarefa do Gerenciador de Tarefas pode baixar um arquivo especificado como parâmetro, analisar o conteúdo desse arquivo e enviar Tarefas adicionais com base nesse conteúdo.
jobPreparationTask	A Tarefa de Preparação do Trabalho. 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. 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 que executaram a tarefa de preparação de trabalho. O objetivo principal da Tarefa de Liberação de Trabalho é desfazer alterações nos Nós de Computação 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.
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. 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 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	O Pool no qual o serviço de Lote executa as Tarefas do Trabalho.
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.
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?: EnvironmentSetting[]

Valor de Propriedade

EnvironmentSetting[]

constraints

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

constraints?: BatchJobConstraints

Valor de Propriedade

BatchJobConstraints

displayName

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

displayName?: string

Valor de Propriedade

string

id

Uma cadeia de caracteres que identifica exclusivamente o Trabalho dentro da Conta. O ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hífenes e sublinhados, e não pode conter mais de 64 caracteres. 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. Se o Trabalho não especificar uma Tarefa do Gerenciador de Tarefas, o usuário deverá adicionar explicitamente Tarefas ao Trabalho. 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. O objetivo típico da Tarefa do Gerente de Trabalho é controlar e/ou monitorar a execução do Trabalho, por exemplo, decidindo quais Tarefas adicionais executar, determinando quando o trabalho é concluído, etc. (No entanto, uma Tarefa do Gerente de Trabalho não se restringe a essas atividades - é uma Tarefa completa no sistema e executa todas as ações necessárias para o Trabalho.) Por exemplo, uma Tarefa do Gerenciador de Tarefas pode baixar um arquivo especificado como parâmetro, analisar o conteúdo desse arquivo e enviar Tarefas adicionais com base nesse conteúdo.

jobManagerTask?: BatchJobManagerTask

Valor de Propriedade

BatchJobManagerTask

jobPreparationTask

A Tarefa de Preparação do Trabalho. 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. 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 que executaram a tarefa de preparação de trabalho. O objetivo principal da Tarefa de Liberação de Trabalho é desfazer alterações nos Nós de Computação 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.

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 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?: 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 no trabalho 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 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

O Pool no qual o serviço de Lote executa as Tarefas do Trabalho.

poolInfo: BatchPoolInfo

Valor de Propriedade

BatchPoolInfo

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

usesTaskDependencies

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

usesTaskDependencies?: boolean

Valor de Propriedade

boolean