BatchTaskCreateOptions interface

Pacote:

@azure-rest/batch

Parâmetros para criar uma Tarefa em Lote do Azure.

Propriedades

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.
applicationPackageReferences	Uma lista de Pacotes que o serviço de 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 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 em lote. Se essa propriedade estiver definida, o serviço Batch fornecerá à Task um token de autenticação que pode ser usado para autenticar operações de serviço em Batch sem exigir uma chave de acesso de Conta. O token é fornecido através 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 sob o Trabalho.
commandLine	A linha de comando da Tarefa. Para Tarefas de várias instâncias, 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 sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar 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 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. Se você não especificar restrições, o maxTaskRetryCount será o maxTaskRetryCount especificado para o Job, o maxWallClockTime será infinito e o retentionTime será 7 dias.
containerSettings	As configurações do contêiner sob o qual a Tarefa é executada. Se o Pool que executará esta Tarefa tiver containerConfiguration definido, isso também deverá ser definido. Se o Pool que executará esta 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 no contêiner, todas as variáveis de ambiente de Tarefa são mapeadas no 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 host, o que significa que as APIs de arquivo em lote não poderão acessar esses arquivos.
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 êxito. Se alguma dessas Tarefas falhar e esgotar suas contagens de tentativas, essa Tarefa nunca será agendada. Se o Job não tiver usesTaskDependencies definido como true e esse elemento estiver presente, a solicitação falhará com o código de erro TaskDependenciesNotSpecifiedOnJob.
displayName	Um nome para 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 configurações de variáveis de ambiente para a Tarefa.
exitConditions	Como o serviço de lote deve responder quando a tarefa for concluída.
id	Uma cadeia de caracteres que identifica exclusivamente 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. O ID preserva maiúsculas e minúsculas e não diferencia maiúsculas de minúsculas (ou seja, você pode não ter dois IDs dentro de um Trabalho que diferem apenas por maiúsculas e minúsculas).
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.
outputFiles	Uma lista de arquivos que o serviço Batch carregará do nó de computação depois de executar a linha de comando. Para Tarefas de várias instâncias, os arquivos só serão carregados a partir do Nó de Computação no qual a Tarefa principal é executada.
requiredSlots	O número de slots de agendamento que a Tarefa exigia para ser executada. O padrão é 1. Uma Tarefa só pode ser agendada para ser executada em um nó de computação se o nó tiver slots de agendamento livres suficientes disponíveis. Para tarefas com várias instâncias, isso 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 de várias instâncias, os arquivos de recursos só serão baixados para o Nó de Computação no qual 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.
userIdentity	A identidade do usuário sob a qual a Tarefa é executada. Se omitida, a Tarefa é executada como um usuário não administrativo exclusivo para a Tarefa.

Detalhes de 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 de Propriedade

BatchAffinityInfo

applicationPackageReferences

Uma lista de Pacotes que o serviço de 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 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?: BatchApplicationPackageReference[]

Valor de Propriedade

BatchApplicationPackageReference[]

authenticationTokenSettings

As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote. Se essa propriedade estiver definida, o serviço Batch fornecerá à Task um token de autenticação que pode ser usado para autenticar operações de serviço em Batch sem exigir uma chave de acesso de Conta. O token é fornecido através 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 sob o Trabalho.

authenticationTokenSettings?: AuthenticationTokenSettings

Valor de Propriedade

AuthenticationTokenSettings

commandLine

A linha de comando da Tarefa. Para Tarefas de várias instâncias, 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 sob um shell e, portanto, não pode aproveitar os recursos do shell, como a expansão da variável de ambiente. Se você quiser aproveitar esses recursos, você deve invocar 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 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. Se você não especificar restrições, o maxTaskRetryCount será o maxTaskRetryCount especificado para o Job, o maxWallClockTime será infinito e o retentionTime será 7 dias.

constraints?: BatchTaskConstraints

Valor de Propriedade

BatchTaskConstraints

containerSettings

As configurações do contêiner sob o qual a Tarefa é executada. Se o Pool que executará esta Tarefa tiver containerConfiguration definido, isso também deverá ser definido. Se o Pool que executará esta 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 no contêiner, todas as variáveis de ambiente de Tarefa são mapeadas no 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 host, o que significa que as APIs de arquivo em lote não poderão acessar esses arquivos.

containerSettings?: BatchTaskContainerSettings

Valor de Propriedade

BatchTaskContainerSettings

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 êxito. Se alguma dessas Tarefas falhar e esgotar suas contagens de tentativas, essa Tarefa nunca será agendada. Se o Job não tiver usesTaskDependencies definido como true e esse elemento estiver presente, a solicitação falhará com o código de erro TaskDependenciesNotSpecifiedOnJob.

dependsOn?: BatchTaskDependencies

Valor de Propriedade

BatchTaskDependencies

displayName

Um nome para 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 configurações de variáveis de ambiente para a Tarefa.

environmentSettings?: EnvironmentSetting[]

Valor de Propriedade

EnvironmentSetting[]

exitConditions

Como o serviço de lote deve responder quando a tarefa for concluída.

exitConditions?: ExitConditions

Valor de Propriedade

ExitConditions

id

Uma cadeia de caracteres que identifica exclusivamente 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. O ID preserva maiúsculas e minúsculas e não diferencia maiúsculas de minúsculas (ou seja, você pode não ter dois IDs dentro de um Trabalho que diferem apenas por maiúsculas e minúsculas).

id: string

Valor de Propriedade

string

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 de Propriedade

MultiInstanceSettings

outputFiles

Uma lista de arquivos que o serviço Batch carregará do nó de computação depois de executar a linha de comando. Para Tarefas de várias instâncias, os arquivos só serão carregados a partir do Nó de Computação no qual a Tarefa principal é executada.

outputFiles?: OutputFile[]

Valor de Propriedade

OutputFile[]

requiredSlots

O número de slots de agendamento que a Tarefa exigia para ser executada. O padrão é 1. Uma Tarefa só pode ser agendada para ser executada em um nó de computação se o nó tiver slots de agendamento livres suficientes disponíveis. Para tarefas com várias instâncias, isso 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 de várias instâncias, os arquivos de recursos só serão baixados para o Nó de Computação no qual 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[]

userIdentity

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

userIdentity?: UserIdentity

Valor de Propriedade

UserIdentity