BatchTask interface

Pacote:

@azure/batch

O lote tentará novamente Tarefas quando uma operação de recuperação for acionada em um nó. Exemplos de operações de recuperação incluem (mas não estão limitados a) quando um nó não íntegro é reinicializado ou um nó de computação desaparece devido a falha do host. As novas tentativas devido a operações de recuperação são independentes e não são contabilizadas em relação ao maxTaskRetryCount. Mesmo se maxTaskRetryCount for 0, pode ocorrer uma nova tentativa interna devido a uma operação de recuperação. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar corrupção ou dados duplicados. A prática recomendada para tarefas de longa duração é usar alguma forma de ponto de verificação.

Propriedades

affinityInfo	Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação onde iniciar a nova Tarefa.
applicationPackageReferences	Uma lista de Pacotes que o serviço Batch irá implementar no Nó de Computação antes de executar a linha de comandos. Os pacotes de aplicações são descarregados e implementados num diretório partilhado, não no diretório de trabalho Tarefa. Portanto, se um pacote referenciado já estiver no Nó e estiver atualizado, então não é descarregado novamente; a cópia existente no Nó de Computação é utilizada. Se um Pacote referenciado não puder ser instalado, por exemplo porque o pacote foi eliminado ou porque o download falhou, a Tarefa falha.
commandLine	A linha de comandos da Tarefa. Para Tarefas multi-instância, a linha de comando é executada como a Tarefa principal, depois de a Tarefa principal e todas as subtarefas terem terminado a execução da linha de comandos de coordenação. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se quiser tirar partido destas funcionalidades, deve invocar o shell na linha de comandos, por exemplo, usando "cmd /c MyCommand" em Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints	As restrições de execução que se aplicam a esta Tarefa.
containerSettings	As definições do contentor sob o qual a Tarefa é executada. Se o Pool que irá executar esta tarefa tiver containerConfiguration definido, isto também deve ser definido. Se o Pool que irá executar esta Tarefa não tiver containerConfiguration ativado, isto não deve estar definido. Quando isto é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos Azure Batch diretórios no nó) são mapeados para o contentor, todas as variáveis do ambiente Tarefa são mapeadas para o contentor e a linha de comandos Tarefa é executada no contentor. Ficheiros produzidos no contentor fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos para o disco anfitrião, o que significa que as APIs de ficheiros Batch não poderão aceder a esses ficheiros.
creationTime	O tempo de criação da Tarefa.
dependsOn	As Tarefas das quais esta Tarefa depende. Esta Tarefa não será agendada até que todas as Tarefas de que depende tenham sido concluídas com sucesso. Se alguma dessas Tarefas falhar e esgotar o número de retentativas, essa Tarefa nunca será agendada.
displayName	Um nome de exibição para a Tarefa. O nome para exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
environmentSettings	Uma lista de definições de variáveis de ambiente para a Tarefa.
eTag	O ETag da Tarefa. Esta é uma cadeia de caracteres opaca. Podes usá-lo para detetar se a tarefa mudou entre pedidos. Em particular, podes passar o ETag ao atualizar uma Tarefa para especificar que as tuas alterações só devem ter efeito se ninguém mais tiver modificado a Tarefa entretanto.
executionInfo	Informação sobre a execução da Tarefa.
exitConditions	Como o serviço Batch deve responder quando a Tarefa for concluída.
id	Uma cadeia que identifica de forma única a Tarefa dentro do Trabalho. 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.
lastModified	O último tempo modificado da Tarefa.
multiInstanceSettings	Um objeto que indica que a Tarefa é uma Tarefa multiinstância e contém informações sobre como executar a Tarefa multi-instância.
nodeInfo	Informação sobre o Nó de Computação onde a Tarefa corria.
outputFiles	Uma lista de ficheiros que o serviço Batch irá carregar do Nó de Computação após executar a linha de comandos. Para Tarefas de múltiplas instâncias, os ficheiros só serão carregados a partir do Nó de Computação onde a Tarefa principal é executada.
previousState	O estado anterior da Tarefa. Esta propriedade não está definida se a Tarefa estiver no seu estado inicial Ativo.
previousStateTransitionTime	O momento em que a Tarefa entrou no seu estado anterior. Esta propriedade não está definida se a Tarefa estiver no seu estado inicial Ativo.
requiredSlots	O número de espaços de agendamento que a Tarefa requer para executar. O valor predefinido é 1. Uma Tarefa só pode ser agendada para correr num nó de computação se este tiver espaços de agendamento livres suficientes. Para Tarefas de múltiplas instâncias, isto deve ser 1.
resourceFiles	Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. Para Tarefas multiinstância, os ficheiros de recurso serão descarregados apenas para o Nó de Computação onde a Tarefa principal é executada. Há um tamanho máximo para a lista de arquivos de recursos. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deve ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker.
state	O estado atual da Tarefa.
stateTransitionTime	O momento em que a Tarefa entrou no seu estado atual.
taskStatistics	Estatísticas de utilização de recursos para a Tarefa.
url	O URL da tarefa.
userIdentity	A identidade do utilizador sob a qual a Tarefa é executada. Se omitida, a Tarefa é executada como um utilizador não administrativo único da Tarefa.

