Task - Add

Serviço:

Batch Service

Versão da API:

2024-07-01.20.0

Adiciona uma Tarefa ao Trabalho especificado.
O tempo de vida máximo de uma Tarefa desde a adição até a conclusão é de 180 dias. Se uma Tarefa não for concluída dentro de 180 dias após ser adicionada, ela será encerrada pelo serviço de Lote e deixada em qualquer estado em que estivesse naquele momento.

POST {batchUrl}/jobs/{jobId}/tasks?api-version=2024-07-01.20.0

Com parâmetros opcionais:

POST {batchUrl}/jobs/{jobId}/tasks?timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
jobId	path	True	string	A ID do Trabalho ao qual a Tarefa deve ser adicionada.
api-version	query	True	string	Versão da API do cliente.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado.

Cabeçalho do Pedido

Media Types: "application/json; odata=minimalmetadata"

Name	Necessário	Tipo	Description
client-request-id		string uuid	A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Corpo do Pedido

Media Types: "application/json; odata=minimalmetadata"

Name	Necessário	Tipo	Description
commandLine	True	string	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).
id	True	string	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).
affinityInfo		AffinityInformation	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		ApplicationPackageReference[]	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		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.
constraints		TaskConstraints	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		TaskContainerSettings	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		TaskDependencies	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		string	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		EnvironmentSetting[]	Uma lista de configurações de variáveis de ambiente para a Tarefa.
exitConditions		ExitConditions	Especifica como o serviço em lote deve responder quando a tarefa for concluída. Como o serviço de lote deve responder quando a tarefa for concluída.
multiInstanceSettings		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. Tarefas de várias instâncias são comumente usadas para dar suporte a tarefas MPI. No caso do MPI, se qualquer uma das subtarefas falhar (por exemplo, devido à saída com um código de saída diferente de zero), toda a Tarefa de várias instâncias falhará. A tarefa de várias instâncias é então encerrada e repetida, até seu limite de repetição.
outputFiles		OutputFile[]	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		integer	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		ResourceFile[]	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		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.

Respostas

Name	Tipo	Description
201 Created		A solicitação para o serviço de lote foi bem-sucedida. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço de lote.

Segurança

azure_auth

Fluxo de código de autenticação do Microsoft Entra OAuth 2.0

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Add a basic task

Add a container task with container data isolation

Add a container task with container data isolation bad request duplicate sources

Add a task with container settings

Add a task with exit conditions

Add a task with extra slot requirement

Add a basic task

Pedido de amostra

HTTP

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0



{
  "id": "task1",
  "commandLine": "cmd /c echo task1"
}

Resposta da amostra

Código de estado:

201

Add a container task with container data isolation

Pedido de amostra

HTTP

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0



