BatchTaskCreateOptions interface
Parâmetros para criar uma tarefa Lote do Azure.
Propriedades
| affinity |
Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação no qual iniciar a nova Tarefa. |
| application |
Uma lista de Pacotes que o serviço Batch irá implantar no Nó de Computação antes de executar a linha de comando. Os pacotes de aplicação são baixados e implantados em um diretório compartilhado, não no diretório de trabalho Tarefa. Portanto, se um pacote referenciado já estiver no Nó e atualizado, ele não é baixado 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 deletado ou porque o download falhou, a Tarefa falha. |
| command |
A linha de comando da Tarefa. Para Tarefas multiinstância, a linha de comando é executada como a Tarefa principal, após a Tarefa principal e todas as subtarefas terem terminado 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, deve invocar o shell na linha de comando, 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 da Tarefa) ou usar a variável de ambiente fornecida pelo Lote (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). |
| constraints | As restrições de execução que se aplicam a esta Tarefa. Se você não especificar restrições, o maxTaskRetryCount é o maxTaskRetryCount especificado para o Trabalho, o maxWallClockTimeTime é infinito e o retentionTime é de 7 dias. |
| container |
As configurações do contêiner sob o qual a Tarefa é executada. Se o pool que executará essa tarefa tiver containerConfiguration ativado, isso também deve ser definido. Se o pool que executará essa tarefa não tiver containerConfiguration ativado, isso não deve ser definido. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Lote do Azure no nó) são mapeados no contêiner, todas as variáveis do ambiente Tarefa são mapeadas no contêiner, e a linha de comando Tarefa é executada no contêiner. Arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco hospedeiro, o que significa que APIs de arquivos Batch não conseguirão acessar esses arquivos. |
| depends |
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 sucesso. Se alguma dessas Tarefas falhar e esgotar a contagem de tentativas de novo, essa Tarefa nunca será agendada. Se o Job não tiver usesTaskDependencies ativado como true, e esse elemento estiver presente, a solicitação falha com o código de erro TaskDependenciesNotSpecifiedOnJob. |
| display |
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. |
| environment |
Uma lista de configurações de variáveis de ambiente para a Tarefa. |
| exit |
Como o serviço em lote deve responder quando a tarefa for concluída. |
| id | Uma cadeia que identifica de forma única a Tarefa dentro do 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. O ID preserva minúsculas e minúsculas e não é sensível a minúsculas (ou seja, você pode não ter dois IDs dentro de um Job que diferem apenas por caso). |
| multi |
Um objeto que indica que a tarefa é uma tarefa multiinstância e contém informações sobre como executar a tarefa multiinstância. |
| output |
Uma lista de arquivos que o serviço Batch enviará do Nó de Computação após executar a linha de comando. Para Tarefas de múltiplas instâncias, os arquivos só serão carregados do Nó de Computação onde a Tarefa principal é executada. |
| required |
O número de slots de agendamento que a Tarefa precisava para executar. O valor padrão é 1. Uma Tarefa só pode ser agendada para rodar em um nó de computação se o nó tiver vagas de agendamento livres suficientes disponíveis. Para Tarefas de múltiplas instâncias, isso deve ser 1. |
| resource |
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 multiinstância, os arquivos de recurso serão baixados apenas para o Nó de Computação onde a Tarefa principal é 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. |
| user |
A identidade do usuário sob a qual a Tarefa é executada. Se omitida, a Tarefa roda como um usuário não administrativo exclusivo da Tarefa. |
Detalhes da propriedade
affinityInfo
Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação no qual iniciar a nova Tarefa.
affinityInfo?: BatchAffinityInfo
Valor da propriedade
applicationPackageReferences
Uma lista de Pacotes que o serviço Batch irá implantar no Nó de Computação antes de executar a linha de comando. Os pacotes de aplicação são baixados e implantados em um diretório compartilhado, não no diretório de trabalho Tarefa. Portanto, se um pacote referenciado já estiver no Nó e atualizado, ele não é baixado 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 deletado ou porque o download falhou, a Tarefa falha.
applicationPackageReferences?: BatchApplicationPackageReference[]
Valor da propriedade
commandLine
A linha de comando da Tarefa. Para Tarefas multiinstância, a linha de comando é executada como a Tarefa principal, após a Tarefa principal e todas as subtarefas terem terminado 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, deve invocar o shell na linha de comando, 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 da Tarefa) ou usar a variável de ambiente fornecida pelo Lote (https://learn.microsoft.com/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. Se você não especificar restrições, o maxTaskRetryCount é o maxTaskRetryCount especificado para o Trabalho, o maxWallClockTimeTime é infinito e o retentionTime é de 7 dias.
constraints?: BatchTaskConstraints
Valor da propriedade
containerSettings
As configurações do contêiner sob o qual a Tarefa é executada. Se o pool que executará essa tarefa tiver containerConfiguration ativado, isso também deve ser definido. Se o pool que executará essa tarefa não tiver containerConfiguration ativado, isso não deve ser definido. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Lote do Azure no nó) são mapeados no contêiner, todas as variáveis do ambiente Tarefa são mapeadas no contêiner, e a linha de comando Tarefa é executada no contêiner. Arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco hospedeiro, o que significa que APIs de arquivos Batch não conseguirão acessar esses arquivos.
containerSettings?: BatchTaskContainerSettings
Valor da propriedade
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 sucesso. Se alguma dessas Tarefas falhar e esgotar a contagem de tentativas de novo, essa Tarefa nunca será agendada. Se o Job não tiver usesTaskDependencies ativado como true, e esse elemento estiver presente, a solicitação falha com o código de erro TaskDependenciesNotSpecifiedOnJob.
dependsOn?: BatchTaskDependencies
Valor da propriedade
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áveis de ambiente para a Tarefa.
environmentSettings?: EnvironmentSetting[]
Valor da propriedade
exitConditions
Como o serviço em lote deve responder quando a tarefa for concluída.
exitConditions?: ExitConditions
Valor da propriedade
id
Uma cadeia que identifica de forma única a Tarefa dentro do 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. O ID preserva minúsculas e minúsculas e não é sensível a minúsculas (ou seja, você pode não ter dois IDs dentro de um Job que diferem apenas por caso).
id: string
Valor da propriedade
string
multiInstanceSettings
Um objeto que indica que a tarefa é uma tarefa multiinstância e contém informações sobre como executar a tarefa multiinstância.
multiInstanceSettings?: MultiInstanceSettings
Valor da propriedade
outputFiles
Uma lista de arquivos que o serviço Batch enviará do Nó de Computação após executar a linha de comando. Para Tarefas de múltiplas instâncias, os arquivos só serão carregados do Nó de Computação onde a Tarefa principal é executada.
outputFiles?: OutputFile[]
Valor da propriedade
requiredSlots
O número de slots de agendamento que a Tarefa precisava para executar. O valor padrão é 1. Uma Tarefa só pode ser agendada para rodar em um nó de computação se o nó tiver vagas de agendamento livres suficientes disponíveis. Para Tarefas de múltiplas 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 multiinstância, os arquivos de recurso serão baixados apenas para o Nó de Computação onde a Tarefa principal é 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
userIdentity
A identidade do usuário sob a qual a Tarefa é executada. Se omitida, a Tarefa roda como um usuário não administrativo exclusivo da Tarefa.
userIdentity?: UserIdentity