Task - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtém informações sobre a Tarefa especificada.
Para tarefas de várias instâncias, informações como affinityId, executionInfo e nodeInfo referem-se à Tarefa primária. Use a API de subtarefas de lista para recuperar informações sobre subtarefas.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2023-11-01.18.0

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço Lote do Azure.
jobId	path	True	string	A ID do Trabalho que contém a Tarefa.
taskId	path	True	string	A ID da Tarefa sobre a qual obter informações.
api-version	query	True	string	Versão da API do cliente.
$expand	query		string	Uma cláusula de $expand OData.
$select	query		string	Uma cláusula de $select OData.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos.

Cabeçalho da solicitação

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

Nome	Obrigató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, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Se o servidor deve retornar a client-request-id na resposta.
ocp-date		string date-time-rfc1123	A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.
If-Match		string	Um valor de ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente.
If-None-Match		string	Um valor de ETag associado à versão do recurso conhecido pelo cliente. A operação será executada somente se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.
If-Modified-Since		string date-time-rfc1123	Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço tiver sido modificado desde a hora especificada.
If-Unmodified-Since		string date-time-rfc1123	Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação será executada somente se o recurso no serviço não tiver sido modificado desde a hora especificada.

Respostas

Nome	Tipo	Description
200 OK	CloudTask	Uma resposta que contém a Tarefa. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Segurança

azure_auth

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	Representar sua conta de usuário

Authorization

Type: apiKey
In: header

Exemplos

Task get

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2016-09-06T06:59:15.1161429Z",
  "lastModified": "2016-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
  "commandLine": "cmd /c hostname",
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  },
  "multiInstanceSettings": {
    "numberOfInstances": 3,
    "coordinationCommandLine": "cmd /c echo coordinating"
  },
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "retentionTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "requiredSlots": 2,
  "executionInfo": {
    "retryCount": 0,
    "requeueCount": 0
  }
}

Definições

Nome	Description
AccessScope	Os recursos do Lote aos quais o token concede acesso.
AffinityInformation	Uma dica de localidade que pode ser usada pelo serviço lote 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 do Lote.
AutoUserScope	O escopo do usuário automático
AutoUserSpecification	Especifica os parâmetros para o usuário automático que executa uma Tarefa no serviço do Lote.
BatchError	Uma resposta de erro recebida do serviço Lote do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro Lote do Azure.
CloudTask	Uma tarefa Lote do Azure.
ComputeNodeIdentityReference	A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
ComputeNodeInformation	Informações sobre o Nó de Computação no qual uma Tarefa foi executada.
ContainerRegistry	Um registro de contêiner privado.
ContainerWorkingDirectory	O local do diretório de trabalho tarefa do contêiner.
DependencyAction	Uma ação que o serviço do 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 de tarefa.
ErrorCategory	A categoria do erro.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro Lote do Azure.
ExitCodeMapping	Como o serviço do Lote deve responder se uma Tarefa for encerrada com um código de saída específico.
ExitCodeRangeMapping	Um intervalo de códigos de saída e como o serviço do Lote deve responder aos códigos de saída dentro desse intervalo.
ExitConditions	Especifica como o serviço do Lote deve responder quando a Tarefa for concluída.
ExitOptions	Especifica como o serviço do Lote 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 tomada no Trabalho que contém a Tarefa, se a Tarefa for concluída com a condição de saída fornecida e a propriedade onTaskFailed do Trabalho for 'performExitOptionsJobAction'.
MultiInstanceSettings	Configurações que especificam como executar uma Tarefa de várias instâncias.
NameValuePair	Representa um par nome-valor.
OutputFile	Uma especificação para carregar arquivos de um nó de computação Lote do Azure para outro local depois que o serviço do Lote terminar de executar o processo de Tarefa.
OutputFileBlobContainerDestination	Especifica um destino de upload de arquivo em um contêiner de armazenamento de blobs 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 da Tarefa ou um conjunto de arquivos devem ser carregados.
OutputFileUploadOptions	Detalhes sobre uma operação de upload de arquivo de saída, incluindo sob quais condições executar o upload.
ResourceFile	Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.
TaskConstraints	Restrições de execução a serem aplicadas a uma Tarefa.
TaskContainerExecutionInformation	Contém informações sobre o contêiner que uma Tarefa está executando.
TaskContainerSettings	As configurações de contêiner de uma Tarefa.
TaskDependencies	Especifica as 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.
TaskExecutionInformation	Informações sobre a execução de uma Tarefa.
TaskExecutionResult	O resultado da execução da tarefa.
TaskFailureInformation	Informações sobre uma falha de tarefa.
TaskIdRange	Um intervalo de IDs de tarefa das quais 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.
TaskState	O estado da Tarefa.
TaskStatistics	Estatísticas de uso de recursos para uma Tarefa.
UserIdentity	A definição da identidade do usuário sob a qual a Tarefa é executada.