Detalhes de Propriedade

affinityInfo

Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação onde iniciar a nova Tarefa.

affinityInfo?: BatchAffinityInfo

Valor de Propriedade

BatchAffinityInfo

applicationPackageReferences

Uma lista de Pacotes que o serviço Batch irá implementar no Nó de Computação antes de executar a linha de comandos. Os pacotes de aplicações são descarregados e implementados num diretório partilhado, não no diretório de trabalho Tarefa. Portanto, se um pacote referenciado já estiver no Nó e estiver atualizado, então não é descarregado novamente; a cópia existente no Nó de Computação é utilizada. Se um Pacote referenciado não puder ser instalado, por exemplo porque o pacote foi eliminado ou porque o download falhou, a Tarefa falha.

applicationPackageReferences?: BatchApplicationPackageReference[]

Valor de Propriedade

BatchApplicationPackageReference[]

commandLine

A linha de comandos da Tarefa. Para Tarefas multi-instância, a linha de comando é executada como a Tarefa principal, depois de a Tarefa principal e todas as subtarefas terem terminado a execução da linha de comandos de coordenação. A linha de comando não é executada sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se quiser tirar partido destas funcionalidades, deve invocar o shell na linha de comandos, por exemplo, usando "cmd /c MyCommand" em Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho Tarefa) ou usar a variável de ambiente Batch provided (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

commandLine: string

Valor de Propriedade

string

constraints

As restrições de execução que se aplicam a esta Tarefa.

constraints?: BatchTaskConstraints

Valor de Propriedade

BatchTaskConstraints

containerSettings

As definições do contentor sob o qual a Tarefa é executada. Se o Pool que irá executar esta tarefa tiver containerConfiguration definido, isto também deve ser definido. Se o Pool que irá executar esta Tarefa não tiver containerConfiguration ativado, isto não deve estar definido. Quando isto é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos Azure Batch diretórios no nó) são mapeados para o contentor, todas as variáveis do ambiente Tarefa são mapeadas para o contentor e a linha de comandos Tarefa é executada no contentor. Ficheiros produzidos no contentor fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos para o disco anfitrião, o que significa que as APIs de ficheiros Batch não poderão aceder a esses ficheiros.

containerSettings?: BatchTaskContainerSettings

Valor de Propriedade

BatchTaskContainerSettings

creationTime

O tempo de criação da Tarefa.

creationTime: Date

Valor de Propriedade

Date

dependsOn

As Tarefas das quais esta Tarefa depende. Esta Tarefa não será agendada até que todas as Tarefas de que depende tenham sido concluídas com sucesso. Se alguma dessas Tarefas falhar e esgotar o número de retentativas, essa Tarefa nunca será agendada.

dependsOn?: BatchTaskDependencies

Valor de Propriedade

BatchTaskDependencies

displayName

Um nome de exibição para a Tarefa. 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

environmentSettings