{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerHostBatchBindMounts": [
      {
        "source": "Task",
        "isReadOnly": true
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Resposta da amostra

Código de estado:

201

Add a container task with container data isolation bad request duplicate sources

Pedido de amostra

HTTP

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0



{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerHostBatchBindMounts": [
      {
        "source": "Task",
        "isReadOnly": true
      },
      {
        "source": "Task",
        "isReadOnly": true
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Resposta da amostra

Código de estado:

201

Add a task with container settings

Pedido de amostra

HTTP

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0



{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerRunOptions": "--rm"
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Resposta da amostra

Código de estado:

201

Add a task with exit conditions

Pedido de amostra

HTTP

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0



{
  "id": "taskId",
  "commandLine": "cmd /c exit 3",
  "exitConditions": {
    "exitCodeRanges": [
      {
        "start": 2,
        "end": 4,
        "exitOptions": {
          "jobAction": "terminate"
        }
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Resposta da amostra

Código de estado:

201

Add a task with extra slot requirement

Pedido de amostra

HTTP

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0



{
  "id": "task1",
  "requiredSlots": 2,
  "commandLine": "cmd /c echo task1"
}

Resposta da amostra

Código de estado:

201

Definições

Name	Description
AccessScope	Os recursos de lote aos quais o token concede acesso.
AffinityInformation	Uma dica de localidade que pode ser usada pelo serviço Batch para selecionar um Nó de Computação no qual iniciar uma Tarefa.
ApplicationPackageReference	Uma referência a um pacote a ser implantado em nós de computação.
AuthenticationTokenSettings	As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote.
AutoUserScope	O escopo para o usuário automático
AutoUserSpecification	Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote.
BatchError	Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
ComputeNodeIdentityReference	A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
ContainerHostBatchBindMountEntry	A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.
ContainerHostDataPath	Os caminhos que serão montados no contêiner da tarefa do contêiner.
ContainerRegistry	Um registro de contêiner privado.
ContainerWorkingDirectory	O local do diretório de trabalho da tarefa do contêiner.
DependencyAction	Uma ação que o serviço em lote executa em tarefas que dependem dessa tarefa.
ElevationLevel	O nível de elevação do usuário.
EnvironmentSetting	Uma variável de ambiente a ser definida em um processo Task.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
ExitCodeMapping	Como o serviço Batch deve responder se uma Tarefa sair com um código de saída específico.
ExitCodeRangeMapping	Um intervalo de códigos de saída e como o serviço Batch deve responder aos códigos de saída dentro desse intervalo.
ExitConditions	Especifica como o serviço em lote deve responder quando a tarefa for concluída.
ExitOptions	Especifica como o serviço Batch responde a uma condição de saída específica.
HttpHeader	Um par nome-valor de cabeçalho HTTP
JobAction	Uma ação a ser executada no Job que contém a Task, se a Task for concluída com a condição de saída fornecida e a propriedade onTaskFailed do Job for 'performExitOptionsJobAction'.
MultiInstanceSettings	Configurações que especificam como executar uma tarefa de várias instâncias.
OutputFile	Uma especificação para carregar arquivos de um Nó de Computação em Lote do Azure para outro local depois que o serviço de Lote concluir a execução do processo de Tarefa.
OutputFileBlobContainerDestination	Especifica um destino de carregamento de arquivo em um contêiner de armazenamento de blob do Azure.
OutputFileDestination	O destino para o qual um arquivo deve ser carregado.
OutputFileUploadCondition	As condições sob as quais um arquivo de saída de tarefa ou conjunto de arquivos deve ser carregado.
OutputFileUploadOptions	Detalhes sobre uma operação de upload de arquivo de saída, incluindo em que condições executar o upload.
ResourceFile	Um único arquivo ou vários arquivos a serem baixados para um nó de computação.
TaskAddParameter	Uma Tarefa em Lote do Azure para adicionar.
TaskConstraints	Restrições de execução a serem aplicadas a uma Tarefa.
TaskContainerSettings	As configurações de contêiner para uma Tarefa.
TaskDependencies	Especifica quaisquer dependências de uma Tarefa. Qualquer Tarefa especificada explicitamente ou dentro de um intervalo de dependência deve ser concluída antes que a Tarefa dependente seja agendada.
TaskIdRange	Um intervalo de IDs de Tarefa do qual uma Tarefa pode depender. Todas as Tarefas com IDs no intervalo devem ser concluídas com êxito antes que a Tarefa dependente possa ser agendada.
UserIdentity	A definição da identidade do usuário sob a qual a Tarefa é executada.

AccessScope

Os recursos de lote aos quais o token concede acesso.

Name	Tipo	Description
job	string	Concede acesso para executar todas as operações no Trabalho que contém a Tarefa.

AffinityInformation

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

Name	Tipo	Description
affinityId	string	Uma cadeia de caracteres opaca que representa o local de um Nó de Computação ou de uma Tarefa executada anteriormente. Você pode passar o affinityId de um nó para indicar que essa tarefa precisa ser executada nesse nó de computação. Note que esta é apenas uma afinidade suave. Se o Nó de Computação de destino estiver ocupado ou indisponível no momento em que a Tarefa for agendada, a Tarefa será agendada em outro lugar.

ApplicationPackageReference

Uma referência a um pacote a ser implantado em nós de computação.

Name	Tipo	Description
applicationId	string	A ID do aplicativo a ser implantado. Ao criar um pool, a ID do aplicativo do pacote deve ser totalmente qualificada (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	A versão do aplicativo a ser implantado. Se omitida, a versão padrão será implantada. Se isso for omitido em um pool e nenhuma versão padrão for especificada para este aplicativo, a solicitação falhará com o código de erro InvalidApplicationPackageReferences e o código de status HTTP 409. Se isso for omitido em uma Tarefa e nenhuma versão padrão for especificada para este aplicativo, a Tarefa falhará com um erro de pré-processamento.

AuthenticationTokenSettings

As configurações de um token de autenticação que a Tarefa pode usar para executar operações de serviço em lote.

Name	Tipo	Description
access	AccessScope[]	Os recursos de lote aos quais o token concede acesso. O token de autenticação concede acesso a um conjunto limitado de operações de serviço em lote. Atualmente, o único valor suportado para a propriedade de acesso é 'job', que concede acesso a todas as operações relacionadas ao Job que contém a Task.

AutoUserScope

O escopo para o usuário automático

Name	Tipo	Description
pool	string	Especifica que a Tarefa é executada como a Conta de usuário automático comum que é criada em cada Nó de Computação em um Pool.
task	string	Especifica que o serviço deve criar um novo usuário para a Tarefa.

AutoUserSpecification

Especifica os parâmetros para o usuário automático que executa uma tarefa no serviço em lote.

Name	Tipo	Description
elevationLevel	ElevationLevel	O nível de elevação do usuário automático. O valor padrão é nonAdmin.
scope	AutoUserScope	O escopo para o usuário automático O valor padrão é pool. Se o pool estiver executando o Windows, um valor de Task deverá ser especificado se for necessário um isolamento mais rigoroso entre as tarefas. Por exemplo, se a tarefa muta o registro de uma forma que pode afetar outras tarefas, ou se certificados foram especificados no pool que não deve ser acessível por tarefas normais, mas deve ser acessível por StartTasks.

BatchError

Uma resposta de erro recebida do serviço Batch do Azure.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas com a resposta de erro.

ComputeNodeIdentityReference

A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.

Name	Tipo	Description
resourceId	string	O ID de recurso ARM da identidade atribuída ao usuário.

ContainerHostBatchBindMountEntry

A entrada do caminho e do modo de montagem que você deseja montar no contêiner de tarefas.

Name	Tipo	Description
isReadOnly	boolean	Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é false (modo de leitura/gravação). Para Linux, se você montar esse caminho como um modo de leitura/gravação, isso não significa que todos os usuários no contêiner tenham o acesso de leitura/gravação para o caminho, depende do acesso na VM do host. Se esse caminho for montado somente leitura, todos os usuários dentro do contêiner não poderão modificá-lo.
source	ContainerHostDataPath	O caminho que ser montado para o cliente de contêiner pode selecionar.

ContainerHostDataPath

Os caminhos que serão montados no contêiner da tarefa do contêiner.

Name	Tipo	Description
Applications	string	O caminho dos aplicativos.
JobPrep	string	O caminho da tarefa de preparação para o trabalho.
Shared	string	O caminho para a tarefa de várias instâncias compartilhar seus arquivos.
Startup	string	O caminho para iniciar a tarefa.
Task	string	O caminho da tarefa.
VfsMounts	string	O caminho contém todos os sistemas de arquivos virtuais montados neste nó.

ContainerRegistry

Um registro de contêiner privado.

Name	Tipo	Description
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída ao usuário a ser usada para acessar um Registro de Contêiner do Azure em vez de nome de usuário e senha. A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
password	string	A palavra-passe para iniciar sessão no servidor de registo.
registryServer	string	O URL do registo. Se omitido, o padrão é "docker.io".
username	string	O nome de utilizador para iniciar sessão no servidor de registo.

ContainerWorkingDirectory

O local do diretório de trabalho da tarefa do contêiner.

Name	Tipo	Description
containerImageDefault	string	Use o diretório de trabalho definido na imagem do contêiner. Tenha cuidado que este diretório não conterá os arquivos de recursos baixados pelo lote.
taskWorkingDirectory	string	Use o diretório de trabalho padrão Tarefa do serviço em lote, que conterá os arquivos de recursos da tarefa preenchidos por lote.

DependencyAction

Uma ação que o serviço em lote executa em tarefas que dependem dessa tarefa.

Name	Tipo	Description
block	string	Bloqueia tarefas que aguardam esta tarefa, impedindo que sejam agendadas.
satisfy	string	Satisfazer as tarefas que aguardam esta tarefa; Quando todas as dependências estiverem satisfeitas, a tarefa será agendada para ser executada.

ElevationLevel

O nível de elevação do usuário.

Name	Tipo	Description
admin	string	O usuário é um usuário com acesso elevado e opera com permissões completas de administrador.
nonadmin	string	O usuário é um usuário padrão sem acesso elevado.

EnvironmentSetting

Uma variável de ambiente a ser definida em um processo Task.

Name	Tipo	Description
name	string	O nome da variável de ambiente.
value	string	O valor da variável de ambiente.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

Name	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

ExitCodeMapping

Como o serviço Batch deve responder se uma Tarefa sair com um código de saída específico.

Name	Tipo	Description
code	integer	Um código de saída do processo.
exitOptions	ExitOptions	Como o serviço de lote deve responder se a tarefa sair com esse código de saída.

ExitCodeRangeMapping

Um intervalo de códigos de saída e como o serviço Batch deve responder aos códigos de saída dentro desse intervalo.

Name	Tipo	Description
end	integer	O último código de saída no intervalo.
exitOptions	ExitOptions	Como o serviço Batch deve responder se a Tarefa sair com um código de saída no intervalo do início ao fim (inclusive).
start	integer	O primeiro código de saída no intervalo.

ExitConditions

Especifica como o serviço em lote deve responder quando a tarefa for concluída.

Name	Tipo	Description
default	ExitOptions	Como o serviço de lote deve responder se a tarefa falhar com uma condição de saída não coberta por nenhuma das outras propriedades. Esse valor é usado se a Task sair com qualquer código de saída diferente de zero não listado na coleção exitCodes ou exitCodeRanges, com um erro de pré-processamento se a propriedade preProcessingError não estiver presente, ou com um erro de carregamento de arquivo se a propriedade fileUploadError não estiver presente. Se desejar um comportamento não padrão no código de saída 0, liste-o explicitamente usando a coleção exitCodes ou exitCodeRanges.
exitCodeRanges	ExitCodeRangeMapping[]	Uma lista de intervalos de códigos de saída de tarefas e como o serviço de lote deve responder a eles.
exitCodes	ExitCodeMapping[]	Uma lista de códigos de saída de Tarefa individuais e como o serviço Batch deve responder a eles.
fileUploadError	ExitOptions	Como o serviço em lote deve responder se ocorrer um erro de carregamento de arquivo. Se a Tarefa saiu com um código de saída especificado por meio de exitCodes ou exitCodeRanges e, em seguida, encontrou um erro de carregamento de arquivo, a ação especificada pelo código de saída terá precedência.
preProcessingError	ExitOptions	Como o serviço em lote deve responder se a tarefa falhar ao iniciar devido a um erro.

ExitOptions

Especifica como o serviço Batch responde a uma condição de saída específica.

Name	Tipo	Description
dependencyAction	DependencyAction	Uma ação que o serviço em lote executa em tarefas que dependem dessa tarefa. Os valores possíveis são 'satisfy' (permitindo que as tarefas dependentes progridam) e 'block' (as tarefas dependentes continuam a esperar). O Batch ainda não suporta o cancelamento de tarefas dependentes.
jobAction	JobAction	Uma ação a ser executada no Job que contém a Task, se a Task for concluída com a condição de saída fornecida e a propriedade onTaskFailed do Job for 'performExitOptionsJobAction'. O padrão é none para o código de saída 0 e terminate para todas as outras condições de saída. Se a propriedade onTaskFailed do trabalho for noaction, especificar essa propriedade retornará um erro e a solicitação add Task falhará com um erro de valor de propriedade inválido; se você estiver chamando a API REST diretamente, o código de status HTTP será 400 (Solicitação incorreta).

HttpHeader

Um par nome-valor de cabeçalho HTTP

Name	Tipo	Description
name	string	O nome do cabeçalho que não diferencia maiúsculas de minúsculas a ser usado durante o upload de arquivos de saída
value	string	O valor do cabeçalho a ser usado durante o upload de arquivos de saída

JobAction

Uma ação a ser executada no Job que contém a Task, se a Task for concluída com a condição de saída fornecida e a propriedade onTaskFailed do Job for 'performExitOptionsJobAction'.

Name	Tipo	Description
disable	string	Desative o trabalho. Isso equivale a chamar a API de trabalho desabilitada, com um valor disableTasks de requeue.
none	string	Não tome nenhuma medida.
terminate	string	Encerre o trabalho. O terminateReason na executionInfo do trabalho é definido como "TaskFailed".

MultiInstanceSettings

Configurações que especificam como executar uma tarefa de várias instâncias.

Name	Tipo	Description
commonResourceFiles	ResourceFile[]	Uma lista de arquivos que o serviço Batch baixará antes de executar a linha de comando de coordenação. A diferença entre arquivos de recursos comuns e arquivos de recursos de tarefa é que os arquivos de recursos comuns são baixados para todas as subtarefas, incluindo a principal, enquanto os arquivos de recurso de tarefa são baixados apenas para a principal. Observe também que esses arquivos de recursos não são baixados para o diretório de trabalho Tarefa, mas em vez disso são baixados para o diretório raiz Tarefa (um diretório acima do diretório de trabalho). 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.
coordinationCommandLine	string	A linha de comando a ser executada em todos os nós de computação para permitir que eles coordenem quando o primário executa o comando Task principal. Uma linha de comando de coordenação típica inicia um serviço em segundo plano e verifica se o serviço está pronto para processar mensagens entre nós.
numberOfInstances	integer	O número de nós de computação exigidos pela tarefa. Se omitido, o padrão é 1.

OutputFile

Uma especificação para carregar arquivos de um Nó de Computação em Lote do Azure para outro local depois que o serviço de Lote concluir a execução do processo de Tarefa.

Name	Tipo	Description
destination	OutputFileDestination	O destino do(s) arquivo(s) de saída.
filePattern	string	Um padrão que indica o(s) ficheiro(s) a carregar. Ambos os caminhos relativos e absolutos são suportados. Os caminhos relativos são relativos ao diretório de trabalho Tarefa. Os seguintes curingas são suportados: * corresponde a 0 ou mais caracteres (por exemplo, padrão abc* corresponderia a abc ou abcdef), ** corresponde a qualquer diretório, ? Corresponde a qualquer caractere único, [ABC] corresponde a um caractere entre colchetes e [A-C] corresponde a um caractere no intervalo. Os colchetes podem incluir uma negação para corresponder a qualquer caractere não especificado (por exemplo, [!abc] corresponde a qualquer caractere, exceto a, b ou c). Se um nome de arquivo começar com "." ele será ignorado por padrão, mas poderá ser correspondido especificando-o explicitamente (por exemplo, .gif não corresponderá .a.gif, mas ..gif será). Um exemplo simples: ***.txt corresponde a qualquer arquivo que não inicia em '.' e termina com .txt no diretório de trabalho Task ou em qualquer subdiretório. Se o nome do arquivo contiver um caractere curinga, ele pode ser escapado usando colchetes (por exemplo, abc[] corresponderia a um arquivo chamado abc). Note que ambos \ e / são tratados como separadores de diretório no Windows, mas apenas / está no Linux. As variáveis de ambiente (%var% no Windows ou $var no Linux) são expandidas antes do padrão ser aplicado.
uploadOptions	OutputFileUploadOptions	Opções adicionais para a operação de carregamento, incluindo em que condições realizar o carregamento.

OutputFileBlobContainerDestination

Especifica um destino de carregamento de arquivo em um contêiner de armazenamento de blob do Azure.

Name	Tipo	Description
containerUrl	string	A URL do contêiner no Armazenamento de Blobs do Azure para o qual carregar o(s) arquivo(s). Se não estiver usando uma identidade gerenciada, a URL deverá incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de gravação ao contêiner.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por containerUrl A identidade deve ter acesso de gravação ao contêiner de Armazenamento de Blob do Azure
path	string	O blob de destino ou diretório virtual dentro do contêiner de Armazenamento do Azure. Se filePattern se refere a um arquivo específico (ou seja, não contém curingas), então path é o nome do blob para o qual carregar esse arquivo. Se filePattern contiver um ou mais curingas (e, portanto, pode corresponder a vários arquivos), path é o nome do diretório virtual de blob (que é anexado a cada nome de blob) para o qual carregar o(s) arquivo(s). Se omitido, o(s) arquivo(s) é(são) carregado(s) na raiz do contêiner com um nome de blob correspondente ao nome do arquivo.
uploadHeaders	HttpHeader[]	Uma lista de pares nome-valor para cabeçalhos a serem usados no upload de arquivos de saída Esses cabeçalhos serão especificados ao carregar arquivos no Armazenamento do Azure. Documento oficial sobre cabeçalhos permitidos ao carregar blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

O destino para o qual um arquivo deve ser carregado.

Name	Tipo	Description
container	OutputFileBlobContainerDestination	Um local no armazenamento de blob do Azure para o qual os arquivos são carregados.

OutputFileUploadCondition

As condições sob as quais um arquivo de saída de tarefa ou conjunto de arquivos deve ser carregado.

Name	Tipo	Description
taskcompletion	string	Carregue o(s) arquivo(s) após a saída do processo de Tarefa, independentemente do código de saída.
taskfailure	string	Carregue o(s) arquivo(s) somente depois que o processo de Tarefa for encerrado com um código de saída diferente de zero.
tasksuccess	string	Carregue o(s) arquivo(s) somente depois que o processo de Tarefa sair com um código de saída de 0.

OutputFileUploadOptions

Detalhes sobre uma operação de upload de arquivo de saída, incluindo em que condições executar o upload.

Name	Tipo	Description
uploadCondition	OutputFileUploadCondition	As condições sob as quais o arquivo de saída da tarefa ou conjunto de arquivos deve ser carregado. O padrão é taskcompletion.

ResourceFile

Um único arquivo ou vários arquivos a serem baixados para um nó de computação.

Name	Tipo	Description
autoStorageContainerName	string	O nome do contêiner de armazenamento na conta de armazenamento automático. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada.
blobPrefix	string	O prefixo de blob a ser usado ao baixar blobs de um contêiner de Armazenamento do Azure. Somente os blobs cujos nomes começam com o prefixo especificado serão baixados. A propriedade é válida somente quando autoStorageContainerName ou storageContainerUrl é usado. Esse prefixo pode ser um nome de arquivo parcial ou um subdiretório. Se um prefixo não for especificado, todos os arquivos no contêiner serão baixados.
fileMode	string	O atributo file permission mode em formato octal. Esta propriedade aplica-se apenas a arquivos que estão sendo baixados para nós de computação do Linux. Ele será ignorado se for especificado para um resourceFile que será baixado para um nó de computação do Windows. Se essa propriedade não for especificada para um nó de computação do Linux, um valor padrão de 0770 será aplicado ao arquivo.
filePath	string	O local no nó de computação para o qual baixar o(s) arquivo(s), relativo ao diretório de trabalho da tarefa. Se a propriedade httpUrl for especificada, o filePath será necessário e descreverá o caminho para o qual o arquivo será baixado, incluindo o nome do arquivo. Caso contrário, se a propriedade autoStorageContainerName ou storageContainerUrl for especificada, filePath será opcional e será o diretório para o qual os arquivos serão baixados. No caso em que filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será mantida na íntegra e anexada ao diretório filePath especificado. O caminho relativo especificado não pode sair do diretório de trabalho da Tarefa (por exemplo, usando '..').
httpUrl	string	O URL do ficheiro a transferir. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para o Armazenamento de Blobs do Azure, ela deverá ser legível a partir dos nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma Assinatura de Acesso Compartilhado (SAS) concedendo permissões de leitura no blob, usar uma identidade gerenciada com permissão de leitura ou definir a ACL para o blob ou seu contêiner para permitir acesso público.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída ao usuário a ser usada para acessar o Armazenamento de Blob do Azure especificado por storageContainerUrl ou httpUrl A referência a uma identidade atribuída ao usuário associada ao pool de lotes que um nó de computação usará.
storageContainerUrl	string	A URL do contêiner de blob no Armazenamento de Blob do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Este URL deve ser legível e listável a partir de nós de computação. Há três maneiras de obter essa URL para um contêiner no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de leitura e lista no contêiner, usar uma identidade gerenciada com permissões de leitura e lista ou definir a ACL do contêiner para permitir acesso público.

TaskAddParameter

Uma Tarefa em Lote do Azure para adicionar.

Name	Tipo	Description
affinityInfo	AffinityInformation	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	ApplicationPackageReference[]	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	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	string	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	TaskConstraints	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	TaskContainerSettings	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	TaskDependencies	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	string	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	EnvironmentSetting[]	Uma lista de configurações de variáveis de ambiente para a Tarefa.
exitConditions	ExitConditions	Especifica como o serviço em lote deve responder quando a tarefa for concluída. Como o serviço de lote deve responder quando a tarefa for concluída.
id	string	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	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. Tarefas de várias instâncias são comumente usadas para dar suporte a tarefas MPI. No caso do MPI, se qualquer uma das subtarefas falhar (por exemplo, devido à saída com um código de saída diferente de zero), toda a Tarefa de várias instâncias falhará. A tarefa de várias instâncias é então encerrada e repetida, até seu limite de repetição.
outputFiles	OutputFile[]	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	integer	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	ResourceFile[]	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	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.

TaskConstraints

Restrições de execução a serem aplicadas a uma Tarefa.

Name	Tipo	Description
maxTaskRetryCount	integer	O número máximo de vezes que a Tarefa pode ser repetida. O serviço de lote tenta novamente uma tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de novas tentativas para o executável Task devido a um código de saída diferente de zero. O serviço de lote tentará a tarefa uma vez e, em seguida, poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de tentativas for 3, o Batch tentará a Tarefa até 4 vezes (uma tentativa inicial e 3 tentativas). Se a contagem máxima de tentativas for 0, o serviço em lote não repetirá a tarefa após a primeira tentativa. Se a contagem máxima de tentativas for -1, o serviço em lote repetirá a tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem tentativas).
maxWallClockTime	string	O tempo máximo decorrido que a Tarefa pode executar, medido a partir do momento em que a Tarefa é iniciada. Se a Tarefa não for concluída dentro do prazo, o serviço em lote a encerrará. Se isso não for especificado, não há limite de tempo para a execução da Tarefa.
retentionTime	string	O tempo mínimo para manter o diretório Task no Nó de Computação onde ele foi executado, a partir do momento em que ele conclui a execução. Após esse tempo, o serviço de lote pode excluir o diretório de tarefas e todo o seu conteúdo. O padrão é 7 dias, ou seja, o diretório de tarefas será mantido por 7 dias, a menos que o nó de computação seja removido ou o trabalho seja excluído.

TaskContainerSettings

As configurações de contêiner para uma Tarefa.

Name	Tipo	Description
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Os caminhos que você deseja montar para a tarefa de contêiner. Se essa matriz for nula ou não estiver presente, a tarefa de contêiner montará toda a unidade de disco temporária no Windows (ou AZ_BATCH_NODE_ROOT_DIR no Linux). Ele não montará nenhum caminho de dados no contêiner se essa matriz estiver definida como vazia.
containerRunOptions	string	Opções adicionais para o comando container create. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Batch Service.
imageName	string	A Imagem a ser usada para criar o contêiner no qual a Tarefa será executada. Esta é a referência completa da imagem, como seria especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da imagem, a tag ":latest" será usada como padrão.
registry	ContainerRegistry	O registro privado que contém a imagem do contêiner. Essa configuração pode ser omitida se já tiver sido fornecida na criação do pool.
workingDirectory	ContainerWorkingDirectory	O local do diretório de trabalho da tarefa do contêiner. O padrão é 'taskWorkingDirectory'.

TaskDependencies

Especifica quaisquer dependências de uma Tarefa. Qualquer Tarefa especificada explicitamente ou dentro de um intervalo de dependência deve ser concluída antes que a Tarefa dependente seja agendada.

Name	Tipo	Description
taskIdRanges	TaskIdRange[]	A lista de intervalos de ID de Tarefa dos quais esta Tarefa depende. Todas as Tarefas em todos os intervalos devem ser concluídas com êxito antes que a Tarefa dependente possa ser agendada.
taskIds	string[]	A lista de IDs de Tarefa da qual esta Tarefa depende. Todas as Tarefas nesta lista devem ser concluídas com êxito antes que a Tarefa dependente possa ser agendada. A coleção taskIds é limitada a 64000 caracteres no total (ou seja, o comprimento combinado de todos os IDs de tarefa). Se a coleção taskIds exceder o comprimento máximo, a solicitação Add Task falhará com o código de erro TaskDependencyListTooLong. Nesse caso, considere usar intervalos de ID de Tarefa.

TaskIdRange

Um intervalo de IDs de Tarefa do qual uma Tarefa pode depender. Todas as Tarefas com IDs no intervalo devem ser concluídas com êxito antes que a Tarefa dependente possa ser agendada.

Name	Tipo	Description
end	integer	A última ID de Tarefa no intervalo.
start	integer	A primeira ID de Tarefa no intervalo.

UserIdentity

A definição da identidade do usuário sob a qual a Tarefa é executada.

Name	Tipo	Description
autoUser	AutoUserSpecification	O usuário automático sob o qual a tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.
username	string	O nome da identidade do usuário sob a qual a Tarefa é executada. As propriedades userName e autoUser são mutuamente exclusivas; você deve especificar um, mas não ambos.