AccessScope

Os recursos do Lote aos quais o token concede acesso.

Nome	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 lote para selecionar um Nó de Computação no qual iniciar uma Tarefa.

Nome	Tipo	Description
affinityId	string	Uma cadeia de caracteres opaca que representa o local de um Nó de Computação ou uma Tarefa que foi executada anteriormente. Você pode passar a affinityId de um nó para indicar que essa Tarefa precisa ser executada nesse nó de computação. Observe que isso é 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.

Nome	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 http status código 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 do Lote.

Nome	Tipo	Description
access	AccessScope[]	Os recursos do Lote aos quais o token concede acesso. O token de autenticação concede acesso a um conjunto limitado de operações de serviço do Lote. Atualmente, o único valor com suporte para a propriedade de acesso é 'job', que concede acesso a todas as operações relacionadas ao Trabalho que contém a Tarefa.

AutoUserScope

O escopo do usuário automático

Nome	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 do Lote.

Nome	Tipo	Description
elevationLevel	ElevationLevel	O nível de elevação do usuário automático. O valor padrão é nonAdmin.
scope	AutoUserScope	O escopo do 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 alterar o registro de uma forma que possa afetar outras tarefas ou se os certificados tiverem sido especificados no pool, que não devem ser acessíveis por tarefas normais, mas devem ser acessíveis por StartTasks.

BatchError

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve 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 Lote do Azure.

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

CloudTask

Uma tarefa Lote do Azure.

