CloudTask interface

Pacote:

@azure/batch

O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação.

Propriedades

affinityInfo	Uma dica de localidade que pode ser usada pelo serviço lote para selecionar um Nó de Computação no qual iniciar a nova Tarefa.
applicationPackageReferences	Uma lista de pacotes que o serviço do Lote implantará no Nó de Computação antes de executar a linha de comando. Os pacotes de aplicativos são baixados e implantados em um diretório compartilhado, não no diretório de trabalho da Tarefa. Portanto, se um pacote referenciado já estiver no Nó e estiver atualizado, ele não será baixado novamente; a cópia existente no Nó de Computação é usada. Se um Pacote referenciado não puder ser instalado, por exemplo, porque o pacote foi excluído ou porque o download falhou, a Tarefa falhará.
authenticationTokenSettings	As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço do Lote. Se essa propriedade estiver definida, o serviço lote fornecerá à Tarefa um token de autenticação que pode ser usado para autenticar operações de serviço do Lote sem a necessidade de uma chave de acesso da conta. O token é fornecido por meio da variável de ambiente AZ_BATCH_AUTHENTICATION_TOKEN. As operações que a Tarefa pode realizar usando o token dependem das configurações. Por exemplo, uma Tarefa pode solicitar permissões de trabalho para adicionar outras Tarefas ao Trabalho ou verificar o status do Trabalho ou de outras Tarefas no Trabalho.
commandLine	A linha de comando da Tarefa. Para tarefas de várias instâncias, a linha de comando é executada como a Tarefa primária, depois que a Tarefa primária e todas as subtarefas terminarem de executar a linha de comando de coordenação. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se quiser aproveitar esses recursos, invoque o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no 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 da Tarefa) ou usar a variável de ambiente fornecida pelo Lote (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	As restrições de execução que se aplicam a esta Tarefa.
containerSettings	As configurações do contêiner no qual a Tarefa é executada. Se o Pool que executará essa Tarefa tiver containerConfiguration definido, isso também deverá ser definido. Se o Pool que executará essa Tarefa não tiver containerConfiguration definido, isso não deverá ser definido. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios do Lote do Azure no nó) são mapeados para o contêiner, todas as variáveis de ambiente de tarefa são mapeadas para o contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco do host, o que significa que as APIs de arquivo do Lote não poderão acessar esses arquivos.
creationTime	A hora de criação da Tarefa.
dependsOn	As tarefas das quais essa Tarefa depende. Essa Tarefa não será agendada até que todas as tarefas das quais ela depende tenham sido concluídas com êxito. Se qualquer uma dessas Tarefas falhar e esgotar suas contagens de repetição, essa Tarefa nunca será agendada.
displayName	Um nome de exibição para a Tarefa. O nome de exibição não precisa ser exclusivo e pode conter caracteres Unicode até um comprimento máximo de 1024.
environmentSettings	Uma lista de configurações de variável de ambiente para a Tarefa.
eTag	A ETag da Tarefa. Essa é uma cadeia de caracteres opaca. Você pode usá-la para detectar se a Tarefa foi alterada entre solicitações. Em particular, você pode passar a ETag ao atualizar uma Tarefa para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado a Tarefa enquanto isso.
executionInfo	Informações sobre a execução da Tarefa.
exitConditions	Como o serviço do Lote deve responder quando a Tarefa for concluída.
id	Uma cadeia de caracteres que identifica exclusivamente a Tarefa no Trabalho. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres.
lastModified	A hora da última modificação da Tarefa.
multiInstanceSettings	Um objeto que indica que a Tarefa é uma Tarefa de várias instâncias e contém informações sobre como executar a Tarefa de várias instâncias.
nodeInfo	Informações sobre o Nó de Computação no qual a Tarefa foi executada.
outputFiles	Uma lista de arquivos que o serviço do Lote carregará do Nó de Computação depois de executar a linha de comando. Para tarefas de várias instâncias, os arquivos serão carregados apenas do Nó de Computação no qual a Tarefa primária é executada.
previousState	O estado anterior da Tarefa. Essa propriedade não será definida se a Tarefa estiver em seu estado ativo inicial. Os valores possíveis incluem: 'active', 'prepare', 'running', 'completed'
previousStateTransitionTime	A hora em que a Tarefa inseriu seu estado anterior. Essa propriedade não será definida se a Tarefa estiver em seu estado ativo inicial.
requiredSlots	O número de slots de agendamento necessários para execução da Tarefa. O padrão é 1. Uma tarefa só poderá ser agendada para ser executada em um nó de computação se o nó tiver slots de agendamento gratuitos suficientes disponíveis. Para tarefas de várias instâncias, isso deve ser 1.
resourceFiles	Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. Para tarefas de várias instâncias, os arquivos de recurso serão baixados apenas para o Nó de Computação no qual a Tarefa primária é executada. Há um tamanho máximo para a lista de arquivos de recurso. 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 deverá 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. Os valores possíveis incluem: 'active', 'prepare', 'running', 'completed'
stateTransitionTime	A hora em que a Tarefa inseriu seu estado atual.
stats	Estatísticas de uso de recursos para a Tarefa.
url	A URL da Tarefa.
userIdentity	A identidade do usuário sob a qual a Tarefa é executada. Se omitido, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa.

