BatchJobCreateOptions interface

Pacote:

@azure/batch

Parâmetros para criar um Lote do Azure Job.

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. 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.
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.
displayName	O nome de exibição do Trabalho. O nome de 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 na Conta. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres. 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. Se o Trabalho não especificar uma Tarefa do Gerenciador de Trabalhos, o usuário deverá adicionar explicitamente Tarefas ao Trabalho. 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. A finalidade típica da Tarefa do Gerenciador de Trabalho é controlar e/ou monitorar a execução do trabalho, por exemplo, decidindo quais tarefas adicionais serão executadas, determinando quando o trabalho está concluído etc. (No entanto, uma Tarefa do Gerenciador de Trabalho não está restrita a essas atividades – é uma Tarefa completa no sistema e executar todas as ações necessárias para o Trabalho.) Por exemplo, uma Tarefa do Gerenciador de Trabalhos pode baixar um arquivo especificado como um 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 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 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 que executaram a Tarefa de Preparação de Trabalho. A principal finalidade da Tarefa de Liberação de Trabalho é desfazer alterações nos Nós de Computação 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.
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	O pool no qual o serviço lote executa as Tarefas do Trabalho.
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.
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.
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. 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.

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

displayName

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

displayName?: string

Valor da propriedade

string

id

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

jobManagerTask?: BatchJobManagerTask

Valor da propriedade

BatchJobManagerTask

jobPreparationTask

A tarefa de preparação do trabalho. 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?: BatchJobPreparationTask

Valor da propriedade

BatchJobPreparationTask

jobReleaseTask

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

jobReleaseTask?: BatchJobReleaseTask

Valor da propriedade

BatchJobReleaseTask

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

O pool no qual o serviço lote executa as Tarefas do Trabalho.

poolInfo: BatchPoolInfo

Valor da propriedade

BatchPoolInfo

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

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

usesTaskDependencies

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

usesTaskDependencies?: boolean

Valor da propriedade

boolean