Compartilhar via


Nodes - List Nodes

Lista os nós de computação no pool especificado.

GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01
GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}&$select={$select}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string (uri)

Ponto de extremidade da conta do Lote (por exemplo: https://batchaccount.eastus2.batch.azure.com).

poolId
path True

string

O ID do Pool de onde você quer listar os Nós de Computação.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

$filter
query

string

Uma cláusula $filter OData. Para mais informações sobre como construir esse filtro, veja https://v4.hkg1.meaqua.org/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.

$select
query

string[]

Uma cláusula $select OData.

maxresults
query

integer (int32)

minimum: 1
maximum: 1000

O número máximo de itens a serem retornados na resposta. No máximo 1000 solicitações podem ser devolvidas.

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 em seu lugar.".

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
client-request-id

string

A identidade da 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 ID de solicitação do cliente na resposta.

ocp-date

string (date-time-rfc7231)

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.

Respostas

Nome Tipo Description
200 OK

BatchNodeListResult

A solicitação foi bem-sucedida.

Cabeçalhos

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

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

Escopos

Nome Description
https://batch.core.windows.net//.default

Exemplos

Node list

Solicitação de exemplo

GET {endpoint}/pools/poolId/nodes?api-version=2025-06-01


Resposta de exemplo

{
  "value": [
    {
      "id": "tvm-1695681911_1-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T22:22:27.2236818Z",
      "lastBootTime": "2025-11-22T22:22:24.4634125Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T22:22:27.2236818Z",
        "endTime": "2025-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_2-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T19:37:31.4285526Z",
      "lastBootTime": "2025-11-22T19:37:28.623369Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T19:37:31.4285526Z",
        "endTime": "2025-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_3-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T19:36:51.0013378Z",
      "lastBootTime": "2025-11-22T19:36:48.21721Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T19:36:51.0013378Z",
        "endTime": "2025-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Definições

Nome Description
AutoUserScope

Enums AutoUserScope

AutoUserSpecification

Especifica as opções para o usuário automático que executa uma Tarefa do Lote do Azure.

BatchError

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

BatchErrorDetail

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

BatchErrorMessage

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

BatchErrorSourceCategory

BatchErrorSourceCategory enums

BatchNode

Um nó de computação no serviço do Lote.

BatchNodeAgentInfo

O agente do Nó de Computação em Lote é um programa que é executado em cada Nó de Computação no Pool e fornece recursos do Lote no Nó de Computação.

BatchNodeEndpointConfiguration

A configuração do ponto de extremidade para o Nó de Computação.

BatchNodeError

Um erro encontrado por um Nó de Computação.

BatchNodeIdentityReference

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

BatchNodeListResult

O resultado da listagem dos nós de computação em um pool.

BatchNodeState

Enus do BatchNodeState

BatchStartTask

O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente, mesmo que o Nó de Computação não tenha sido reinicializado. Deve-se tomar cuidado especial para evitar StartTasks que criam o processo de separação ou instalam/iniciam serviços do diretório de trabalho StartTask, pois isso impedirá que o Lote seja capaz de executar novamente o StartTask.

BatchStartTaskInfo

Informações sobre um StartTask em execução em um Nó de Computação.

BatchStartTaskState

Enums BatchStartTaskState

BatchTaskContainerExecutionInfo

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

BatchTaskContainerSettings

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

BatchTaskExecutionInfo

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

BatchTaskExecutionResult

Enums BatchTaskExecutionResult

BatchTaskFailureInfo

Informações sobre uma falha de tarefa.

BatchTaskInfo

Informações sobre uma tarefa em execução em um Nó de Computação.

BatchTaskState

Enums BatchTaskState

BatchVmImageReference

Uma referência a uma imagem do Marketplace de Máquinas Virtuais do Azure ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem do Azure Marketplace verificadas pelo Lote do Azure, consulte a operação ' Listar Imagens Com Suporte'.

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 de contêiner.

ContainerRegistryReference

Um registro de contêiner privado.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

ElevationLevel

Enums de Elevação

EnvironmentSetting

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

InboundEndpoint

Um ponto de extremidade de entrada em um Nó de Computação.

InboundEndpointProtocol

InboundEndpointProtocol enums

NameValuePair

Representa um par nome-valor.

ResourceFile

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

SchedulingState

ProgramamentoEstátuos enums

UserIdentity

A definição da identidade do usuário na qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas.

VirtualMachineInfo

Informações sobre o estado atual da máquina virtual.

AutoUserScope

Enums AutoUserScope

Valor Description
task

Especifica que o serviço deve criar um novo usuário para a Tarefa.

pool

Especifica que a Tarefa roda como a conta de usuário automático comum, criada em cada Nó de Computação em um Pool.

AutoUserSpecification

Especifica as opções para o usuário automático que executa uma Tarefa do Lote do Azure.

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

BatchError

Uma resposta de erro recebida do serviço do 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

BatchErrorMessage

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

BatchErrorMessage

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

Nome Tipo Description
lang

string

O código de idioma da mensagem de erro.

value

string

O texto da mensagem.

BatchErrorSourceCategory

BatchErrorSourceCategory enums

Valor Description
usererror

O erro se deve a um problema do usuário, como uma configuração incorreta.

servererror

O erro se deve a um problema interno no servidor.

BatchNode

Um nó de computação no serviço do Lote.

Nome Tipo Description
affinityId

string

Um identificador que pode ser passado ao adicionar uma Tarefa para solicitar que a Tarefa seja agendada neste 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.

allocationTime

string (date-time)

O momento em que esse Nó de Computação foi alocado para o pool. Esse é o momento em que o Nó de Computação foi alocado inicialmente e não é alterado uma vez definido. Ele não é atualizado quando o Nó de Computação é recuperado ou preempto.

endpointConfiguration

BatchNodeEndpointConfiguration

A configuração do ponto de extremidade para o Nó de Computação.

errors

BatchNodeError[]

A lista de erros que estão sendo encontrados no momento pelo Nó de Computação.

id

string

A ID do Nó de Computação. Cada nó de computação adicionado a um pool recebe uma ID exclusiva. Sempre que um Nó de Computação é removido de um Pool, todos os seus arquivos locais são excluídos e a ID é recuperada e pode ser reutilizado para novos Nós de Computação.

ipAddress

string

O endereço IP que outros nós podem usar para se comunicar com esse Nó de Computação. Cada nó de computação adicionado a um pool recebe um endereço IP exclusivo. Sempre que um Nó de Computação é removido de um Pool, todos os seus arquivos locais são excluídos e o endereço IP é recuperado e pode ser reutilizado para novos Nós de Computação.

ipv6Address

string

O endereço IPv6 que outros nós podem usar para se comunicar com esse nó de computação. Cada nó de computação adicionado a um pool recebe um endereço IP exclusivo. Sempre que um Nó de Computação é removido de um Pool, todos os seus arquivos locais são excluídos e o endereço IP é recuperado e pode ser reutilizado para novos Nós de Computação. Essa propriedade não estará presente se o pool não estiver configurado para IPv6.

isDedicated

boolean

Se esse Nó de Computação é um nó de computação dedicado. Se for falso, o Nó de Computação será um nó de computação spot/de baixa prioridade.

lastBootTime

string (date-time)

A última vez em que o Nó de Computação foi iniciado. Essa propriedade poderá não estar presente se o estado do Nó de Computação for inutilizável.

nodeAgentInfo

BatchNodeAgentInfo

Informações sobre a versão do agente do Nó de Computação e a hora em que o Nó de Computação foi atualizado para uma nova versão.

recentTasks

BatchTaskInfo[]

Uma lista de Tarefas cujo estado foi alterado recentemente. Essa propriedade só estará presente se pelo menos uma Tarefa tiver sido executada neste Nó de Computação desde que foi atribuída ao Pool.

runningTaskSlotsCount

integer (int32)

O número total de slots de agendamento usados pela execução atual de Tarefas de Trabalho no Nó de Computação. Isso inclui tarefas do Gerenciador de Trabalho e tarefas normais, mas não preparação de trabalho, liberação de trabalho ou tarefas de início.

runningTasksCount

integer (int32)

O número total de tarefas de trabalho em execução no momento no Nó de Computação. Isso inclui tarefas do Gerenciador de Trabalho e tarefas normais, mas não preparação de trabalho, liberação de trabalho ou tarefas de início.

schedulingState

SchedulingState

Se o Nó de Computação está disponível para agendamento de tarefas.

startTask

BatchStartTask

A Tarefa especificada para ser executada no Nó de Computação à medida que ele ingressa no Pool.

startTaskInfo

BatchStartTaskInfo

Informações de runtime sobre a execução do StartTask no Nó de Computação.

state

BatchNodeState

O estado atual do Nó de Computação.

stateTransitionTime

string (date-time)

A hora em que o Nó de Computação inseriu seu estado atual.

totalTasksRun

integer (int32)

O número total de Tarefas de Trabalho concluídas no Nó de Computação. Isso inclui tarefas do Gerenciador de Trabalho e tarefas normais, mas não preparação de trabalho, liberação de trabalho ou tarefas de início.

totalTasksSucceeded

integer (int32)

O número total de Tarefas de Trabalho que foram concluídas com êxito (com exitCode 0) no Nó de Computação. Isso inclui tarefas do Gerenciador de Trabalho e tarefas normais, mas não preparação de trabalho, liberação de trabalho ou tarefas de início.

url

string (uri)

A URL do Nó de Computação.

virtualMachineInfo

VirtualMachineInfo

Informações sobre o estado atual da máquina virtual.

vmSize

string

O tamanho da máquina virtual que hospeda o Nó de Computação. Para obter informações sobre os tamanhos disponíveis de máquinas virtuais em Pools, consulte Escolher um tamanho de VM para Nós de Computação em um Pool do Lote do Azure (https://v4.hkg1.meaqua.org/azure/batch/batch-pool-vm-sizes).

BatchNodeAgentInfo

O agente do Nó de Computação em Lote é um programa que é executado em cada Nó de Computação no Pool e fornece recursos do Lote no Nó de Computação.

Nome Tipo Description
lastUpdateTime

string (date-time)

O momento em que o agente do Nó de Computação foi atualizado no Nó de Computação. Esta é a última vez que o agente do Compute Node foi atualizado para uma nova versão.

version

string

A versão do agente Batch Compute Node rodando no Compute Node. Esse número de versão pode ser verificado com as notas de release do agente Compute Node localizadas em https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

BatchNodeEndpointConfiguration

A configuração do ponto de extremidade para o Nó de Computação.

Nome Tipo Description
inboundEndpoints

InboundEndpoint[]

A lista de endpoints de entrada acessíveis no Nó de Computação.

BatchNodeError

Um erro encontrado por um Nó de Computação.

Nome Tipo Description
code

string

Um identificador para o erro Compute Node. Os códigos são invariáveis e devem ser consumidos programaticamente.

errorDetails

NameValuePair[]

A lista de detalhes adicionais de erro relacionados ao erro do Nó de Computação.

message

string

Uma mensagem descrevendo o erro Compute Node, destinada a ser adequada para exibição em uma interface de usuário.

BatchNodeIdentityReference

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 (arm-id)

A ID de recurso do ARM da identidade atribuída pelo usuário.

BatchNodeListResult

O resultado da listagem dos nós de computação em um pool.

Nome Tipo Description
odata.nextLink

string (uri)

A URL para obter o próximo conjunto de resultados.

value

BatchNode[]

A lista de Nós de Computação.

BatchNodeState

Enus do BatchNodeState

Valor Description
idle

O Nó de Computação não está executando uma Tarefa no momento.

rebooting

O Nó de Computação está reiniciando.

reimaging

O Nó de Computação está sendo reimaginado.

running

O Nó de Computação está executando uma ou mais Tarefas (exceto uma StartTask).

unusable

O Nó de Computação não pode ser usado para execução de Tarefa devido a erros.

creating

O serviço Batch obteve a máquina virtual subjacente do Azure Compute, mas ainda não começou a se juntar ao Pool.

starting

O serviço Batch está começando na máquina virtual subjacente.

waitingforstarttask

O StartTask começou a rodar no Compute Node, mas waitForSuccess está definido e o StartTask ainda não foi concluído.

starttaskfailed

O StartTask falhou no Nó de Computação (e esgotou todas as tentativas), e o waitForSuccess foi ativado. O Nó de Computação não é utilizável para executar Tarefas.

unknown

O serviço Batch perdeu contato com o Nó de Computação e não conhece seu estado real.

leavingpool

O Nó de Computação está saindo do Pool, seja porque o usuário o removeu explicitamente ou porque o Pool está redimensionando ou reduzindo automaticamente.

offline

O Nó de Computação não está executando uma Tarefa, e o agendamento de novas Tarefas para o Nó de Computação está desativado.

preempted

O Nó de Computação spot/de baixa prioridade foi preemptado. As tarefas que estavam em execução no Nó de Computação quando ele foi preempcionado serão reagendadas quando outro Nó de Computação estiver disponível.

upgradingos

O Nó de Computação está passando por uma operação de atualização do sistema operacional.

deallocated

O Nó de Computação é realocado.

deallocating

O Nó de Computação está desalocando o processo.

BatchStartTask

O Lote tentará novamente tarefas quando uma operação de recuperação for disparada em um nó. Exemplos de operações de recuperação incluem (mas não se limitam a) quando um nó não íntegro é reinicializado ou um Nó de Computação desapareceu devido a uma falha de host. As novas tentativas devido às operações de recuperação são independentes e não são contadas em relação ao maxTaskRetryCount. Mesmo que o maxTaskRetryCount seja 0, uma repetição interna devido a uma operação de recuperação poderá ocorrer. Por isso, todas as tarefas devem ser idempotentes. Isso significa que as tarefas precisam tolerar ser interrompidas e reiniciadas sem causar dados corrompidos ou duplicados. A melhor prática para tarefas de execução longa é usar alguma forma de ponto de verificação. Em alguns casos, o StartTask pode ser executado novamente, mesmo que o Nó de Computação não tenha sido reinicializado. Deve-se tomar cuidado especial para evitar StartTasks que criam o processo de separação ou instalam/iniciam serviços do diretório de trabalho StartTask, pois isso impedirá que o Lote seja capaz de executar novamente o StartTask.

Nome Tipo Description
commandLine

string

A linha de comando do StartTask. A linha de comando não é executada em um shell e, portanto, não pode aproveitar os recursos do shell, como expansão de variável de ambiente. Se quiser aproveitar esses recursos, invoque o shell na linha de comando, por exemplo, usando "cmd /c MyCommand" no Windows ou "/bin/sh -c MyCommand" no Linux. Se a linha de comando se referir a caminhos de arquivo, ela deverá usar um caminho relativo (relativo ao diretório de trabalho da Tarefa) ou usar a variável de ambiente fornecida pelo Lote (https://v4.hkg1.meaqua.org/azure/batch/batch-compute-node-environment-variables).

containerSettings

BatchTaskContainerSettings

As configurações do contêiner sob o qual o StartTask roda. Quando isso é especificado, todos os diretórios recursivamente abaixo do AZ_BATCH_NODE_ROOT_DIR (a raiz dos diretórios Batch do Azure no nó) são mapeados no contêiner, todas as variáveis do ambiente Tarefa são mapeadas no contêiner, e a linha de comando Tarefa é executada no contêiner. Arquivos produzidos no contêiner fora do AZ_BATCH_NODE_ROOT_DIR podem não ser refletidos no disco hospedeiro, o que significa que APIs de arquivos Batch não conseguirão acessar esses arquivos.

environmentSettings

EnvironmentSetting[]

Uma lista de configurações de variável de ambiente para o StartTask.

maxTaskRetryCount

integer (int32)

O número máximo de vezes que a Tarefa pode ser repetida. O serviço do Lote tentará novamente uma Tarefa se o código de saída não for zero. Observe que esse valor controla especificamente o número de repetições. 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ção for 3, o Lote tentará a Tarefa até 4 vezes (uma tentativa inicial e três tentativas). Se a contagem máxima de repetição for 0, o serviço do Lote não tentará novamente a Tarefa. Se a contagem máxima de repetição for -1, o serviço do 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 novas tentativas).

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. 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. Os arquivos listados sob esse elemento estão localizados no diretório de trabalho da Tarefa.

userIdentity

UserIdentity

A identidade do usuário sob a qual o StartTask é executado. Se omitida, a Tarefa roda como um usuário não administrativo exclusivo da Tarefa.

waitForSuccess

boolean

Se o serviço do Lote deve aguardar a conclusão do StartTask com êxito (ou seja, sair com o código de saída 0) antes de agendar tarefas no Nó de Computação. Se true e o StartTask falharem em um nó, o serviço do Lote tentará novamente o StartTask até sua contagem máxima de repetição (maxTaskRetryCount). Se a Tarefa ainda não tiver sido concluída com êxito após todas as novas tentativas, o serviço do Lote marcará o nó inutilizável e não agendará Tarefas para ela. Essa condição pode ser detectada por meio do estado do Nó de Computação e dos detalhes das informações de falha. Se for falso, o serviço do Lote não aguardará a conclusão do StartTask. Nesse caso, outras tarefas podem começar a ser executadas no Nó de Computação enquanto o StartTask ainda estiver em execução; e mesmo que o StartTask falhe, novas tarefas continuarão a ser agendadas no Nó de Computação. O padrão é verdadeiro.

BatchStartTaskInfo

Informações sobre um StartTask em execução em um Nó de Computação.

Nome Tipo Description
containerInfo

BatchTaskContainerExecutionInfo

Informações sobre o contêiner sob o qual a Tarefa está sendo executada. Essa propriedade é definida apenas se a Tarefa rodar em um contexto de container.

endTime

string (date-time)

O momento em que o StartTask parou de funcionar. Este é o tempo de fim da execução mais recente do StartTask, se essa execução já foi concluída (mesmo que ela tenha falhado e uma tentativa de novo esteja pendente). Esse elemento não está presente se o StartTask estiver em execução no momento.

exitCode

integer (int32)

O código de saída do programa especificado na linha de comando StartTask. Essa propriedade é definida apenas se o StartTask 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 da aplicação para aquele processo. Se você usar o valor do código de saída para tomar decisões no seu código, certifique-se de conhecer a convenção do código de saída usada pelo processo de aplicação. No entanto, se o serviço Batch terminar o StartTask (devido ao timeout ou ao término do usuário via API), você pode ver um código de saída definido pelo sistema operacional.

failureInfo

BatchTaskFailureInfo

Informações que descrevem a falha da Tarefa, se houver. Essa propriedade é definida apenas se a Tarefa estiver no estado concluído e tiver encontrado uma falha.

lastRetryTime

string (date-time)

A última vez em que uma retentativa da Tarefa começou a ser executada. Esse elemento está presente apenas se a Tarefa foi retentada (ou seja, o número de tentativas for diferente de zero). Se presente, isso normalmente é igual ao tempo de início, mas pode ser diferente se a tarefa tiver sido reiniciada por motivos diferentes de tentar novamente; por exemplo, se o Compute Node foi reiniciado durante uma retentativa, então o startTime é atualizado, mas o lastRetryTime não.

result

BatchTaskExecutionResult

O resultado da execução da Tarefa. Se o valor for 'failed', então os detalhes da falha podem ser encontrados na propriedade failureInfo.

retryCount

integer (int32)

O número de vezes que a Tarefa foi retentada pelo serviço em lote. Falhas de aplicação de tarefa (código de saída diferente de zero) são tentadas novamente, erros de pré-processamento (a tarefa não pôde ser executada) e erros de upload de arquivos não são tentados novamente. O serviço Batch tentará novamente a Tarefa até o limite especificado pelas restrições.

startTime

string (date-time)

O momento em que o StartTask começou a ser executado. Esse valor é resetado toda vez que a Tarefa é reiniciada ou tentada novamente (ou seja, essa é a última vez em que a Tarefa Inicial começou a ser executada).

state

BatchStartTaskState

O estado do StartTask no Nó de Computação.

BatchStartTaskState

Enums BatchStartTaskState

Valor Description
running

O StartTask está executando atualmente.

completed

O StartTask saiu com o código de saída 0, ou o StartTask falhou e o limite de tentativas foi atingido, ou o processo StartTask não foi executado devido a erros de preparação de tarefas (como falhas no download de arquivos de recursos).

BatchTaskContainerExecutionInfo

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 sobre o contêiner. Esta é a string de erro detalhada do serviço Docker, se disponível. É equivalente ao campo de erro retornado por "docker inspect".

state

string

O estado do recipiente. Esse é o estado do contêiner de acordo com o serviço Docker. É equivalente ao campo de status retornado por "docker inspect".

BatchTaskContainerSettings

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

Nome Tipo Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Os caminhos que você deseja montar na 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 de criação de contêiner. Essas opções adicionais são fornecidas como argumentos para o comando "docker create", além das controladas pelo Serviço de Lote.

imageName

string

A imagem a ser usada para criar o contêiner onde a tarefa será executada. Esta é a referência completa da Imagem, conforme especificado para "docker pull". Se nenhuma tag for fornecida como parte do nome da Imagem, a tag ":latest" é usada como padrão.

registry

ContainerRegistryReference

O registro privado que contém a imagem do contêiner. Essa configuração pode ser omitida se já foi fornecida na criação do Pool.

workingDirectory

ContainerWorkingDirectory

A localização do diretório de trabalho Container Task. O padrão é 'taskWorkingDirectory'.

BatchTaskExecutionInfo

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

Nome Tipo Description
containerInfo

BatchTaskContainerExecutionInfo

Informações sobre o contêiner sob o qual a Tarefa está sendo executada. Essa propriedade é definida apenas se a Tarefa rodar em um contexto de container.

endTime

string (date-time)

O momento em que a Tarefa foi concluída. Essa propriedade é definida apenas se a Tarefa estiver no estado Concluído.

exitCode

integer (int32)

O código de saída do programa especificado na linha de comando Task. Essa propriedade é definida apenas 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 da aplicação para aquele processo. Se você usar o valor do código de saída para tomar decisões no seu código, certifique-se de conhecer a convenção do código de saída usada pelo processo de aplicação. No entanto, se o serviço Batch encerrar a Tarefa (devido ao timeout ou ao término do usuário via API), você pode ver um código de saída definido pelo sistema operacional.

failureInfo

BatchTaskFailureInfo

Informações que descrevem a falha da Tarefa, se houver. Essa propriedade é definida apenas se a Tarefa estiver no estado concluído e tiver encontrado uma falha.

lastRequeueTime

string (date-time)

A última vez em que a Tarefa foi reenfileirada pelo serviço Batch como resultado de uma solicitação de usuário. Essa propriedade é definida apenas se o requeueCount for diferente de zero.

lastRetryTime

string (date-time)

A última vez em que uma retentativa da Tarefa começou a ser executada. Esse elemento está presente apenas se a Tarefa foi retentada (ou seja, o número de tentativas for diferente de zero). Se presente, isso normalmente é igual ao tempo de início, mas pode ser diferente se a tarefa tiver sido reiniciada por motivos diferentes de tentar novamente; por exemplo, se o Compute Node foi reiniciado durante uma retentativa, então o startTime é atualizado, mas o lastRetryTime não.

requeueCount

integer (int32)

O número de vezes que a Tarefa foi reenfileirada pelo serviço Batch como resultado de uma solicitação de usuário. Quando o usuário remove Nós de Computação de um Pool (redimensionando/reduzindo o pool) ou quando o Job está sendo desativado, o usuário pode especificar que as Tarefas em execução nos Nós de Computação sejam reenfileiradas para execução. Essa contagem acompanha quantas vezes a Tarefa foi reenfileirada por esses motivos.

result

BatchTaskExecutionResult

O resultado da execução da Tarefa. Se o valor for 'failed', então os detalhes da falha podem ser encontrados na propriedade failureInfo.

retryCount

integer (int32)

O número de vezes que a Tarefa foi retentada pelo serviço em lote. Falhas de aplicação de tarefa (código de saída diferente de zero) são tentadas novamente, erros de pré-processamento (a tarefa não pôde ser executada) e erros de upload de arquivos não são tentados novamente. O serviço Batch tentará novamente a Tarefa até o limite especificado pelas restrições.

startTime

string (date-time)

O horário em que a Tarefa começou a ser executada. 'Executando' corresponde ao estado em execução, então se a Tarefa especifica arquivos de recursos ou Pacotes, o horário de início reflete o momento em que a Tarefa começou a baixar ou implantar esses arquivos. Se a Tarefa foi reiniciada ou retentada, este é o momento 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ídas.

BatchTaskExecutionResult

Enums BatchTaskExecutionResult

Valor Description
success

A Tarefa foi executada com sucesso.

failure

Houve um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes do processo Tarefa ser lançado, enquanto o processo Tarefa estava em execução ou após o encerramento do processo Tarefa.

BatchTaskFailureInfo

Informações sobre uma falha de tarefa.

Nome Tipo Description
category

BatchErrorSourceCategory

A categoria do erro de tarefa.

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 descrevendo o erro de tarefa, destinada a ser adequada para exibição em uma interface de usuário.

BatchTaskInfo

Informações sobre uma tarefa em execução em um Nó de Computação.

Nome Tipo Description
executionInfo

BatchTaskExecutionInfo

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

jobId

string

O ID do Trabalho ao qual a Tarefa pertence.

subtaskId

integer (int32)

O ID da subtarefa se a Tarefa for uma Tarefa multiinstância.

taskId

string

A identificação da tarefa.

taskState

BatchTaskState

O estado atual da Tarefa.

taskUrl

string (uri)

A URL da tarefa.

BatchTaskState

Enums BatchTaskState

Valor Description
active

A Tarefa está em fila e pode ser executada, mas atualmente não está atribuída a um Nó de Computação. Uma Tarefa entra nesse estado quando é criada, quando é habilitada após ser desativada, ou quando está aguardando uma nova tentativa após uma execução falhada.

preparing

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 obrigatória no Nó de Computação. Se a Tarefa de Preparação de Tarefas for bem-sucedida, a Tarefa passará para a execução. Se a Tarefa de Preparação de Trabalho falhar, a Tarefa voltará à ativa e será elegível para ser designada a um Nó de Computação diferente.

running

A tarefa está rodando em um Nó de Computação. Isso inclui preparação em nível de tarefa, como baixar arquivos de recursos ou implantar Pacotes especificados na Tarefa – não significa necessariamente que a linha de comando da Tarefa tenha começado a ser executada.

completed

A Tarefa não é mais elegível para ser executada, geralmente porque a Tarefa foi concluída com sucesso, ou porque a Tarefa foi concluída sem sucesso e esgotou seu limite de tentativas de reabilitação. Uma Tarefa também é marcada como concluída se ocorreu um erro ao iniciar a Tarefa, ou quando a Tarefa foi encerrada.

BatchVmImageReference

Uma referência a uma imagem do Marketplace de Máquinas Virtuais do Azure ou a uma Imagem da Galeria de Computação do Azure. Para obter a lista de todas as referências de imagem do Azure Marketplace verificadas pelo Lote do Azure, consulte a operação ' Listar Imagens Com Suporte'.

Nome Tipo Description
communityGalleryImageId

string

A imagem da galeria comunitária identificador único. Essa propriedade é mutuamente exclusiva com outras propriedades e pode ser buscada na chamada GET da imagem da galeria da comunidade.

exactVersion

string

A versão específica da imagem da plataforma ou da imagem do marketplace usada para criar o nó. Esse campo somente leitura difere de 'versão' apenas se o valor especificado para 'versão' quando o pool foi criado fosse 'mais recente'.

offer

string

O tipo de oferta da Imagem do Marketplace de Máquinas Virtuais Azure. Por exemplo, UbuntuServer ou WindowsServer.

publisher

string

A editora da Azure Virtual Machines Marketplace Image. Por exemplo, Canonical ou MicrosoftWindowsServer.

sharedGalleryImageId

string

Identificador único da imagem da galeria compartilhada. Essa propriedade é mutuamente exclusiva com outras propriedades e pode ser buscada na chamada GET da imagem da galeria compartilhada.

sku

string

O SKU da Imagem do Azure Virtual Machines Marketplace. Por exemplo, 18.04-LTS ou 2019-Datacenter.

version

string

A versão da Imagem do Marketplace de Máquinas Virtuais do Azure. Um valor de 'mais recente' pode ser especificado para selecionar a versão mais recente de uma Imagem. Se omitido, o padrão será 'latest'.

virtualMachineImageId

string (arm-id)

O identificador de recurso do ARM da Imagem da Galeria de Computação do Azure. Os Nós de Computação no Pool serão criados usando este ID de Imagem. Isso é da forma /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para sempre usar a versão mais recente da imagem. Essa propriedade é mutuamente exclusiva com outras propriedades do ImageReference. A Imagem da Galeria de Computação do Azure deve ter réplicas na mesma região e estar na mesma assinatura da conta Batch do Azure. Se a versão da imagem não for especificada no imageId, a versão mais recente será usada. Para informações sobre as configurações do firewall para o agente do Nó de Computação Batch para se comunicar com o serviço Batch, veja https://v4.hkg1.meaqua.org/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ContainerHostBatchBindMountEntry

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

Nome Tipo Description
isReadOnly

boolean

Monte esse caminho de origem como modo somente leitura ou não. O valor padrão é falso (modo de leitura/gravação). Para o 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, isso 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 modificar o caminho.

source

ContainerHostDataPath

O caminho que será montado no cliente do contêiner pode ser selecionado.

ContainerHostDataPath

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

Valor Description
Shared

O caminho para a tarefa de várias instâncias compartilhar seus arquivos.

Startup

O caminho para iniciar a tarefa.

VfsMounts

O caminho contém todos os sistemas de arquivos virtuais montados neste nó.

Task

O caminho da tarefa.

JobPrep

O caminho da tarefa de preparação do trabalho.

Applications

O caminho dos aplicativos.

ContainerRegistryReference

Um registro de contêiner privado.

Nome Tipo Description
identityReference

BatchNodeIdentityReference

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.

password

string (password)

A senha para fazer logon no servidor do Registro.

registryServer

string (uri)

A URL do registro. Se omitido, o padrão será "docker.io".

username

string

O nome de usuário a ser conectado ao servidor do Registro.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

Valor Description
taskWorkingDirectory

Use o diretório padrão de trabalho de Tarefas do serviço Batch, que conterá os Arquivos de Recursos de Tarefas preenchidos por Batch.

containerImageDefault

Use o diretório de trabalho definido na imagem do contêiner. Atenção, este diretório não conterá os Arquivos de Recursos baixados pelo Batch.

ElevationLevel

Enums de Elevação

Valor Description
nonadmin

O usuário é um usuário padrão sem acesso elevado.

admin

O usuário é um usuário com acesso elevado e opera com permissões de Administrador completas.

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.

InboundEndpoint

Um ponto de extremidade de entrada em um Nó de Computação.

Nome Tipo Description
backendPort

integer (int32)

O número da porta do backend do endpoint.

frontendPort

integer (int32)

O número da porta pública do endpoint.

name

string

O nome do ponto de extremidade.

protocol

InboundEndpointProtocol

O protocolo do ponto de extremidade.

publicFQDN

string

O domínio público totalmente qualificado para o Compute Node.

publicIPAddress

string

O endereço IP público do Nó de Computação.

InboundEndpointProtocol

InboundEndpointProtocol enums

Valor Description
tcp

Use TCP para o ponto de extremidade.

udp

Use UDP para o ponto de extremidade.

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.

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 container de armazenamento está 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 apenas a arquivos sendo baixados para os Nós de Computação do Linux. Ele será ignorado se for especificado para um ResourceFile que será baixado em um Nó de Computação do Windows. Se essa propriedade não for especificada para um Nó de Computação Linux, então um valor padrão de 0770 é aplicado ao arquivo.

filePath

string

A localização no Nó de Computação para onde baixar o(s) arquivo(s), relativa 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 o filePath é usado como um diretório, qualquer estrutura de diretório já associada aos dados de entrada será retida 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 (uri)

A URL do arquivo a ser baixado. 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 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 acesso público.

identityReference

BatchNodeIdentityReference

A referência à identidade atribuída pelo usuário para usar para acessar o Azure Blob Storage especificada por storageContainerUrl ou httpUrl.

storageContainerUrl

string (uri)

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.

SchedulingState

ProgramamentoEstátuos enums

Valor Description
enabled

As tarefas podem ser agendadas no Nó de Computação.

disabled

Nenhuma nova Tarefa será agendada no Nó de Computação. Tarefas já executadas no Nó de Computação ainda podem ser executadas até a conclusão. Todos os Nós de Computação começam com o escalonamento ativado.

UserIdentity

A definição da identidade do usuário na qual a Tarefa é executada. Especifique a propriedade userName ou autoUser, mas não ambas.

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.

VirtualMachineInfo

Informações sobre o estado atual da máquina virtual.

Nome Tipo Description
imageReference

BatchVmImageReference

A referência à Imagem do Marketplace da Azure Virtual Machine.

scaleSetVmResourceId

string

O ID de recurso da VM atual do Conjunto de Escala da Máquina Virtual do Nó de Computação. Definido apenas se a Conta Batch foi criada com sua propriedade poolAllocationMode definida como 'UserSubscription'.