Detalhes da propriedade

affinityInfo

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

affinityInfo?: AffinityInformation

Valor da propriedade

AffinityInformation

applicationPackageReferences

Uma lista de pacotes que o serviço do Lote implantará no Nó de Computação antes de executar a linha de comando. Os pacotes de aplicativos são baixados e implantados em um diretório compartilhado, não no diretório de trabalho da Tarefa. Portanto, se um pacote referenciado já estiver no Nó e estiver atualizado, ele não será baixado novamente; a cópia existente no Nó de Computação é usada. Se um Pacote referenciado não puder ser instalado, por exemplo, porque o pacote foi excluído ou porque o download falhou, a Tarefa falhará.

applicationPackageReferences?: ApplicationPackageReference[]

Valor da propriedade

ApplicationPackageReference[]

authenticationTokenSettings

As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço do Lote. Se essa propriedade estiver definida, o serviço lote fornecerá à Tarefa um token de autenticação que pode ser usado para autenticar operações de serviço do Lote sem a necessidade de uma chave de acesso da conta. O token é fornecido por meio da variável de ambiente AZ_BATCH_AUTHENTICATION_TOKEN. As operações que a Tarefa pode realizar usando o token dependem das configurações. Por exemplo, uma Tarefa pode solicitar permissões de trabalho para adicionar outras Tarefas ao Trabalho ou verificar o status do Trabalho ou de outras Tarefas no Trabalho.

authenticationTokenSettings?: AuthenticationTokenSettings

Valor da propriedade

AuthenticationTokenSettings

commandLine

A linha de comando da Tarefa. Para tarefas de várias instâncias, a linha de comando é executada como a Tarefa primária, depois que a Tarefa primária e todas as subtarefas terminarem de executar a linha de comando de coordenação. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se quiser aproveitar esses recursos, invoque o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no 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 da Tarefa) ou usar a variável de ambiente fornecida pelo Lote (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

commandLine?: string

Valor da propriedade

string

constraints

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

constraints?: TaskConstraints

Valor da propriedade

TaskConstraints

containerSettings

As configurações do contêiner no qual a Tarefa é executada. Se o Pool que executará essa Tarefa tiver containerConfiguration definido, isso também deverá ser definido. Se o Pool que executará essa Tarefa não tiver containerConfiguration definido, isso não deverá ser definido. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios do Lote do Azure no nó) são mapeados para o contêiner, todas as variáveis de ambiente de tarefa são mapeadas para o contêiner e a linha de comando Tarefa é executada no contêiner. Os arquivos produzidos no contêiner fora de AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco do host, o que significa que as APIs de arquivo do Lote não poderão acessar esses arquivos.

containerSettings?: TaskContainerSettings

Valor da propriedade

TaskContainerSettings

creationTime

A hora de criação da Tarefa.

creationTime?: Date

Valor da propriedade

Date

dependsOn

As tarefas das quais essa Tarefa depende. Essa Tarefa não será agendada até que todas as tarefas das quais ela depende tenham sido concluídas com êxito. Se qualquer uma dessas Tarefas falhar e esgotar suas contagens de repetição, essa Tarefa nunca será agendada.