Uma lista de definições de variáveis de ambiente para a Tarefa.

environmentSettings?: EnvironmentSetting[]

Valor de Propriedade

EnvironmentSetting[]

eTag

O ETag da Tarefa. Esta é uma cadeia de caracteres opaca. Podes usá-lo para detetar se a tarefa mudou entre pedidos. Em particular, podes passar o ETag ao atualizar uma Tarefa para especificar que as tuas alterações só devem ter efeito se ninguém mais tiver modificado a Tarefa entretanto.

eTag: string

Valor de Propriedade

string

executionInfo

Informação sobre a execução da Tarefa.

executionInfo?: BatchTaskExecutionInfo

Valor de Propriedade

BatchTaskExecutionInfo

exitConditions

Como o serviço Batch deve responder quando a Tarefa for concluída.

exitConditions?: ExitConditions

Valor de Propriedade

ExitConditions

id

Uma cadeia que identifica de forma única a Tarefa dentro do Trabalho. 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.

id: string

Valor de Propriedade

string

lastModified

O último tempo modificado da Tarefa.

lastModified: Date

Valor de Propriedade

Date

multiInstanceSettings

Um objeto que indica que a Tarefa é uma Tarefa multiinstância e contém informações sobre como executar a Tarefa multi-instância.

multiInstanceSettings?: MultiInstanceSettings

Valor de Propriedade

MultiInstanceSettings

nodeInfo

Informação sobre o Nó de Computação onde a Tarefa corria.

nodeInfo?: BatchNodeInfo

Valor de Propriedade

BatchNodeInfo

outputFiles

Uma lista de ficheiros que o serviço Batch irá carregar do Nó de Computação após executar a linha de comandos. Para Tarefas de múltiplas instâncias, os ficheiros só serão carregados a partir do Nó de Computação onde a Tarefa principal é executada.

outputFiles?: OutputFile[]

Valor de Propriedade

OutputFile[]

previousState

O estado anterior da Tarefa. Esta propriedade não está definida se a Tarefa estiver no seu estado inicial Ativo.

previousState?: BatchTaskState

Valor de Propriedade

BatchTaskState

previousStateTransitionTime

O momento em que a Tarefa entrou no seu estado anterior. Esta propriedade não está definida se a Tarefa estiver no seu estado inicial Ativo.

previousStateTransitionTime?: Date

Valor de Propriedade

Date

requiredSlots

O número de espaços de agendamento que a Tarefa requer para executar. O valor predefinido é 1. Uma Tarefa só pode ser agendada para correr num nó de computação se este tiver espaços de agendamento livres suficientes. Para Tarefas de múltiplas instâncias, isto deve ser 1.

requiredSlots?: number

Valor de Propriedade

number

resourceFiles

Uma lista de arquivos que o serviço em lote baixará para o nó de computação antes de executar a linha de comando. Para Tarefas multiinstância, os ficheiros de recurso serão descarregados apenas para o Nó de Computação onde a Tarefa principal é executada. Há um tamanho máximo para a lista de arquivos de recursos. Quando o tamanho máximo for excedido, a solicitação falhará e o código de erro de resposta será RequestEntityTooLarge. Se isso ocorrer, a coleção de ResourceFiles deve ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker.

resourceFiles?: ResourceFile[]

Valor de Propriedade

ResourceFile[]

state

O estado atual da Tarefa.

state: BatchTaskState

Valor de Propriedade

BatchTaskState

stateTransitionTime

O momento em que a Tarefa entrou no seu estado atual.

stateTransitionTime: Date

Valor de Propriedade

Date

taskStatistics

Estatísticas de utilização de recursos para a Tarefa.

taskStatistics?: BatchTaskStatistics

Valor de Propriedade

BatchTaskStatistics

url

O URL da tarefa.

url: string

Valor de Propriedade

string

userIdentity

A identidade do utilizador sob a qual a Tarefa é executada. Se omitida, a Tarefa é executada como um utilizador não administrativo único da Tarefa.

userIdentity?: UserIdentity

Valor de Propriedade

UserIdentity