Nome	Tipo	Description
affinityInfo	AffinityInformation	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	ApplicationPackageReference[]	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	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 marcar o status do Trabalho ou de outras Tarefas no Trabalho.
commandLine	string	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 a expansão da variável de ambiente. Se você 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 (em relação ao diretório de trabalho 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	TaskConstraints	As restrições de execução que se aplicam a esta Tarefa.
containerSettings	TaskContainerSettings	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 de Lote do Azure diretórios 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 do 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	string	A hora de criação da Tarefa.
dependsOn	TaskDependencies	As Tarefas das quais essa Tarefa depende. Esta 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	string	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.
eTag	string	A ETag da Tarefa. Essa é uma cadeia de caracteres opaca. Você pode usá-lo 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.
environmentSettings	EnvironmentSetting[]	Uma lista de configurações de variável de ambiente para a Tarefa.
executionInfo	TaskExecutionInformation	Informações sobre a execução da Tarefa.
exitConditions	ExitConditions	Especifica como o serviço do Lote deve responder quando a Tarefa for concluída. Como o serviço do Lote deve responder quando a Tarefa for concluída.
id	string	Uma cadeia de caracteres que identifica exclusivamente 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.
lastModified	string	A hora da última modificação da Tarefa.
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 de MPI. No caso de 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á. Em seguida, a Tarefa de várias instâncias é encerrada e repetida, até o limite de repetição.
nodeInfo	ComputeNodeInformation	Informações sobre o Nó de Computação no qual a Tarefa foi executada.
outputFiles	OutputFile[]	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	TaskState	O estado anterior da Tarefa. Essa propriedade não será definida se a Tarefa estiver em seu estado ativo inicial.
previousStateTransitionTime	string	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	integer	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	ResourceFile[]	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 obtido usando arquivos .zip, Pacotes de Aplicativos ou Contêineres do Docker.
state	TaskState	O estado atual da Tarefa.
stateTransitionTime	string	A hora em que a Tarefa inseriu seu estado atual.
stats	TaskStatistics	Estatísticas de uso de recursos para a Tarefa.
url	string	A URL da Tarefa.
userIdentity	UserIdentity	A identidade do usuário sob a qual a Tarefa é executada. Se omitida, a Tarefa será executada como um usuário não administrativo exclusivo para a Tarefa.

ComputeNodeIdentityReference

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

Nome	Tipo	Description
resourceId	string	A ID de recurso do ARM da identidade atribuída pelo usuário.

ComputeNodeInformation

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

Nome	Tipo	Description
affinityId	string	Um identificador para o Nó no qual a Tarefa foi executada, que pode ser passada ao adicionar uma Tarefa para solicitar que a Tarefa seja agendada neste Nó de Computação.
nodeId	string	A ID do Nó de Computação no qual a Tarefa foi executada.
nodeUrl	string	A URL do Nó de Computação no qual a Tarefa foi executada.
poolId	string	A ID do pool no qual a Tarefa foi executada.
taskRootDirectory	string	O diretório raiz da Tarefa no Nó de Computação.
taskRootDirectoryUrl	string	A URL para o diretório raiz da Tarefa no Nó de Computação.

ContainerRegistry

Um registro de contêiner privado.

Nome	Tipo	Description
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo 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 pelo usuário associada ao pool do Lote que um nó de computação usará.
password	string	A senha para fazer logon no servidor do Registro.
registryServer	string	A URL do registro. Se omitido, o padrão será "docker.io".
username	string	O nome de usuário para fazer logon no servidor do Registro.

ContainerWorkingDirectory

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

Nome	Tipo	Description
containerImageDefault	string	Use o diretório de trabalho definido na imagem do contêiner. Cuidado para que esse diretório não contenha os Arquivos de Recurso baixados pelo Lote.
taskWorkingDirectory	string	Use o diretório de trabalho task do serviço lote padrão, que conterá os Arquivos de Recurso de Tarefa preenchidos pelo Lote.

DependencyAction

Uma ação que o serviço do Lote executa em Tarefas que dependem dessa Tarefa.

Nome	Tipo	Description
block	string	Bloqueia tarefas aguardando essa tarefa, impedindo que elas sejam agendadas.
satisfy	string	Satisfaça tarefas aguardando esta tarefa; Depois que todas as dependências forem atendidas, a tarefa será agendada para ser executada.

ElevationLevel

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

Nome	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 de tarefa.

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

ErrorCategory

A categoria do erro.

Nome	Tipo	Description
servererror	string	O erro ocorre devido a um problema interno do servidor.
usererror	string	O erro ocorre devido a um problema do usuário, como configuração incorreta.

ErrorMessage

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

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

ExitCodeMapping

Como o serviço do Lote deve responder se uma Tarefa for encerrada com um código de saída específico.

Nome	Tipo	Description
code	integer	Um código de saída do processo.
exitOptions	ExitOptions	Como o serviço do Lote deve responder se a Tarefa for encerrada com esse código de saída.

ExitCodeRangeMapping

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

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

ExitConditions

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

Nome	Tipo	Description
default	ExitOptions	Como o serviço do Lote deve responder se a Tarefa falhar com uma condição de saída não coberta por nenhuma das outras propriedades. Esse valor será usado se a Tarefa 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 upload de arquivo se a propriedade fileUploadError não estiver presente. Se você quiser um comportamento não padrão no código de saída 0, deverá listá-lo explicitamente usando a coleção exitCodes ou exitCodeRanges.
exitCodeRanges	ExitCodeRangeMapping[]	Uma lista de intervalos de código de saída da tarefa e como o serviço do Lote deve responder a eles.
exitCodes	ExitCodeMapping[]	Uma lista de códigos de saída de tarefas individuais e como o serviço do Lote deve responder a eles.
fileUploadError	ExitOptions	Como o serviço do Lote deve responder se ocorrer um erro de upload de arquivo. Se a Tarefa foi encerrada com um código de saída especificado por meio de exitCodes ou exitCodeRanges e, em seguida, encontrou um erro de upload de arquivo, a ação especificada pelo código de saída terá precedência.
preProcessingError	ExitOptions	Como o serviço do Lote deve responder se a Tarefa não for iniciada devido a um erro.

ExitOptions

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

Nome	Tipo	Description
dependencyAction	DependencyAction	Uma ação que o serviço do Lote executa em Tarefas que dependem dessa Tarefa. Os valores possíveis são 'satisfação' (permitindo que tarefas dependentes progridam) e 'bloquear' (as tarefas dependentes continuam aguardando). O Lote ainda não dá suporte ao cancelamento de tarefas dependentes.
jobAction	JobAction	Uma ação a ser tomada no Trabalho que contém a Tarefa, se a Tarefa for concluída com a condição de saída fornecida e a propriedade onTaskFailed do Trabalho for 'performExitOptionsJobAction'. O padrão é nenhum para o código de saída 0 e terminar 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 adicionar Tarefa 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

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

JobAction

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

Nome	Tipo	Description
disable	string	Desabilite o Trabalho. Isso é equivalente a chamar a API de desabilitar Trabalho, com um valor disableTasks de requeue.
none	string	Não tome nenhuma ação.
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.

Nome	Tipo	Description
commonResourceFiles	ResourceFile[]	Uma lista de arquivos que o serviço do Lote baixará antes de executar a linha de comando de coordenação. A diferença entre arquivos de recurso comuns e arquivos de recurso de tarefa é que os arquivos de recurso comuns são baixados para todas as subtarefas, incluindo a primária, enquanto os arquivos de recurso de tarefa são baixados apenas para o primário. Observe também que esses arquivos de recurso não são baixados para o diretório de trabalho Tarefa, mas, em vez disso, são baixados para o diretório raiz da tarefa (um diretório acima do diretório de trabalho). 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.
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 executar o comando tarefa main. 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.

NameValuePair

Representa um par nome-valor.

Nome	Tipo	Description
name	string	O nome no par nome-valor.
value	string	O valor no par nome-valor.

OutputFile

Uma especificação para carregar arquivos de um nó de computação Lote do Azure para outro local depois que o serviço do Lote terminar de executar o processo de Tarefa.

Nome	Tipo	Description
destination	OutputFileDestination	O destino dos arquivos de saída.
filePattern	string	Um padrão que indica quais arquivos carregar. Há suporte para caminhos relativos e absolutos. Os caminhos relativos são relativos ao diretório de trabalho tarefa. Há suporte para os seguintes caracteres curinga: * corresponde a 0 ou mais caracteres (por exemplo, o 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. Colchetes podem incluir uma negação para corresponder a qualquer caractere não especificado (por exemplo , [!abc] corresponde a qualquer caractere, mas 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 .a.gif, mas ..gif corresponderá). Um exemplo simples: ***.txt corresponde a qualquer arquivo que não seja iniciado em '.' e termina com .txt no diretório Trabalho da tarefa ou em qualquer subdiretório. Se o nome do arquivo contiver um caractere curinga, ele poderá ser escapado usando colchetes (por exemplo, abc[] corresponderia a um arquivo chamado abc). Observe que \ 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 da aplicação do padrão.
uploadOptions	OutputFileUploadOptions	Opções adicionais para a operação de upload, incluindo sob quais condições executar o upload.

OutputFileBlobContainerDestination

Especifica um destino de upload de arquivo em um contêiner de armazenamento de blobs do Azure.

Nome	Tipo	Description
containerUrl	string	A URL do contêiner no Armazenamento de Blobs do Azure para o qual carregar os arquivos. Se não estiver usando uma identidade gerenciada, a URL deverá incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de gravação ao contêiner.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo usuário a ser usada para acessar Armazenamento de Blobs do Azure especificada por containerUrl A identidade deve ter acesso de gravação ao contêiner Armazenamento de Blobs do Azure
path	string	O blob de destino ou o diretório virtual dentro do contêiner do Armazenamento do Azure. Se filePattern se referir a um arquivo específico (ou seja, não contiver caracteres curinga), o caminho será 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 será o nome do diretório virtual do blob (que é anexado a cada nome de blob) para o qual carregar os arquivos. Se omitido, os arquivos serão carregados 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 carregamento 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://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

O destino para o qual um arquivo deve ser carregado.

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

OutputFileUploadCondition

As condições sob as quais um arquivo de saída da Tarefa ou um conjunto de arquivos devem ser carregados.

Nome	Tipo	Description
taskcompletion	string	Carregue os arquivos após a saída do processo de tarefa, independentemente do código de saída.
taskfailure	string	Carregue os arquivos somente depois que o processo de tarefa for encerrado com um código de saída diferente de zero.
tasksuccess	string	Carregue os arquivos somente depois que o processo de tarefa for encerrado com um código de saída de 0.

OutputFileUploadOptions

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

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

ResourceFile

Um único arquivo ou vários arquivos a serem baixados em um Nó de Computação.

Nome	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 do 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 de modo de permissão de arquivo no formato octal. Essa propriedade se aplica somente aos 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 os arquivos, em relação 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 baixar os arquivos. 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 acrescentada 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	A URL do arquivo para download. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Se a URL apontar para Armazenamento de Blobs do Azure, ela deverá ser legível de nós de computação. Há três maneiras de obter essa URL para um blob no armazenamento do Azure: incluir uma SAS (Assinatura de Acesso Compartilhado) 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 o acesso público.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo usuário a ser usada para acessar Armazenamento de Blobs do Azure especificada por storageContainerUrl ou httpUrl A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
storageContainerUrl	string	A URL do contêiner de blob no Armazenamento de Blobs do Azure. As propriedades autoStorageContainerName, storageContainerUrl e httpUrl são mutuamente exclusivas e uma delas deve ser especificada. Essa URL deve ser legível e listável 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 para o contêiner para permitir acesso público.

TaskConstraints

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

Nome	Tipo	Description
maxTaskRetryCount	integer	O número máximo de vezes que a Tarefa pode ser repetida. O serviço do Lote tentará novamente uma Tarefa se seu código de saída for diferente de zero. Observe que esse valor controla especificamente o número de repetições para o executável task devido a um código de saída diferente de zero. O serviço lote tentará a Tarefa uma vez e poderá tentar novamente até esse limite. Por exemplo, se a contagem máxima de repetições for 3, o Lote tentará a Tarefa até 4 vezes (uma tentativa inicial e três novas tentativas). Se a contagem máxima de repetições for 0, o serviço do Lote não repetirá a Tarefa após a primeira tentativa. Se a contagem máxima de repetições for -1, o serviço do Lote tentará novamente a Tarefa sem limite, no entanto, isso não é recomendado para uma tarefa inicial ou qualquer tarefa. O valor padrão é 0 (sem novas 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 limite de tempo, o serviço do Lote a encerrará. Se isso não for especificado, não haverá nenhum limite de tempo para que a Tarefa possa ser executada.
retentionTime	string	O tempo mínimo para manter o diretório Task no Nó de Computação em que ele foi executado, a partir do momento em que ele conclui a execução. Após esse período, o serviço lote poderá excluir o diretório Task e todo o seu conteúdo. O padrão é 7 dias, ou seja, o diretório Tarefa será mantido por 7 dias, a menos que o Nó de Computação seja removido ou o Trabalho seja excluído.

TaskContainerExecutionInformation

Contém informações sobre o contêiner que uma Tarefa está executando.

Nome	Tipo	Description
containerId	string	O ID do contêiner.
error	string	Informações detalhadas de erro sobre o contêiner. Essa é a cadeia de caracteres de erro detalhada do serviço docker, se disponível. É equivalente ao campo de erro retornado por "docker inspect".
state	string	O estado do contêiner. Esse é o estado do contêiner de acordo com o serviço do Docker. É equivalente ao campo status retornado por "docker inspect".

TaskContainerSettings

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

Nome	Tipo	Description
containerRunOptions	string	Opções adicionais para o comando de criação de contêiner. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além daquelas controladas pelo Serviço de Lote.
imageName	string	A Imagem a ser usada para criar o contêiner no qual a Tarefa será executada. Essa é a referência de imagem completa, como seria especificado para "docker pull". Se nenhuma marca for fornecida como parte do nome da imagem, a marca ":latest" será usada como padrão.
registry	ContainerRegistry	O registro privado que contém a Imagem do contêiner. Essa configuração poderá ser omitida se já tiver sido fornecida na criação do pool.
workingDirectory	ContainerWorkingDirectory	O local do diretório de trabalho tarefa do contêiner. O padrão é 'taskWorkingDirectory'.

TaskDependencies

Especifica as 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.

Nome	Tipo	Description
taskIdRanges	TaskIdRange[]	A lista de intervalos de ID da Tarefa dos quais essa 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 das quais essa 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 ao total de 64.000 caracteres (ou seja, o comprimento combinado de todas as IDs de Tarefa). Se a coleção taskIds exceder o comprimento máximo, a solicitação Adicionar Tarefa falhará com o código de erro TaskDependencyListTooLong. Nesse caso, considere usar intervalos de ID da tarefa.

TaskExecutionInformation

Informações sobre a execução de uma Tarefa.

Nome	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contêiner no qual a Tarefa está sendo executada. Essa propriedade será definida somente se a Tarefa for executada em um contexto de contêiner.
endTime	string	A hora em que a Tarefa foi concluída. Essa propriedade será definida somente se a Tarefa estiver no estado Concluído.
exitCode	integer	O código de saída do programa especificado na linha de comando Tarefa. Essa propriedade será definida somente se a Tarefa estiver no estado concluído. Em geral, o código de saída de um processo reflete a convenção específica implementada pelo desenvolvedor de aplicativos para esse processo. Se você usar o valor do código de saída para tomar decisões em seu código, certifique-se de conhecer a convenção de código de saída usada pelo processo do aplicativo. No entanto, se o serviço do Lote encerrar a Tarefa (devido ao tempo limite ou ao término do usuário por meio da API), você poderá ver um código de saída definido pelo sistema operacional.
failureInfo	TaskFailureInformation	Informações que descrevem a falha da tarefa, se houver. Essa propriedade será definida somente se a Tarefa estiver no estado concluído e encontrar uma falha.
lastRequeueTime	string	A hora mais recente em que a Tarefa foi reencatada pelo serviço do Lote como resultado de uma solicitação do usuário. Essa propriedade será definida somente se requeueCount for diferente de zero.
lastRetryTime	string	A hora mais recente em que uma nova tentativa da Tarefa começou a ser executada. Esse elemento estará presente somente se a Tarefa tiver sido repetida (ou seja, retryCount for diferente de zero). Se presente, isso normalmente é o mesmo que startTime, mas pode ser diferente se a Tarefa tiver sido reiniciada por motivos diferentes da repetição; por exemplo, se o Nó de Computação foi reinicializado durante uma repetição, o startTime é atualizado, mas o lastRetryTime não é.
requeueCount	integer	O número de vezes que a Tarefa foi reencatada pelo serviço do Lote como resultado de uma solicitação do usuário. Quando o usuário remove nós de computação de um pool (redimensionando/reduzindo o pool) ou quando o Trabalho está sendo desabilitado, o usuário pode especificar que tarefas em execução nos nós de computação sejam requeuídas para execução. Essa contagem rastreia quantas vezes a Tarefa foi reencatada por esses motivos.
result	TaskExecutionResult	O resultado da execução da tarefa. Se o valor for 'failed', os detalhes da falha poderão ser encontrados na propriedade failureInfo.
retryCount	integer	O número de vezes que a Tarefa foi repetida pelo serviço lote. As falhas do aplicativo de tarefa (código de saída diferente de zero) são repetidas, erros de pré-processamento (a Tarefa não pôde ser executada) e os erros de upload de arquivo não são repetidos. O serviço do Lote repetirá a Tarefa até o limite especificado pelas restrições.
startTime	string	A hora em que a Tarefa começou a ser executada. 'Running' corresponde ao estado em execução; portanto, se a Tarefa especificar arquivos de recurso ou Pacotes, a hora de início refletirá a hora em que a Tarefa começou a baixá-los ou implantá-los. Se a Tarefa tiver sido reiniciada ou repetida, esta será a hora mais recente em que a Tarefa começou a ser executada. Essa propriedade está presente apenas para Tarefas que estão no estado em execução ou concluído.

TaskExecutionResult

O resultado da execução da tarefa.

Nome	Tipo	Description
failure	string	Ocorreu um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes da inicialização do processo de tarefa, enquanto o processo de tarefa estava em execução ou depois que o processo de tarefa foi encerrado.
success	string	A Tarefa foi executada com êxito.

TaskFailureInformation

Informações sobre uma falha de tarefa.

Nome	Tipo	Description
category	ErrorCategory	A categoria do erro Task.
code	string	Um identificador para o erro Tarefa. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	NameValuePair[]	Uma lista de detalhes adicionais relacionados ao erro.
message	string	Uma mensagem que descreve o erro Tarefa, destinada a ser adequada para exibição em uma interface do usuário.

TaskIdRange

Um intervalo de IDs de tarefa das quais 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.

Nome	Tipo	Description
end	integer	A última ID da Tarefa no intervalo.
start	integer	A primeira ID da Tarefa no intervalo.

TaskState

O estado da Tarefa.

Nome	Tipo	Description
active	string	A Tarefa está na fila e pode ser executada, mas não está atribuída atualmente a um Nó de Computação. Uma Tarefa entra nesse estado quando é criada, quando está habilitada após ser desabilitada ou quando aguarda uma nova tentativa após uma execução com falha.
completed	string	A Tarefa não está mais qualificada para ser executada, geralmente porque a Tarefa foi concluída com êxito ou a Tarefa foi concluída sem sucesso e esgotou o limite de repetição. Uma Tarefa também será marcada como concluída se ocorrer um erro ao iniciar a Tarefa ou quando a Tarefa tiver sido encerrada.
preparing	string	A Tarefa foi atribuída a um Nó de Computação, mas está aguardando a conclusão de uma Tarefa de Preparação de Trabalho necessária no Nó de Computação. Se a Tarefa de Preparação do Trabalho for bem-sucedida, a Tarefa passará para a execução. Se a Tarefa de Preparação do Trabalho falhar, a Tarefa retornará à ativa e será qualificada para ser atribuída a um nó de computação diferente.
running	string	A Tarefa está em execução em um Nó de Computação. Isso inclui a preparação no nível da tarefa, como baixar arquivos de recurso ou implantar pacotes especificados na Tarefa , isso não significa necessariamente que a linha de comando Task tenha começado a ser executada.

TaskStatistics

Estatísticas de uso de recursos para uma Tarefa.

Nome	Tipo	Description
kernelCPUTime	string	O tempo total de CPU do modo kernel (somado em todos os núcleos e todos os nós de computação) consumidos pela Tarefa.
lastUpdateTime	string	A hora em que as estatísticas foram atualizadas pela última vez. Todas as estatísticas são limitadas ao intervalo entre startTime e lastUpdateTime.
readIOGiB	number	O total de gibibytes lidos do disco pela Tarefa.
readIOps	integer	O número total de operações de leitura de disco feitas pela Tarefa.
startTime	string	A hora de início do intervalo de tempo coberto pelas estatísticas.
url	string	A URL das estatísticas.
userCPUTime	string	O tempo total de CPU do modo de usuário (somado em todos os núcleos e todos os nós de computação) consumidos pela Tarefa.
waitTime	string	O tempo total de espera da Tarefa. O tempo de espera para uma Tarefa é definido como o tempo decorrido entre a criação da Tarefa e o início da execução da Tarefa. (Se a Tarefa for repetida devido a falhas, o tempo de espera será o tempo para a execução mais recente da Tarefa.)
wallClockTime	string	O tempo total do relógio de parede da Tarefa. A hora do relógio de parede é o tempo decorrido de quando a Tarefa começou a ser executada em um Nó de Computação até quando foi concluída (ou até a última vez em que as estatísticas foram atualizadas, se a Tarefa não tiver sido concluída até então). Se a Tarefa tiver sido repetida, isso incluirá a hora do relógio de parede de todas as tentativas de Tarefa.
writeIOGiB	number	O total de gibibytes gravados em disco pela Tarefa.
writeIOps	integer	O número total de operações de gravação de disco feitas pela Tarefa.

UserIdentity

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

Nome	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.