dependsOn?: TaskDependencies

Valor da propriedade

TaskDependencies

displayName

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

environmentSettings

Uma lista de configurações de variável de ambiente para a Tarefa.

environmentSettings?: EnvironmentSetting[]

Valor da propriedade

EnvironmentSetting[]

eTag

A ETag da Tarefa. Essa é uma cadeia de caracteres opaca. Você pode usá-la para detectar se a Tarefa foi alterada entre solicitações. Em particular, você pode passar a ETag ao atualizar uma Tarefa para especificar que suas alterações devem entrar em vigor somente se ninguém mais tiver modificado a Tarefa enquanto isso.

eTag?: string

Valor da propriedade

string

executionInfo

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

executionInfo?: TaskExecutionInformation

Valor da propriedade

TaskExecutionInformation

exitConditions

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

exitConditions?: ExitConditions

Valor da propriedade

ExitConditions

id

Uma cadeia de caracteres que identifica exclusivamente a Tarefa no Trabalho. A ID pode conter qualquer combinação de caracteres alfanuméricos, incluindo hifens e sublinhados, e não pode conter mais de 64 caracteres.

id?: string

Valor da propriedade

string

lastModified

A hora da última modificação da Tarefa.

lastModified?: Date

Valor da propriedade

Date

multiInstanceSettings

Um objeto que indica que a Tarefa é uma Tarefa de várias instâncias e contém informações sobre como executar a Tarefa de várias instâncias.

multiInstanceSettings?: MultiInstanceSettings

Valor da propriedade

MultiInstanceSettings

nodeInfo

Informações sobre o Nó de Computação no qual a Tarefa foi executada.

nodeInfo?: ComputeNodeInformation

Valor da propriedade

ComputeNodeInformation

outputFiles

Uma lista de arquivos que o serviço do Lote carregará do Nó de Computação depois de executar a linha de comando. Para tarefas de várias instâncias, os arquivos serão carregados apenas do Nó de Computação no qual a Tarefa primária é executada.

outputFiles?: OutputFile[]

Valor da propriedade

OutputFile[]

previousState

O estado anterior da Tarefa. Essa propriedade não será definida se a Tarefa estiver em seu estado ativo inicial. Os valores possíveis incluem: 'active', 'prepare', 'running', 'completed'

previousState?: TaskState

Valor da propriedade

TaskState

previousStateTransitionTime

A hora em que a Tarefa inseriu seu estado anterior. Essa propriedade não será definida se a Tarefa estiver em seu estado ativo inicial.

previousStateTransitionTime?: Date

Valor da propriedade

Date

requiredSlots

O número de slots de agendamento necessários para execução da Tarefa. O padrão é 1. Uma tarefa só poderá ser agendada para ser executada em um nó de computação se o nó tiver slots de agendamento gratuitos suficientes disponíveis. Para tarefas de várias instâncias, isso deve ser 1.

requiredSlots?: number

Valor da propriedade

number

resourceFiles

Uma lista de arquivos que o serviço do Lote baixará no Nó de Computação antes de executar a linha de comando. Para tarefas de várias instâncias, os arquivos de recurso serão baixados apenas para o Nó de Computação no qual a Tarefa primária é executada. Há um tamanho máximo para a lista de arquivos de recurso. 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 deverá ser reduzida em tamanho. Isso pode ser feito usando arquivos .zip, pacotes de aplicativos ou contêineres do Docker.

resourceFiles?: ResourceFile[]

Valor da propriedade

ResourceFile[]

state

O estado atual da Tarefa. Os valores possíveis incluem: 'active', 'prepare', 'running', 'completed'

state?: TaskState

Valor da propriedade

TaskState

stateTransitionTime

A hora em que a Tarefa inseriu seu estado atual.

stateTransitionTime?: Date

Valor da propriedade

Date

stats

Estatísticas de uso de recursos para a Tarefa.

stats?: TaskStatistics

Valor da propriedade

TaskStatistics

url

A URL da Tarefa.

url?: string

Valor da propriedade

string

userIdentity

A identidade do usuário sob a qual a Tarefa é executada. Se omitido, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa.

userIdentity?: UserIdentity

Valor da propriedade

UserIdentity